Skip to content

Commit d527365

Browse files
committed
command-line-interface: Drop the 'version' command
This was added in ffa124c (Add a 'version' command, 2015-09-14) to make it easy for callers to report which runtime they were using. But we don't have a use-case that makes it strictly necessary for interop, so we're leaving it out for now [1]. [1]: http://ircbot.wl.linuxfoundation.org/meetings/opencontainers/2016/opencontainers.2016-07-20-21.03.log.html#l-75 Signed-off-by: W. Trevor King <[email protected]>
1 parent 7152193 commit d527365

File tree

1 file changed

+4
-27
lines changed

1 file changed

+4
-27
lines changed

command-line-interface.md

Lines changed: 4 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -18,33 +18,10 @@ If the runtime is invoked with an unrecognized command, it MUST exit with a nonz
1818
## Character encodings
1919

2020
This API specification does not cover character encodings, but runtimes SHOULD conform to their native operating system.
21-
For example, POSIX systems define [`LANG` and related environment variables][posix-lang] for [declaring][posix-locale-encoding] [locale-specific character encodings][posix-encoding], so a runtime in an `en_US.UTF-8` locale SHOULD write its [version](#version) to stdout in [UTF-8][].
21+
For example, POSIX systems define [`LANG` and related environment variables][posix-lang] for [declaring][posix-locale-encoding] [locale-specific character encodings][posix-encoding], so a runtime in an `en_US.UTF-8` locale SHOULD write its [state](#state) to stdout in [UTF-8][].
2222

2323
## Commands
2424

25-
### version
26-
27-
Print the runtime version and exit.
28-
29-
* *Options* None are required, but the runtime MAY support options.
30-
* *Standard streams*
31-
* *stdin:* The runtime MUST NOT attempt to read from its stdin.
32-
* *stdout:* The runtime MUST print its name, a space, and its version as the first line to its stdout.
33-
The name MAY contain any Unicode characters, but MUST NOT contain control codes or newlines.
34-
The runtime MAY print additional lines to its stdout, and the format for those lines is not specified in this document.
35-
* *stderr:* The runtime MAY print diagnostic messages to stderr, and the format for those lines is not specified in this document.
36-
* *Exit code:* The runtime MUST exit with zero.
37-
38-
#### Example
39-
40-
```
41-
$ funC version
42-
funC 1.0.0
43-
Built for x86_64-pc-linux-gnu
44-
$ echo $?
45-
0
46-
```
47-
4825
### create
4926

5027
[Create][create] a container from a [bundle directory][bundle].
@@ -89,7 +66,7 @@ If you call `start` from a shell using a separate terminal, the container output
8966

9067
#### Container process exit
9168

92-
The [example's](#example-1) `block-on-exit-and-collect-exit-code` is platform-specific magic that is not specified in this document.
69+
The [example's](#example) `block-on-exit-and-collect-exit-code` is platform-specific magic that is not specified in this document.
9370
On Linux, it might involve an ancestor process which had set [`PR_SET_CHILD_SUBREAPER`][prctl.2] and collected the container PID [from the state][state], or a process that was [ptracing][ptrace.2] the container process for [`exit_group`][exit_group.2], although both of those race against the container process exiting before the watcher is monitoring.
9471

9572
### start
@@ -105,7 +82,7 @@ This command SHOULD exit as quickly as possible after triggering the execution,
10582
* *stderr:* The runtime MAY print diagnostic messages to stderr, and the format for those lines is not specified in this document.
10683
* *Exit code:* Zero if the container was successfully started and non-zero on errors.
10784

108-
See [create](#example-1) for an example.
85+
See [create](#example) for an example.
10986

11087
### state
11188

@@ -184,7 +161,7 @@ $ echo $?
184161
* *stderr:* The runtime MAY print diagnostic messages to stderr, and the format for those lines is not specified in this document.
185162
* *Exit code:* Zero if the container was successfully deleted and non-zero on errors.
186163

187-
See [create](#example-1) for an example.
164+
See [create](#example) for an example.
188165

189166
[bundle]: bundle.md
190167
[create]: runtime.md#create

0 commit comments

Comments
 (0)