Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

*: Use inline links for remaining internal references #799

Merged
merged 1 commit into from
May 10, 2017
Merged

*: Use inline links for remaining internal references #799

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions config-linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -614,7 +614,7 @@ The [Shared Subtrees][sharedsubtree] article in the kernel documentation has mor
## <a name="configLinuxMaskedPaths" />Masked Paths

**`maskedPaths`** (array of strings, OPTIONAL) will mask over the provided paths inside the container so that they cannot be read.
The values MUST be absolute paths in the [container namespace][container-namespace2].
The values MUST be absolute paths in the [container namespace](glossary.md#container_namespace).

###### Example

Expand All @@ -627,7 +627,7 @@ The values MUST be absolute paths in the [container namespace][container-namespa
## <a name="configLinuxReadonlyPaths" />Readonly Paths

**`readonlyPaths`** (array of strings, OPTIONAL) will set the provided paths as readonly inside the container.
The values MUST be absolute paths in the [container namespace][container-namespace2].
The values MUST be absolute paths in the [container namespace](glossary.md#container-namespace).

###### Example

Expand All @@ -648,8 +648,6 @@ The values MUST be absolute paths in the [container namespace][container-namespa
```


[container-namespace2]: glossary.md#container_namespace

[cgroup-v1]: https://www.kernel.org/doc/Documentation/cgroup-v1/cgroups.txt
[cgroup-v1-blkio]: https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt
[cgroup-v1-cpusets]: https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt
Expand Down
6 changes: 2 additions & 4 deletions style.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ For example, this paragraph will span three lines in the Markdown source.

## <a name="styleHex" />Traditionally hex settings should use JSON integers, not JSON strings

For example, [`"classID": 1048577`][class-id] instead of `"classID": "0x100001"`.
For example, [`"classID": 1048577`](config-linux.md#network) instead of `"classID": "0x100001"`.
The config JSON isn't enough of a UI to be worth jumping through string <-> integer hoops to support an 0x… form ([source][integer-over-hex]).

## <a name="styleConstantNames" />Constant names should keep redundant prefixes

For example, `CAP_KILL` instead of `KILL` in [**`linux.capabilities`**][capabilities].
For example, `CAP_KILL` instead of `KILL` in [**`process.capabilities`**](config.md#process).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be config.md#configProcess?

(## <a name="configProcess" />Process is the section header of config.md which mentions capabilities)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be config.md#configProcess?

That would work too. I'm currently using the auto-generated fragments to match @mrunalp's preference. I don't care either way, although I'd prefer the spec consistently use whichever way maintainers want.

The redundancy reduction from removing the namespacing prefix is not useful enough to be worth trimming the upstream identifier ([source][keep-prefix]).

## <a name="styleOptionalSettings" />Optional settings should not have pointer Go types
Expand Down Expand Up @@ -120,8 +120,6 @@ The URL for the Open Containers link above is: https://github.com/opencontainers
```


[capabilities]: config-linux.md#capabilities
[class-id]: config-linux.md#network
[integer-over-hex]: https://github.com/opencontainers/runtime-spec/pull/267#r48360013
[keep-prefix]: https://github.com/opencontainers/runtime-spec/pull/159#issuecomment-138728337
[no-pointer-for-boolean]: https://github.com/opencontainers/runtime-spec/pull/290#r50296396
Expand Down