diff options
| author | Quentin Young <qlyoung@users.noreply.github.com> | 2021-09-09 12:22:53 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-09 12:22:53 -0400 |
| commit | 32acb4a7adc4e7fcd72b36a124e8ec3929d79e10 (patch) | |
| tree | 59036d4eb3c66e713097fac4308da117011c37d4 /doc/developer/cli.rst | |
| parent | f334c88ed9675eab624728ecd6eaaff3a9b41255 (diff) | |
| parent | 3be280bb8c48de8bb71ad8b193a83a0b4eec4b62 (diff) | |
Merge pull request #9497 from opensourcerouting/cli-better-no
Diffstat (limited to 'doc/developer/cli.rst')
| -rw-r--r-- | doc/developer/cli.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/developer/cli.rst b/doc/developer/cli.rst index edabe61d92..a24a4ecb7e 100644 --- a/doc/developer/cli.rst +++ b/doc/developer/cli.rst @@ -139,6 +139,7 @@ by the parser. selector: "<" `selector_seq_seq` ">" `varname_token` : "{" `selector_seq_seq` "}" `varname_token` : "[" `selector_seq_seq` "]" `varname_token` + : "![" `selector_seq_seq` "]" `varname_token` selector_seq_seq: `selector_seq_seq` "|" `selector_token_seq` : `selector_token_seq` selector_token_seq: `selector_token_seq` `selector_token` @@ -218,6 +219,10 @@ one-or-more selection and repetition. provide mutual exclusion. User input matches at most one option. - ``[square brackets]`` -- Contains sequences of tokens that can be omitted. ``[<a|b>]`` can be shortened to ``[a|b]``. +- ``![exclamation square brackets]`` -- same as ``[square brackets]``, but + only allow skipping the contents if the command input starts with ``no``. + (For cases where the positive command needs a parameter, but the parameter + is optional for the negative case.) - ``{curly|braces}`` -- similar to angle brackets, but instead of mutual exclusion, curly braces indicate that one or more of the pipe-separated sequences may be provided in any order. |