Skip to content

Commit

Permalink
Add note about option-like arguments to alter filter
Browse files Browse the repository at this point in the history
The Yargs parser doesn't seem to play nicely with option-like arguments
that are passed as positional arguments. For more information, refer to
the following issues:

  yargs/yargs-parser#381
  yargs/yargs-parser#145
  yargs/yargs#1821
  • Loading branch information
markus456 committed Aug 12, 2021
1 parent 572bbe3 commit 2bf04d1
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion maxctrl/lib/alter.js
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,11 @@ exports.builder = function (yargs) {
"To display the filter parameters, execute `show filter <filter>`. " +
"Some filters support runtime configuration changes to all parameters. " +
"Refer to the filter documentation for details on whether it supports " +
"runtime configuration changes and which parameters can be altered."
"runtime configuration changes and which parameters can be altered.\n" +
"\n" +
"Note: To pass options with dashes in them, surround them in both single and double quotes: \n" +
"\n" +
" maxctrl alter filter my-namedserverfilter target01 '\"->master\"'"
)
.usage("Usage: alter filter <filter> <key> <value> ...");
},
Expand Down

0 comments on commit 2bf04d1

Please sign in to comment.