Skip to content

Commit 65cb135

Browse files
committed
*: Use inline links for remaining internal references
Since f9dc90b (make link usage consistent across the specification, 2017-02-09, #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, #329). Signed-off-by: W. Trevor King <[email protected]>
1 parent f56fe8b commit 65cb135

File tree

2 files changed

+4
-8
lines changed

2 files changed

+4
-8
lines changed

config-linux.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -614,7 +614,7 @@ The [Shared Subtrees][sharedsubtree] article in the kernel documentation has mor
614614
## <a name="configLinuxMaskedPaths" />Masked Paths
615615

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

619619
###### Example
620620

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

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

632632
###### Example
633633

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

650650

651-
[container-namespace2]: glossary.md#container_namespace
652-
653651
[cgroup-v1]: https://www.kernel.org/doc/Documentation/cgroup-v1/cgroups.txt
654652
[cgroup-v1-blkio]: https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt
655653
[cgroup-v1-cpusets]: https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.txt

style.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ For example, this paragraph will span three lines in the Markdown source.
88

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

11-
For example, [`"classID": 1048577`][class-id] instead of `"classID": "0x100001"`.
11+
For example, [`"classID": 1048577`](config-linux.md#network) instead of `"classID": "0x100001"`.
1212
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]).
1313

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

16-
For example, `CAP_KILL` instead of `KILL` in [**`linux.capabilities`**][capabilities].
16+
For example, `CAP_KILL` instead of `KILL` in [**`process.capabilities`**](config.md#process).
1717
The redundancy reduction from removing the namespacing prefix is not useful enough to be worth trimming the upstream identifier ([source][keep-prefix]).
1818

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

122122

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

0 commit comments

Comments
 (0)