[CommandLine] Error message for incorrect PositionalEatArgs usage
authorKeno Fischer <keno@alumni.harvard.edu>
Mon, 14 May 2018 23:26:06 +0000 (23:26 +0000)
committerKeno Fischer <keno@alumni.harvard.edu>
Mon, 14 May 2018 23:26:06 +0000 (23:26 +0000)
commit8248d7c6616fd5b612d991adcff59ed288eaef5e
treec660f216925effc2436264cee02156eba4185b96
parenta2b8fe660404a9594363e7b9721c1df4f27fd500
[CommandLine] Error message for incorrect PositionalEatArgs usage

Summary:
bugpoint has several options specified as `PositionalEatArgs` to pass
options through to the underlying tool, e.g. `-tool-args`. The `-help`
message suggests the usage is: `-tool-args=<string>`. However, this is
misleading, because that's not how these arguments work. Rather than taking
a value, the option consumes all positional arguments until the next
recognized option (or all arguments if `--` is specified at some point).
To make this slightly clearer, instead print the help as:
```
  -tool-args <string>...                            - <tool arguments>...
```
Additionally, add an error if the user attempts to use a `PositionalEatArgs`
argument with a value, instead of silently ignoring it. Example:
```
./bin/bugpoint -tool-args=-mpcu=skylake-avx512
bugpoint: for the -tool-args option: This argument does not take a value.
    Instead, it consumes any positional arguments until the next recognized option.
```

Reviewed By: aprantl
Differential Revision: https://reviews.llvm.org/D46787

llvm-svn: 332311
llvm/include/llvm/Support/CommandLine.h
llvm/lib/Support/CommandLine.cpp
llvm/unittests/Support/CommandLineTest.cpp