Skip to content

Commit

Permalink
command-line-interface: Four-space intents for nested lists
Browse files Browse the repository at this point in the history 
Catch up with 7795661 (runtime.md: Fix sub-bullet indentation,
2016-06-08, opencontainers#495).  From [1]:

  List items may consist of multiple paragraphs.  Each subsequent
  paragraph in a list item must be indented by either 4 spaces or one
  tab...

I expect that's intended to be read with "block element" instead of
"paragraph", in which case it applies to nested lists too.

And while GitHub supports two-space indents [2]:

  You can create nested lists by indenting lines by two spaces.

it seems that pandoc does not.

[1]: http://daringfireball.net/projects/markdown/syntax#list
[2]: https://help.github.com/articles/basic-writing-and-formatting-syntax/#lists

Signed-off-by: W. Trevor King <[email protected]>
  • Loading branch information
@wking
wking committed Jul 7, 2016
1 parent 2424618 commit a21b162
Showing 1 changed file with 24 additions and 24 deletions.
48 changes: 24 additions & 24 deletions command-line-interface.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ Print the runtime version and exit.

* *Options* None are required, but the runtime MAY support options.
* *Standard streams*
* *stdin:* The runtime MUST NOT attempt to read from its stdin.
* *stdout:* The runtime MUST print its name, a space, and its version as the first line to its stdout.
The name MAY contain any Unicode characters, but MUST NOT contain control codes or newlines.
The runtime MAY print additional lines to its stdout, and the format for those lines is not specified in this document.
* *stderr:* The runtime MAY print diagnostic messages to stderr, and the format for those lines is not specified in this document.
* *stdin:* The runtime MUST NOT attempt to read from its stdin.
* *stdout:* The runtime MUST print its name, a space, and its version as the first line to its stdout.
The name MAY contain any Unicode characters, but MUST NOT contain control codes or newlines.
The runtime MAY print additional lines to its stdout, and the format for those lines is not specified in this document.
* *stderr:* The runtime MAY print diagnostic messages to stderr, and the format for those lines is not specified in this document.
* *Exit code:* The runtime MUST exit with zero.

#### Example
Expand All @@ -50,13 +50,13 @@ $ echo $?
[Start][start] a container from a [bundle directory][bundle].

* *Options*
* *`--id <ID>`* Set the container ID when creating a container.
If not set, the runtime is free to pick any ID that is not already in use.
* *`--bundle <PATH>`* Override the path to the [bundle directory][bundle] (defaults to the current working directory).
* *`--id <ID>`* Set the container ID when creating a container.
If not set, the runtime is free to pick any ID that is not already in use.
* *`--bundle <PATH>`* Override the path to the [bundle directory][bundle] (defaults to the current working directory).
* *Standard streams:* The runtime MUST attach its standard streams directly to the container process without inspection.
* *Environment variables*
* *`LISTEN_FDS`:* The number of file descriptors passed.
For example, `LISTEN_FDS=2` would mean that the runtime MUST pass file descriptors 3 and 4 to the container process (in addition to the standard streams) to support [socket activation][systemd-listen-fds].
* *`LISTEN_FDS`:* The number of file descriptors passed.
For example, `LISTEN_FDS=2` would mean that the runtime MUST pass file descriptors 3 and 4 to the container process (in addition to the standard streams) to support [socket activation][systemd-listen-fds].
* *Exit code:* The runtime MUST exit with the container process's exit code.

#### Example
Expand All @@ -75,11 +75,11 @@ $ echo $?
[Request][state-request] the container [state][state].

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

#### Example
Expand Down Expand Up @@ -107,18 +107,18 @@ $ echo $?
[Send a signal][kill] to the container process.

* *Arguments*
* *`<ID>`* The container being signaled.
* *`<ID>`* The container being signaled.
* *Options*
* *`--signal <SIGNAL>`* The signal to send (defaults to `TERM`).
The runtime MUST support `TERM` and `KILL` signals with [the POSIX semantics][posix-signals].
The runtime MAY support additional signal names.
On platforms that support [POSIX signals][posix-signals], the runtime MUST implement this command using POSIX signals.
On platforms that do not support POSIX signals, the runtime MAY implement this command with alternative technology as long as `TERM` and `KILL` retain their POSIX semantics.
Runtime authors on non-POSIX platforms SHOULD submit documentation for their TERM implementation to this specificiation, so runtime callers can configure the container process to gracefully handle the signals.
* *`--signal <SIGNAL>`* The signal to send (defaults to `TERM`).
The runtime MUST support `TERM` and `KILL` signals with [the POSIX semantics][posix-signals].
The runtime MAY support additional signal names.
On platforms that support [POSIX signals][posix-signals], the runtime MUST implement this command using POSIX signals.
On platforms that do not support POSIX signals, the runtime MAY implement this command with alternative technology as long as `TERM` and `KILL` retain their POSIX semantics.
Runtime authors on non-POSIX platforms SHOULD submit documentation for their TERM implementation to this specificiation, so runtime callers can configure the container process to gracefully handle the signals.
* *Standard streams:*
* *stdin:* The runtime MUST NOT attempt to read from its stdin.
* *stdout:* The runtime MAY print diagnostic messaged to stdout, and the format for those lines is not specified in this document.
* *stderr:* The runtime MAY print diagnostic messages to stderr, and the format for those lines is not specified in this document.
* *stdin:* The runtime MUST NOT attempt to read from its stdin.
* *stdout:* The runtime MAY print diagnostic messaged to stdout, and the format for those lines is not specified in this document.
* *stderr:* The runtime MAY print diagnostic messages to stderr, and the format for those lines is not specified in this document.
* *Exit code:* Zero if the signal was successfully sent to the container process and non-zero on errors.
Successfully sent does not mean that the signal was successfully received or handled by the container process.

Expand Down

0 comments on commit a21b162

Please sign in to comment.