From c49694742f9fd04bf3a8ced046cf15b3e1f04c49 Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Mon, 10 Aug 2015 12:00:36 -0700 Subject: [PATCH] runtime: Deduplicate phrasing in state attribute definitions Replace: $ENTRY ($TYPE) $ENTRY is the ... with: $ENTRY ($TYPE) is the ... It's more concise and avoids the need to argue over Pid vs PID ;). And "reads like a sentence" is an easy style to check and remember [1]. [1]: https://github.com/opencontainers/specs/pull/145#issuecomment-138971339 Signed-off-by: W. Trevor King --- runtime.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/runtime.md b/runtime.md index 37f0a3c45..6abdb26dc 100644 --- a/runtime.md +++ b/runtime.md @@ -9,10 +9,10 @@ On Linux based systems the state information should be stored in `/run/openconta The directory structure for a container is `/run/opencontainer/containers//state.json`. By providing a default location that container state is stored external applications can find all containers running on a system. -* **version** (string) Version of the OCI specification used when creating the container. -* **id** (string) ID is the container's ID. -* **pid** (int) Pid is the ID of the main process within the container. -* **root** (string) Root is the path to the container's bundle directory. +* **version** (string) is the OCI specification version used when creating the container. +* **id** (string) is the container's ID. +* **pid** (int) is the ID of the main process within the container. +* **root** (string) is the path to the container's bundle directory. The ID is provided in the state because hooks will be executed with the state as the payload. This allows the hook to perform clean and teardown logic after the runtime destroys its own state.