Skip to content

Commit 14eaa77

Browse files
committed
command-line-interface: Add cross-references to bundle/runtime/glossary
Now that this document is in runtime-spec we can be more liberal with the linking. Signed-off-by: W. Trevor King <[email protected]>
1 parent 3d35bdf commit 14eaa77

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

command-line-interface.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Operations
22

3-
A conformant runtime MUST provide an executable (called `funC` in the following examples).
3+
A conformant [runtime][] MUST provide an executable (called `funC` in the following examples).
44
That executable MUST support commands with the following template:
55

66
```sh
@@ -47,12 +47,12 @@ $ echo $?
4747

4848
### start
4949

50-
Start a container from a bundle directory.
50+
[Start][start] a container from a [bundle directory][bundle].
5151

5252
* *Options*
5353
* *`--id <ID>`* Set the container ID when creating a container.
5454
If not set, the runtime is free to pick any ID that is not already in use.
55-
* *`--bundle <PATH>`* Override the path to the bundle directory (defaults to the current working directory).
55+
* *`--bundle <PATH>`* Override the path to the [bundle directory][bundle] (defaults to the current working directory).
5656
* *Standard streams:* The runtime MUST attach its standard streams directly to the application process without inspection.
5757
* *Environment variables*
5858
* *`LISTEN_FDS`:* The number of file descriptors passed.
@@ -72,13 +72,13 @@ $ echo $?
7272

7373
### state
7474

75-
Request the container state.
75+
[Request][state-request] the container [state][state].
7676

7777
* *Arguments*
7878
* *`<ID>`* The container whose state is being requested.
7979
* *Standard streams:*
8080
* *stdin:* The runtime MUST NOT attempt to read from its stdin.
81-
* *stdout:* The runtime MUST print the state JSON to its stdout.
81+
* *stdout:* The runtime MUST print the [state JSON][state] to its stdout.
8282
* *stderr:* The runtime MAY print diagnostic messages to stderr, and the format for those lines is not specified in this document.
8383
* *Exit code:* Zero if the state was successfully written to stdout and non-zero on errors.
8484

@@ -102,8 +102,13 @@ $ echo $?
102102
0
103103
```
104104

105+
[bundle]: bundle.md
105106
[posix-encoding]: http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap06.html#tag_06_02
106107
[posix-lang]: http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap08.html#tag_08_02
107108
[posix-locale-encoding]: http://www.unicode.org/reports/tr35/#Bundle_vs_Item_Lookup
109+
[runtime]: glossary.md#runtime
110+
[start]: runtime.md#start
111+
[state]: runtime.md#state
112+
[state-request]: runtime.md#query-state
108113
[systemd-listen-fds]: http://www.freedesktop.org/software/systemd/man/sd_listen_fds.html
109114
[UTF-8]: http://www.unicode.org/versions/Unicode8.0.0/ch03.pdf

0 commit comments

Comments
 (0)