Summary: Protect . if not an end of sentence.
Separate an ellipsis from the preceding string with a space. Add a period after "etc" and a comma after it. Add a missing left italic correction. Add a missing right italic correction. Split long lines (> 80). Change a two-fonts macro to an one-font macro for a single argument. Change a HYPHEN-MINUS (code 0x55, 2D) to a dash (minus) if it matches " -[:alpha:]" or \(aq-[:alpha:] (for options). Change <number>[\]-<number> to <number>\(en<number> if it is a numeric range. ### Details: Input file is make.1 mandoc: make.1:92:2: WARNING: skipping paragraph macro: sp after SH ####### Test nr. 2: Enable and fix warnings from 'test-groff'. <make.1>:198 (macro BR): only 1 argument, but more are expected Output is from: test-groff -b -e -mandoc -T utf8 -rF0 -t -w w -z [ "test-groff" is a developmental version of "groff" ] #### Test nr. 5: Change '-' (\-) to '\(en' (en-dash) for a numeric range. make.1:364:Copyright \(co 1992-1993, 1996-2017 Free Software Foundation, Inc. ##### Test nr. 8: Protect a full stop (.) with "\&", if it has a blank (white-space) in front of or (ignoring characters transparent to it) after it, and it does not mean an end of a sentence. 6:[\fIOPTION\fR]... [\fITARGET\fR]... ##### Test nr. 10: Separate an ellipsis from the preceding string with a space character, if it does not mean a continuation of it. See a manual of style about the difference between "abc..." and "abc ...". 6:[\fIOPTION\fR]... [\fITARGET\fR]... ##### Test nr. 16: Use the correct macro for the font change of one argument. Split a punctuation mark from the only argument if one is there 198:.BR make ##### Test nr. 21: Use a macro to change to the italic font, instead of \fI [1], if possible. The macros have the italic corrections, but "\c" removes them. Or add the italic corrections. [1] man-pages(7) [package "manpages"] 6:[\fIOPTION\fR]... [\fITARGET\fR]... 101:\fB\-C\fR \fIdir\fR, \fB\-\-directory\fR=\fIdir\fR 154:\fB\-E\fR \fIstring\fR, \fB\-\-eval\fR \fIstring\fR 155:Interpret \fIstring\fR using the \fBeval\fR function, before parsing any 158:\fB\-f\fR \fIfile\fR, \fB\-\-file\fR=\fIfile\fR, \fB\-\-makefile\fR=\fIFILE\fR 166:\fB\-I\fR \fIdir\fR, \fB\-\-include\-dir\fR=\fIdir\fR 188:\fB\-j\fR [\fIjobs\fR], \fB\-\-jobs\fR[=\fIjobs\fR] 207:\fB\-l\fR [\fIload\fR], \fB\-\-load\-average\fR[=\fIload\fR] 221:\fB\-o\fR \fIfile\fR, \fB\-\-old\-file\fR=\fIfile\fR, \fB\-\-assume\-old\fR=\fIfile\fR 229:\fB\-O\fR[\fItype\fR], \fB\-\-output\-sync\fR[=\fItype\fR] 315:\fB\-W\fR \fIfile\fR, \fB\-\-what\-if\fR=\fIfile\fR, \fB\-\-new\-file\fR=\fIfile\fR, \fB\-\-assume\-new\fR=\fIfile\fR ##### Test nr. 25: Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a name for an option. 230:When running multiple jobs in parallel with \fB-j\fR, ensure the output of ##### Test nr. 42: Split lines longer than 80 characters into two or more lines. Appropriate break points are the end of a sentence and a subordinate clause (after punctuation marks) make.1: line 221 length 86 \fB\-o\fR \fIfile\fR, \fB\-\-old\-file\fR=\fIfile\fR, \fB\-\-assume\-old\fR=\fIfile\fR make.1: line 315 length 117 \fB\-W\fR \fIfile\fR, \fB\-\-what\-if\fR=\fIfile\fR, \fB\-\-new\-file\fR=\fIfile\fR, \fB\-\-assume\-new\fR=\fIfile\fR ##### Test nr. 45: Add a missing left italic correction in front of \fI, or use a macro 6:[\fIOPTION\fR]... [\fITARGET\fR]... 101:\fB\-C\fR \fIdir\fR, \fB\-\-directory\fR=\fIdir\fR 154:\fB\-E\fR \fIstring\fR, \fB\-\-eval\fR \fIstring\fR 155:Interpret \fIstring\fR using the \fBeval\fR function, before parsing any 158:\fB\-f\fR \fIfile\fR, \fB\-\-file\fR=\fIfile\fR, \fB\-\-makefile\fR=\fIFILE\fR 166:\fB\-I\fR \fIdir\fR, \fB\-\-include\-dir\fR=\fIdir\fR 188:\fB\-j\fR [\fIjobs\fR], \fB\-\-jobs\fR[=\fIjobs\fR] 207:\fB\-l\fR [\fIload\fR], \fB\-\-load\-average\fR[=\fIload\fR] 221:\fB\-o\fR \fIfile\fR, \fB\-\-old\-file\fR=\fIfile\fR, \fB\-\-assume\-old\fR=\fIfile\fR 229:\fB\-O\fR[\fItype\fR], \fB\-\-output\-sync\fR[=\fItype\fR] 315:\fB\-W\fR \fIfile\fR, \fB\-\-what\-if\fR=\fIfile\fR, \fB\-\-new\-file\fR=\fIfile\fR, \fB\-\-assume\-new\fR=\fIfile\fR ##### Test nr. 46: Add a missing right italic correction after \fI (before "\f[BPR]), or use a macro 6:[\fIOPTION\fR]... [\fITARGET\fR]... 101:\fB\-C\fR \fIdir\fR, \fB\-\-directory\fR=\fIdir\fR 154:\fB\-E\fR \fIstring\fR, \fB\-\-eval\fR \fIstring\fR 155:Interpret \fIstring\fR using the \fBeval\fR function, before parsing any 158:\fB\-f\fR \fIfile\fR, \fB\-\-file\fR=\fIfile\fR, \fB\-\-makefile\fR=\fIFILE\fR 166:\fB\-I\fR \fIdir\fR, \fB\-\-include\-dir\fR=\fIdir\fR 188:\fB\-j\fR [\fIjobs\fR], \fB\-\-jobs\fR[=\fIjobs\fR] 207:\fB\-l\fR [\fIload\fR], \fB\-\-load\-average\fR[=\fIload\fR] 221:\fB\-o\fR \fIfile\fR, \fB\-\-old\-file\fR=\fIfile\fR, \fB\-\-assume\-old\fR=\fIfile\fR 229:\fB\-O\fR[\fItype\fR], \fB\-\-output\-sync\fR[=\fItype\fR] 315:\fB\-W\fR \fIfile\fR, \fB\-\-what\-if\fR=\fIfile\fR, \fB\-\-new\-file\fR=\fIfile\fR, \fB\-\-assume\-new\fR=\fIfile\fR ### Signed-off-by: Bjarni Ingi Gislason <[email protected]> --- doc/make.1 | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/doc/make.1 b/doc/make.1 index 031321e..7400542 100644 --- a/doc/make.1 +++ b/doc/make.1 @@ -3,7 +3,7 @@ make \- GNU make utility to maintain groups of programs .SH SYNOPSIS .B make -[\fIOPTION\fR]... [\fITARGET\fR]... +.RI [ OPTION " \&...\&] [" TARGET " \&...\&]" .SH DESCRIPTION .LP The @@ -89,7 +89,6 @@ updates a target if it depends on prerequisite files that have been modified since the target was last modified, or if the target does not exist. .SH OPTIONS -.sp 1 .TP 0.5i \fB\-b\fR, \fB\-m\fR These options are ignored for compatibility with other versions of @@ -98,7 +97,7 @@ These options are ignored for compatibility with other versions of \fB\-B\fR, \fB\-\-always\-make\fR Unconditionally make all targets. .TP 0.5i -\fB\-C\fR \fIdir\fR, \fB\-\-directory\fR=\fIdir\fR +\fB\-C\fR \,\fIdir\/\fR, \fB\-\-directory\fR=\,\fIdir\/\fR Change to directory .I dir before reading the makefiles or doing anything else. @@ -107,7 +106,7 @@ If multiple options are specified, each is interpreted relative to the previous one: .BR "\-C " / -.BR "\-C " etc +.BR "\-C " etc., is equivalent to .BR "\-C " /etc. This is typically used with recursive invocations of @@ -151,11 +150,11 @@ to disable all previous debugging flags. Give variables taken from the environment precedence over variables from makefiles. .TP 0.5i -\fB\-E\fR \fIstring\fR, \fB\-\-eval\fR \fIstring\fR -Interpret \fIstring\fR using the \fBeval\fR function, before parsing any +\fB\-E\fR \,\fIstring\/\fR, \fB\-\-eval\fR \,\fIstring\/\fR +Interpret \,\fIstring\/\fR using the \fBeval\fR function, before parsing any makefiles. .TP 0.5i -\fB\-f\fR \fIfile\fR, \fB\-\-file\fR=\fIfile\fR, \fB\-\-makefile\fR=\fIFILE\fR +\fB\-f\fR \,\fIfile\/\fR, \fB\-\-file\fR=\,\fIfile\/\fR, \fB\-\-makefile\fR=\,\fIFILE\/\fR Use .I file as a makefile. @@ -163,7 +162,7 @@ as a makefile. \fB\-i\fR, \fB\-\-ignore\-errors\fR Ignore all errors in commands executed to remake files. .TP 0.5i -\fB\-I\fR \fIdir\fR, \fB\-\-include\-dir\fR=\fIdir\fR +\fB\-I\fR \,\fIdir\/\fR, \fB\-\-include\-dir\fR=\,\fIdir\/\fR Specifies a directory .I dir to search for included makefiles. @@ -185,7 +184,7 @@ preprocessor's .B \-I flag. .TP 0.5i -\fB\-j\fR [\fIjobs\fR], \fB\-\-jobs\fR[=\fIjobs\fR] +\fB\-j\fR [\,\fIjobs\/\fR], \fB\-\-jobs\fR[=\,\fIjobs\/\fR] Specifies the number of .I jobs (commands) to run simultaneously. @@ -195,7 +194,7 @@ option, the last one is effective. If the .B \-j option is given without an argument, -.BR make +.B make will not limit the number of jobs that can run simultaneously. .TP 0.5i \fB\-k\fR, \fB\-\-keep\-going\fR @@ -204,7 +203,7 @@ While the target that failed, and those that depend on it, cannot be remade, the other dependencies of these targets can be processed all the same. .TP 0.5i -\fB\-l\fR [\fIload\fR], \fB\-\-load\-average\fR[=\fIload\fR] +\fB\-l\fR [\,\fIload\/\fR], \fB\-\-load\-average\fR[=\,\fIload\/\fR] Specifies that no new jobs (commands) should be started if there are others jobs running and the load average is at least .I load @@ -218,7 +217,8 @@ Use the latest mtime between symlinks and target. Print the commands that would be executed, but do not execute them (except in certain circumstances). .TP 0.5i -\fB\-o\fR \fIfile\fR, \fB\-\-old\-file\fR=\fIfile\fR, \fB\-\-assume\-old\fR=\fIfile\fR +\fB\-o\fR \,\fIfile\/\fR, \fB\-\-old\-file\fR=\,\fIfile\/\fR, \ +\fB\-\-assume\-old\fR=\,\fIfile\/\fR Do not remake the file .I file even if it is older than its dependencies, and do not remake anything @@ -226,8 +226,8 @@ on account of changes in .IR file . Essentially the file is treated as very old and its rules are ignored. .TP 0.5i -\fB\-O\fR[\fItype\fR], \fB\-\-output\-sync\fR[=\fItype\fR] -When running multiple jobs in parallel with \fB-j\fR, ensure the output of +\fB\-O\fR[\,\fItype\/\fR], \fB\-\-output\-sync\fR[=\,\fItype\/\fR] +When running multiple jobs in parallel with \fB\-j\fR, ensure the output of each job is collected together rather than interspersed with output from other jobs. If .I type @@ -312,7 +312,8 @@ Turn off .BR \-w , even if it was turned on implicitly. .TP 0.5i -\fB\-W\fR \fIfile\fR, \fB\-\-what\-if\fR=\fIfile\fR, \fB\-\-new\-file\fR=\fIfile\fR, \fB\-\-assume\-new\fR=\fIfile\fR +\fB\-W\fR \,\fIfile\/\fR, \fB\-\-what\-if\fR=\,\fIfile\/\fR, \ +\fB\-\-new\-file\fR=\,\fIfile\/\fR, \fB\-\-assume\-new\fR=\,\fIfile\/\fR Pretend that the target .I file has just been modified. @@ -361,7 +362,7 @@ This manual page contributed by Dennis Morse of Stanford University. Further updates contributed by Mike Frysinger. It has been reworked by Roland McGrath. Maintained by Paul Smith. .SH "COPYRIGHT" -Copyright \(co 1992-1993, 1996-2017 Free Software Foundation, Inc. +Copyright \(co 1992\(en1993, 1996\(en2017 Free Software Foundation, Inc. This file is part of .IR "GNU make" . .LP -- 2.17.1 -- Bjarni I. Gislason _______________________________________________ Bug-make mailing list [email protected] https://lists.gnu.org/mailman/listinfo/bug-make
