#1040666 gccmakedep.1: some remarks and editorial fixes to the manual

Package:
xutils-dev
Source:
xutils-dev
Description:
X Window System utility programs for development
Submitter:
Bjarni Ingi Gislason
Date:
2023-07-08 20:54:03 UTC
Severity:
normal
Tags:
#1040666#5
Date:
2023-07-08 20:50:24 UTC
From:
To:
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