[PATCH] D123682: [clang-tblgen] Automatically document options values

[Aaron Ballman via Phabricator via cfe-commits]

aaron.ballman accepted this revision.
aaron.ballman added a comment.
This revision is now accepted and ready to land.

In D123682#3450215 <https://reviews.llvm.org/D123682#3450215>, @MaskRay wrote:

> Thank you for improving the tool :)
>
>   cd clang
>   path/to/clang-tblgen --gen-opt-docs -I ../llvm/include -I include/clang/Driver include/clang/Driver/ClangOptionDocs.td > /tmp/0
>   nvim -d docs/ClangCommandLineReference.rst /tmp/0
>
> Hope a native speaker (@aaron.ballman @dexonsmith @jhenderson ) can suggest the usage here.
>
> For an option with more than 2 choices: the current documentation is `<arg> can be one of 'return', 'branch', 'full' or 'none'`,
> I'm thinking of: `<arg> should be 'return', 'branch', 'full', or 'none'`
>
> When there are two choices (`-gsplit-dwarf=<arg>`), currently the documentation is `<arg> can be one of 'split' or 'single'.`
> I am thinking of `<arg> should be 'split' or 'single'`.

Both of these suggestions seem reasonable to me (shorter but equally as clear as before), but we should fix to be consistent in `llvm/utils/TableGen/OptRSTEmitter.cpp` if we opt to go this route.

The changes here LGTM as-is (I'm happy with either current wording or the changed wording). Thanks for this!


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D123682/new/

https://reviews.llvm.org/D123682