runtime-linux: Transition from Markdown to AsciiDoc

The new bits for this file are the table [1] and the leveloffset [2].
Keeping runtime-linux under runtime makes the ToC tree more
consistent (all the runtime stuff is under section 5).

[1]: http://asciidoc.org/userguide.html#_tables
     23. Tables
[2]: http://asciidoc.org/userguide.html#X90
     36.5. Combining separate documents

Author: wking

protocols.asc

@@ -3,6 +3,6 @@ Protocols
 
 Protocols defined by this specification are:
 
-* Linux containers: <<runtime>>, `<<runtime-linux>>`, `<<config>>`, and `<<config-linux>>`.
+* Linux containers: <<runtime>>, <<runtime-linux>>, `<<config>>`, and `<<config-linux>>`.
 * Solaris containers: <<runtime>>, `<<config>>`, and `<<config-solaris>>`.
 * Windows containers: <<runtime>>, `<<config>>`, and `<<config-windows>>`.

runtime-linux.asc

@@ -0,0 +1,27 @@
+[[runtime-linux]]
+Linux Runtime
+-------------
+
+:socket-activation: http://0pointer.de/blog/projects/socket-activated-containers.html
+
+File descriptors
+~~~~~~~~~~~~~~~~
+
+By default, only the `stdin`, `stdout` and `stderr` file descriptors are kept open for the application by the runtime.
+The runtime MAY pass additional file descriptors to the application to support features such as {socket-activation}[socket activation].
+Some of the file descriptors MAY be redirected to `/dev/null` even though they are open.
+
+Dev symbolic links
+~~~~~~~~~~~~~~~~~~
+
+After the container has `/proc` mounted, the following standard symlinks MUST be setup within `/dev/` for the IO.
+
+.Required symbolic links
+[cols="m,m",frame="topbot",options="header"]
+|==============================
+|    Source       | Destination
+| /proc/self/fd   | /dev/fd
+| /proc/self/fd/0 | /dev/stdin
+| /proc/self/fd/1 | /dev/stdout
+| /proc/self/fd/2 | /dev/stderr
+|==============================

runtime-linux.md

@@ -2,17 +2,20 @@
 Runtime and Lifecycle
 ---------------------
 
+Platform-independent runtime behavior
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 :implementation-testing: https://github.com/opencontainers/runtime-spec/blob/master/implementations.md#testing--tools
 
 Scope of a Container
-~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^
 
 Barring access control concerns, the entity using a runtime to create a container MUST be able to use the operations defined in this specification against that same container.
 Whether other entities using the same, or other, instance of the runtime can see that container is out of scope of this specification.
 
 [[state]]
 State
-^^^^^
++++++
 
 The state of a container MUST include, at least, the following properties:
 
@@ -70,7 +73,7 @@ When serialized in JSON, the format MUST adhere to the following pattern:
 See <<state-operation>> for information on retrieving the state of a container.
 
 Lifecycle
-~~~~~~~~~
+^^^^^^^^^
 
 The lifecycle describes the timeline of events that happen from when a container is created to when it ceases to exist.
 
@@ -101,13 +104,13 @@ The lifecycle describes the timeline of events that happen from when a container
   The container MUST be destroyed by undoing the steps performed during create phase (<<lifecycle-create>>).
 
 Errors
-~~~~~~
+^^^^^^
 
 In cases where the specified operation generates an error, this specification does not mandate how, or even if, that error is returned or exposed to the user of an implementation.
 Unless otherwise stated, generating an error MUST leave the state of the environment as if the operation were never attempted - modulo any possible trivial ancillary changes such as logging.
 
 Operations
-~~~~~~~~~~
+^^^^^^^^^^
 
 OCI compliant runtimes MUST support the following operations, unless the operation is not supported by the base operating system.
 
@@ -117,7 +120,7 @@ These operations are not specifying any command line APIs, and the parameters ar
 [[state-operation]]
 [caption="foo bar"]
 State
-^^^^^
++++++
 
 `state <container-id>`
 
@@ -127,7 +130,7 @@ This operation MUST return the state of a container as specified in <<state>>.
 
 [[create,create]]
 Create
-^^^^^^
+++++++
 
 `create <container-id> <path-to-bundle>`
 
@@ -146,7 +149,7 @@ Any changes made to the `<<config>>` after this operation will not have an effec
 
 [[start,start]]
 Start
-^^^^^
++++++
 
 `start <container-id>`
 
@@ -159,7 +162,7 @@ Upon successful completion of this operation the <<status>> property of this con
 
 [[kill,kill]]
 Kill
-^^^^
+++++
 
 `kill <container-id> <signal>`
 
@@ -171,7 +174,7 @@ When the process in the container is stopped, irrespective of it being as a resu
 
 [[delete,delete]]
 Delete
-^^^^^^
+++++++
 
 `delete <container-id>`
 
@@ -184,7 +187,13 @@ Once a container is deleted its ID MAY be used by a subsequent container.
 
 [[runtime-hooks]]
 Hooks
-^^^^^
++++++
 
 Many of the operations specified in this specification have "hooks" that allow for additional actions to be taken before or after each operation.
 See `<<hooks>>` for more information.
+
+:leveloffset: 1
+
+include::runtime-linux.asc[]
+
+:leveloffset: 0