[PATCH] D156436: [llvm/OptTable] Print options without documentation

Jan Ole Hüser via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Fri Jul 28 09:35:42 PDT 2023


j0le added a comment.

In D156436#4542676 <https://reviews.llvm.org/D156436#4542676>, @awarzynski wrote:

> @j0le, thanks for caring about `--help` - it could really benefit from a bit of love. However, I'm not convinced that this is the right direction:
>
> [...]
>
> We should focus on quality rather than the quantity of the help text being printed. 
> Personally, I find `clang --help` of little help because it is just a very long dump of unfiltered/uncategorized text. As pointed out in my inline comment, it's perfectly fine to skip some options from the `--help` dump if they don't really contribute any new information. However, categorizing options so that `clang --help` would greatly improve the user experience. At least for Clang. In the case of Flang the list of supported options is still very short and `--help` is quite "manageable".

Yeah, I would also find it better, if we grouped the options some how. Maybe I will find some time for that some day, because this a little bit more work than this small patch.

I'm fine with discarding this patch, because I can still search for options in https://clang.llvm.org/docs/ClangCommandLineReference.html (But it is a little bit broken at the end.)
But I wanna say: The user might be fooled and think the output of "--help" is complete, or identical to https://clang.llvm.org/docs/ClangCommandLineReference.html, but that's not the case.

Thanks for your feedback, @awarzynski!


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

https://reviews.llvm.org/D156436



More information about the llvm-commits mailing list