Bug#1091006: fc-conflist.1: Some remarks and a patch with editorial changes for this man page
Bjarni Ingi Gislason
bjarniig at simnet.is
Sun Dec 22 08:16:16 GMT 2024
Package: fontconfig
Version: 2.15.0-1.1+b1
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with a new version
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z < "man page"
[Use "groff -e ' $' <file>" to find trailing spaces.]
["test-groff" is a script in the repository for "groff"; is not shipped]
(local copy and "troff" slightly changed by me).
[The fate of "test-nroff" was decided in groff bug #55941.]
* What was the outcome of this action?
an.tmac:<stdin>:2: style: .TH missing fourth argument; consider package/project name and version (e.g., "groff 1.23.0")
an.tmac:<stdin>:2: style: .TH missing fifth argument and second argument '1' not a recognized manual section; specify its title
troff:<stdin>:7: warning: trailing space in the line
an.tmac:<stdin>:9: style: 1 leading space(s) on input line
troff:<stdin>:9: warning: trailing space in the line
* What outcome did you expect instead?
No output (no warnings).
-.-
General remarks and further material, if a diff-file exist, are in the
attachments.
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.12.5-amd64 (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 fontconfig depends on:
ii fontconfig-config 2.15.0-1.1+b1
ii libc6 2.40-4
ii libfontconfig1 2.15.0-1.1+b1
ii libfreetype6 2.13.3+dfsg-1
fontconfig recommends no packages.
fontconfig suggests no packages.
-- no debconf information
-------------- next part --------------
Input file is fc-conflist.1
Any program (person), that produces man pages, should check the output
for defects by using (both groff and nroff)
[gn]roff -mandoc -t -ww -b -z -K utf8 <man page>
The same goes for man pages that are used as an input.
For a style guide use
mandoc -T lint
-.-
So any 'generator' should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
This is just a simple quality control measure.
The 'generator' may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Input text line longer than 80 bytes.
Not removing trailing spaces (in in- and output).
The reason for these trailing spaces should be found and eliminated.
Not beginning each input sentence on a new line.
Lines should thus be shorter.
See man-pages(7), item 'semantic newline'.
-.-
The difference between the formatted output of the original and patched file
can be seen with:
nroff -mandoc <file1> > <out1>
nroff -mandoc <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -mandoc -Z - "
instead of 'nroff -mandoc'
Add the option '-t', if the file contains a table.
Read the output of 'diff -u' with 'less -R' or similar.
-.-.
If 'man' (man-db) is used to check the manual for warnings,
the following must be set:
The option "-warnings=w"
The environmental variable:
export MAN_KEEP_STDERR=yes (or any non-empty value)
or
(produce only warnings):
export MANROFFOPT="-ww -b -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Output from "mandoc -T lint fc-conflist.1": (shortened list)
3 input text line longer than 80 bytes
1 normalizing date format to
5 skipping paragraph macro
2 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z fc-conflist.1": (shortened list)
2 trailing space in the line
-.-.
Remove space characters (whitespace) at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
Number of lines affected is
2
-.-.
Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-
9: [ \fB--version\fR ] [ \fB--help\fR ]
-.-.
Remove space in the first column, if not indented.
Use ".in +<number>n" and ".in" to end it; ".nf" and ".fi" to end
it, for an extra indention.
fc-conflist.1:9: [ \fB--version\fR ] [ \fB--help\fR ]
-.-.
Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.
7:\fBfc-conflist\fR [ \fB-Vh\fR ]
9: [ \fB--version\fR ] [ \fB--help\fR ]
14:The output is a `-' or `+' depending on whether the file is ignored or processed, a space, the file's path, a colon and space, and the description from the file or `No description' if none is present.
21:with long options starting with two dashes (`-'). A summary of
24:\fB-V\fR
27:\fB-h\fR
-.-.
Wrong distance between sentences in the input file.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
-.-
Mark a abbreviation point as such by suffixing them with "\\&".
21:with long options starting with two dashes (`-'). A summary of
-.-.
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.
Line 12, length 98
\fBfc-conflist\fR prints an annotated list of all the configuration files processed by Fontconfig.
Line 14, length 200
The output is a `-' or `+' depending on whether the file is ignored or processed, a space, the file's path, a colon and space, and the description from the file or `No description' if none is present.
Line 16, length 107
The order of files looks like how fontconfig actually processes them except one contains <include> element.
Line 17, length 105
In that case, it will be shown after processing all the sub directories where is targeted by <include>\&.
-.-.
Show if docman-to-man created this
1:.\" auto-generated by docbook2man-spec from docbook-utils package
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":
an.tmac:<stdin>:2: style: .TH missing fourth argument; consider package/project name and version (e.g., "groff 1.23.0")
an.tmac:<stdin>:2: style: .TH missing fifth argument and second argument '1' not a recognized manual section; specify its title
troff:<stdin>:7: warning: trailing space in the line
an.tmac:<stdin>:9: style: 1 leading space(s) on input line
troff:<stdin>:9: warning: trailing space in the line
-.-.
Additionally (general):
Abbreviations get a '\&' added after their final full stop (.) to mark them
as such and not as an end of a sentence.
There is no need to add a '\&' before a full stop (.) if it has a character
before it!
-------------- next part --------------
--- fc-conflist.1 2024-12-22 07:51:22.886397998 +0000
+++ fc-conflist.1.new 2024-12-22 08:06:34.288419629 +0000
@@ -3,33 +3,34 @@
.SH NAME
fc-conflist \- list the configuration files processed by Fontconfig
.SH SYNOPSIS
-.sp
-\fBfc-conflist\fR [ \fB-Vh\fR ]
-
- [ \fB--version\fR ] [ \fB--help\fR ]
+\fBfc-conflist\fR [ \fB\-Vh\fR ] \
+[ \fB\-\-version\fR ] [ \fB\-\-help\fR ]
.SH "DESCRIPTION"
-.PP
\fBfc-conflist\fR prints an annotated list of all the configuration files processed by Fontconfig.
.PP
-The output is a `-' or `+' depending on whether the file is ignored or processed, a space, the file's path, a colon and space, and the description from the file or `No description' if none is present.
-.PP
-The order of files looks like how fontconfig actually processes them except one contains <include> element.
-In that case, it will be shown after processing all the sub directories where is targeted by <include>\&.
+The output is a `\-' or `+' depending on whether the file is ignored
+or processed, a space, the file's path, a colon and space,
+and the description from the file or `No description'
+if none is present.
+.PP
+The order of files looks like
+how fontconfig actually processes them
+except one contains <include> element.
+In that case,
+it will be shown after processing all the sub directories
+where it is targeted by <include>.
.SH "OPTIONS"
-.PP
This program follows the usual GNU command line syntax,
-with long options starting with two dashes (`-'). A summary of
-options is included below.
+with long options starting with two dashes (`\-').
+A summary of options is included below.
.TP
-\fB-V\fR
+\fB\-V\fR
Show version of the program and exit.
.TP
-\fB-h\fR
+\fB\-h\fR
Show summary of options.
.SH "RETURN CODES"
-.PP
\fBfc-conflist\fR returns error code 0 for successful parsing,
or 1 if any errors occurred or if at least one font face could not be opened.
.SH "AUTHOR"
-.PP
This manual page was updated by Akira TAGOH <akira at tagoh.org>\&.
More information about the Pkg-freedesktop-maintainers
mailing list