diff options
author | Sylvestre Ledru <sylvestre@mozilla.com> | 2018-09-23 23:27:17 +0100 |
---|---|---|
committer | Sylvestre Ledru <sylvestre@mozilla.com> | 2018-09-23 23:32:30 +0100 |
commit | 6d321599ed3794d0d7a5dfd96eabdbef512bfb5e (patch) | |
tree | 18cbb1ff05f44d280cd446dd22d880c6c3fda793 | |
parent | a558b262092e302cb501f56106036751168711fd (diff) |
Refresh manpage for fix_includedebian/6.0-2
-rw-r--r-- | debian/changelog | 1 | ||||
-rw-r--r-- | debian/fix_include.1 | 50 | ||||
-rw-r--r-- | debian/iwyu.manpages | 3 | ||||
-rw-r--r-- | debian/iwyu_tool.1 | 34 | ||||
-rwxr-xr-x | debian/rules | 1 |
5 files changed, 51 insertions, 38 deletions
diff --git a/debian/changelog b/debian/changelog index b18bc83..bc68392 100644 --- a/debian/changelog +++ b/debian/changelog @@ -5,6 +5,7 @@ iwyu (6.0-2) unstable; urgency=medium * Standards-Version updated to 4.2.1 * Fix space-in-std-shortname-in-dep5-copyright * Also ship a manpage for iwyu_tool + * Refresh manpage for fix_include -- Sylvestre Ledru <sylvestre@debian.org> Sun, 23 Sep 2018 22:12:33 +0100 diff --git a/debian/fix_include.1 b/debian/fix_include.1 index 4753880..7ebe68e 100644 --- a/debian/fix_include.1 +++ b/debian/fix_include.1 @@ -1,28 +1,25 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.43.2. -.TH FIX_INCLUDE "1" "November 2013" "fix_include 3.3" "User Commands" +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. +.TH FIX_INCLUDES.PY "1" "September 2018" "fix_includes.py 6.0-2" "User Commands" .SH NAME -fix_include \- Update the source code with iwyu output +fix_includes.py \- manual page for fix_includes.py 6.0-2 .SH SYNOPSIS -.B fix_include -[\fIoptions\fR] [\fIfilename\fR] ... \fI< <output from include-what-you-use script>\fR -OR -.B fix_include -\fB\-s\fR [other options] <filename> ... +.B fix_includes.py +[\fI\,options\/\fR] [\fI\,filename\/\fR] ... \fI\,< <output from include-what-you-use script>\/\fR .SH DESCRIPTION +.IP +OR fix_includes.py \fB\-s\fR [other options] <filename> ... .PP -fix_include reads the output from the include\-what\-you\-use -script on stdin \fB\-\-\fR run with \fB\-\-v\fR=\fI1\fR (default) verbose or above \fB\-\-\fR and, +fix_includes.py reads the output from the include\-what\-you\-use +script on stdin \fB\-\-\fR run with \fB\-\-v\fR=\fI\,1\/\fR (default) verbose or above \fB\-\-\fR and, unless \fB\-\-sort_only\fR or \fB\-\-dry_run\fR is specified, modifies the files mentioned in the output, removing their old #include lines and replacing them with the lines given by the include_what_you_use script. It also sorts the #include and forward\-declare lines. .PP -Only writable files (those opened for p4 edit) are modified (unless -\fB\-\-checkout_command\fR is specified). All files mentioned in the -include\-what\-you\-use script are modified, unless filenames are -specified on the commandline, in which case only those files are -modified. +All files mentioned in the include\-what\-you\-use script are modified, +unless filenames are specified on the commandline, in which case only +those files are modified. .PP The exit code is the number of files that were modified (or that would be modified if \fB\-\-dry_run\fR was specified) unless that number exceeds 100, @@ -59,28 +56,11 @@ Do not actually edit any files; just print diffs. Return code is 0 if no changes are needed, else min(the number of files that would be modified, 100) .TP -\fB\-\-ignore_re\fR=\fIIGNORE_RE\fR +\fB\-\-ignore_re\fR=\fI\,IGNORE_RE\/\fR fix_includes.py will skip editing any file whose name matches this regular expression. .TP -\fB\-\-checkout_command\fR=\fICHECKOUT_COMMAND\fR -A command, such as "p4 edit", to run on all the nonwriteable files before modifying them. The filenames -will be appended to the command after a space. The -command will not be run on any file that does not need -to change. -.TP -\fB\-\-create_cl_if_possible\fR -If \fB\-\-checkout_command\fR is "p4|g4|v4 edit" and all files -to be modified needed to be checked out, then create a -CL containing those files. -.HP -\fB\-\-nocreate_cl_if_possible\fR -.TP -\fB\-\-append_to_cl\fR=\fIAPPEND_TO_CL\fR -If provided, with a checkout_command, add files that -need fixing to the specified existing CL. -.TP -\fB\-\-separate_project_includes\fR=\fISEPARATE_PROJECT_INCLUDES\fR +\fB\-\-separate_project_includes\fR=\fI\,SEPARATE_PROJECT_INCLUDES\/\fR Sort #includes for current project separately from all other #includes. This flag specifies the root directory of the current project. If the value is @@ -89,7 +69,7 @@ directory are assumed to be in the same project. If not specified, project #includes will be sorted with other non\-system #includes. .TP -\fB\-\-invoking_command_line\fR=\fIINVOKING_COMMAND_LINE\fR +\fB\-\-invoking_command_line\fR=\fI\,INVOKING_COMMAND_LINE\/\fR Internal flag used by iwyu.py, It should be the command line used to invoke iwyu.py .TP diff --git a/debian/iwyu.manpages b/debian/iwyu.manpages index ca6c389..2d99591 100644 --- a/debian/iwyu.manpages +++ b/debian/iwyu.manpages @@ -1,5 +1,4 @@ iwyu-build/include-what-you-use.1 iwyu-build/iwyu.1 -iwyu-build/iwyu_tool.1 +debian/iwyu_tool.1 debian/fix_include.1 - diff --git a/debian/iwyu_tool.1 b/debian/iwyu_tool.1 new file mode 100644 index 0000000..4ecf175 --- /dev/null +++ b/debian/iwyu_tool.1 @@ -0,0 +1,34 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.6. +.TH IWYU_TOOL.PY "1" "September 2018" "iwyu_tool.py 6.0-2" "User Commands" +.SH NAME +iwyu_tool.py \- Include-what-you-use compilation database driver +.SH DESCRIPTION +usage: iwyu_tool.py [\-h] [\-v] [\-o {clang,iwyu}] [\-j JOBS] \fB\-p\fR <build\-path> +.TP +[source [source ...]] \fB\-\-\fR [<IWYU args>] +[source [source ...]] +.PP +Include\-what\-you\-use compilation database driver. +.SS "positional arguments:" +.TP +source +Zero or more source files to run IWYU on. Defaults to +all in compilation database. +.SS "optional arguments:" +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help message and exit +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Print IWYU commands +.TP +\fB\-o\fR {clang,iwyu}, \fB\-\-output\-format\fR {clang,iwyu} +Output format (default: iwyu) +.TP +\fB\-j\fR JOBS, \fB\-\-jobs\fR JOBS +Number of concurrent subprocesses +.TP +\fB\-p\fR <build\-path> +Compilation database path +.PP +Assumes include\-what\-you\-use is available on the PATH. diff --git a/debian/rules b/debian/rules index 3672823..cc5d072 100755 --- a/debian/rules +++ b/debian/rules @@ -23,7 +23,6 @@ override_dh_auto_configure: override_dh_auto_build: dh_auto_build help2man --no-info --version-string "$(VERSION)" -n "Analyze #includes in C and C++ source files" $(TARGET_BUILD)/include-what-you-use > $(TARGET_BUILD)/include-what-you-use.1 - help2man --no-info --version-string "$(VERSION)" -n "Include-what-you-use compilation database driver" ./iwyu_tool.py > $(TARGET_BUILD)/iwyu_tool.1 cd $(TARGET_BUILD) && ln -s include-what-you-use.1 iwyu.1 && \ cp ../fix_includes.py fix_include |