Skip to content

Commit

Permalink
*: Use inline links for remaining internal references
Browse files Browse the repository at this point in the history
Since f9dc90b (make link usage consistent across the specification,
2017-02-09, opencontainers#687), the official style is to only use reference-style
links for external links.  I expect the remaining three entries just
slipped through.  This commit adjusts everything found with:

  $ git grep ']: [a-z]' | grep -v http

It also fixes the underscore -> hyphen in the
glossary.md#container-namespace target and updates the capabilities
location to catch up with 5a8a779 (Move process specific settings to
process, 2016-03-02, opencontainers#329).

Signed-off-by: W. Trevor King <wking@tremily.us>
  • Loading branch information
wking committed May 10, 2017
1 parent f56fe8b commit 65cb135
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
6 changes: 2 additions & 4 deletions config-linux.md
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
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).
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

0 comments on commit 65cb135

Please sign in to comment.