Bug#1040666: gccmakedep.1: some remarks and editorial fixes to the manual
Package: xutils-dev
Version: 1:7.7+6
Severity: minor
Tags: patch
Dear Maintainer,
here are some notes and a patch in the attachment.
-.-.
The difference between the formatted outputs can be seen with:
nroff -man <file1> > <out1>
nroff -man <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
"groff -man -Z" instead of "nroff -man"
-.-.
Remove space characters at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
119:The version of the
121:included in this X.Org Foundation release was originally
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
11:.BI \-a
-.-.
Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.
3:gccmakedep \- create dependencies in makefiles using 'gcc -M'
22:program calls 'gcc -M' to output
-.-.
Protect a period (.) or a apostrophe (') with '\&' from becoming a
control character, if it could end up at the start of a line (by
splitting the line into more lines).
22:program calls 'gcc -M' to output
53:will be used in a makefile target so that typing 'make depend' will bring
-.-.
Output from "test-nroff -man -b -ww -z -rCHECKSTYLE=3":
[ "test-groff" is a developmental version of "groff" ]
Input file is ./gccmakedep.1
Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z -rSTYLECHECK=3":
an.tmac:<stdin>:11: style: .BI expects at least 2 arguments, got 1
troff: backtrace: file '<stdin>':119
troff:<stdin>:119: warning: trailing space in the line
troff: backtrace: file '<stdin>':121
troff:<stdin>:121: warning: trailing space in the line
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.3.7-1 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages xutils-dev depends on:
ii cpp 4:12.3.0-1
ii libc6 2.37-3
xutils-dev recommends no packages.
xutils-dev suggests no packages.
-- no debconf information
--- gccmakedep.1 2023-07-08 20:16:22.000000000 +0000
+++ gccmakedep.1.new 2023-07-08 20:27:28.000000000 +0000
@@ -1,6 +1,6 @@
.TH gccmakedep 1 "gccmakedep 1.0.3" "X Version 11"
.SH NAME
-gccmakedep \- create dependencies in makefiles using 'gcc -M'
+gccmakedep \- create dependencies in makefiles using \&'gcc \-M'
.SH SYNOPSIS
.B gccmakedep
[
@@ -8,7 +8,7 @@ gccmakedep \- create dependencies in mak
] [
.BI \-f makefile
] [
-.BI \-a
+.B \-a
] [
\-\^\-
.I options
@@ -19,7 +19,7 @@ gccmakedep \- create dependencies in mak
.SH DESCRIPTION
The
.B gccmakedep
-program calls 'gcc -M' to output
+program calls \&'gcc \-M' to output
.I makefile
rules describing the dependencies of each
.IR sourcefile ,
@@ -50,7 +50,7 @@ and place the output after that.
.SH EXAMPLE
Normally,
.B gccmakedep
-will be used in a makefile target so that typing 'make depend' will bring
+will be used in a makefile target so that typing \&'make depend' will bring
the dependencies up to date for the makefile.
For example,
.nf
@@ -116,9 +116,9 @@ normally.
.BR make (1),
.BR makedepend (1).
.SH AUTHOR
-The version of the
+The version of the
.B gccmakedep
-included in this X.Org Foundation release was originally
+included in this X.Org Foundation release was originally
written by the XFree86 Project based on code supplied by Hongjiu Lu.
.PP
Colin Watson wrote this manual page, originally for the Debian Project,
Reply to: