]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
mon/MonCommands: add -- seperator to example
authorSage Weil <sage@newdream.net>
Tue, 1 Jun 2021 18:43:47 +0000 (14:43 -0400)
committerSage Weil <sage@newdream.net>
Fri, 4 Jun 2021 20:56:17 +0000 (16:56 -0400)
Signed-off-by: Sage Weil <sage@newdream.net>
src/mon/MonCommands.h

index 2ca0d0e8f1c405c4d35444f4214b18aa1ab4178c..df03ca4a8a8a1d73fd4a9286bfbb05b4c4514c3c 100644 (file)
@@ -77,7 +77,9 @@
  *
  * COMMAND("auth add "
  *        "name=entity,type=CephString "
- *        "name=caps,type=CephString,n=N,req=false",
+ *        "name=caps,type=CephString,n=N,req=false "
+ *         "-- "
+ *         "name=some_option,type=CephString,req=false",
  *        "add auth info for <name> from input file, or random key "
  *        "if no input given, and/or any caps specified in the command")
  *
  * enters auth add client.admin 'mon rwx' 'osd *'.  The result will be a
  * JSON object like {"prefix":"auth add", "entity":"client.admin",
  * "caps":["mon rwx", "osd *"]}.
+ *
+ * The -- separates positional from non-positional (and, by implication,
+ * optional) arguments.  Note that CephBool is assumed to be non-positional
+ * and will also implicitly mark that any following arguments are
+ * non-positional.
+ *
  * Note that
  *     - string literals are accumulated into 'prefix'
  *     - n=1 descriptors are given normal string or int object values