cli: Support arrays in parameters

[babeltrace.git] / doc / man / common-cmd-params-format.txt

diff --git a/doc/man/common-cmd-params-format.txt b/doc/man/common-cmd-params-format.txt
index c3ee8d4fe7e0846bedcbc1384752655035eb1985..efceab479f4c4353b6fa13ecec39101ae7a210d5 100644 (file)
--- a/doc/man/common-cmd-params-format.txt
+++ b/doc/man/common-cmd-params-format.txt
@@ -31,6 +31,9 @@ list of `NAME=VALUE` assignments:
 
 * Double-quoted string (accepts escape characters).
 
+* Array, formatted as an opening `[`, a list of comma-separated values
+  (as described by the current list) and a closing `]`.
+
 You may put whitespaces around the individual `=` (assignment) and `,`
 (separator) characters.
 --
@@ -41,7 +44,8 @@ Example:
 babeltrace ... --params='many=null, fresh=yes, condition=false,
                          squirrel=-782329, observe=3.14,
                          simple=beef, needs-quotes="some string",
-                         escape.chars-are:allowed="a \" quote"'
+                         escape.chars-are:allowed="a \" quote",
+                         things=[1, "2", 3]'
 ----
 
 IMPORTANT: Like in the example above, make sure to single-quote the