diff options
| author | Daniel Hannon <hello111f@gmail.com> | 2022-05-27 22:04:43 +0100 |
|---|---|---|
| committer | Kim Gräsman <kim.grasman@gmail.com> | 2022-05-28 11:03:40 +0200 |
| commit | 67942da4111888b800b2be34df0f7a432621256f (patch) | |
| tree | 4b8e26104aea7e7346bf1e2b7de5d57570bfced8 | |
| parent | 1375e5650397340ebd1c28a9be912d8a3c7c56c3 (diff) | |
clarify purpose of --update_comments in help screen and manpages
| -rwxr-xr-x | fix_includes.py | 4 | ||||
| -rw-r--r-- | include-what-you-use.1 | 4 | ||||
| -rw-r--r-- | iwyu_globals.cc | 2 |
3 files changed, 7 insertions, 3 deletions
diff --git a/fix_includes.py b/fix_includes.py index 67f2a03..c5ff2fb 100755 --- a/fix_includes.py +++ b/fix_includes.py @@ -2373,8 +2373,8 @@ def main(argv): parser.add_option('--nocomments', action='store_false', dest='comments') parser.add_option('--update_comments', action='store_true', default=False, - help=('Update #include comments, even if no #include lines' - ' are added or removed')) + help=('Replace \'why\' comments with the ones provided by' + ' IWYU')) parser.add_option('--noupdate_comments', action='store_false', dest='update_comments') diff --git a/include-what-you-use.1 b/include-what-you-use.1 index 9b1745f..446e88a 100644 --- a/include-what-you-use.1 +++ b/include-what-you-use.1 @@ -121,6 +121,10 @@ Do not suggest that a file should add .IR foo.h " unless " foo.h is already visible in the file's transitive includes. .TP +.BI \-\-update_comments +Print full include list with comments, even if there are no +\(lqinclude-what-you-use\(rq violations. +.TP .BI \-\-verbose= level Set verbosity. At the highest level, this will dump the AST of the source file and explain all decisions. diff --git a/iwyu_globals.cc b/iwyu_globals.cc index 8ba6c05..73c8853 100644 --- a/iwyu_globals.cc +++ b/iwyu_globals.cc @@ -91,7 +91,7 @@ static void PrintHelp(const char* extra_msg) { " the maximum line length can still be exceeded with long\n" " file names (default: 80).\n" " --no_comments: do not add 'why' comments.\n" - " --update_comments: always add 'why' comments, even if no\n" + " --update_comments: update and insert 'why' comments, even if no\n" " #include lines need to be added or removed.\n" " --no_fwd_decls: do not use forward declarations.\n" " --verbose=<level>: the higher the level, the more output.\n" |