Issue 129671
Summary Confusing behaviour command line options with default value 'true'
Labels new issue
Assignees
Reporter JVApen
    In clang-include-cleaner, there are some options that have a default value 'true'.

For example:
https://github.com/llvm/llvm-project/blob/03505a004ff6909c46d6b8c498a9ffccd47d88a0/clang-tools-extra/include-cleaner/tool/IncludeCleaner.cpp#L100-L105

When using the --help for it, it tells the following:
````
USAGE: clang-include-cleaner.exe [options] <source0> [... <sourceN>]

OPTIONS:
 ...
  --remove                    - Allow header removals
  --version - Display the version of this program
````
This seems to imply that you have to add '--remove' in order to active the example option.
However, this is enabled by default. If you don't want the 'removal' behavior, you have to add `--remove=false` to the command line. This is nowhere to be found in the help message.

Can the command line output be improved such that default options are somehow indicated and it is easy to see how to disable them? For example ` --remove      - Allow header removals (Default, use --remove=false to disable)`
_______________________________________________
llvm-bugs mailing list
llvm-bugs@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-bugs

Reply via email to