[2/2] cg: Add documentation about props

Submitted by Cyrill Gorcunov on April 27, 2016, 7:17 p.m.

Details

Message ID 1461784669-18635-3-git-send-email-gorcunov@openvz.org
State Rejected
Series "Custom cgroup props, v5"
Headers show

Commit Message

Cyrill Gorcunov April 27, 2016, 7:17 p.m.
Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
---
 Documentation/criu.txt | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

Patch hide | download patch | download mbox

diff --git a/Documentation/criu.txt b/Documentation/criu.txt
index 1982f5d9a327..b67911354c0c 100644
--- a/Documentation/criu.txt
+++ b/Documentation/criu.txt
@@ -151,6 +151,40 @@  In other words, do not use it until really needed.
     Without this argument *criu* will not save cgroups configuration
     associated with a task.
 
+*--cgroup-props* '<spec>'::
+    Specify controllers and their properties to be carried into the
+    image file. *criu* predefines specifications for common controllers
+    but since the kernel can add new controllers and modify their
+    properties there should be a way to specify ones matched the kernel.
++
+'<spec>' describes the controller and properties specification in
+simplified YAML form:
++
+----------
+"c1": ["a", "b"]
+"c2": ["c", "d"]
+----------
++
+Where 'c1' and 'c2' are controllers names, and 'a', 'b', 'c', 'd' are
+their properties.
++
+Note there should not be leading whitespaces. New line and double quotes
+are required as well. Thus for command line argument the example above
+will look like:
++
+----------
+--cgroup-props "\"c1\": [\"a\", \"b\"]\n\"c2\":[\"c\", "d\"]"
+----------
+
+*--cgroup-props-file* '<path>'::
+    Same as *--cgroup-props* except the specification is read from
+    a file pointed by '<path>'.
+
+*--cgroup-props-ignore-default*::
+    When combined with *--cgroup-props* makes *criu* to substitute
+    predefined controller property with new one shipped. Otherwise
+    predefined properies are merged with provided.
+
 *--tcp-established*::
     Checkpoint established TCP connections.