Bug#1089663: cpan.1: Some remarks and editorial changes for this man page
Bjarni Ingi Gislason
bjarniig at simnet.is
Tue Dec 10 19:34:39 GMT 2024
Package: perl
Version: 5.40.0-8
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 -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?
troff:<stdin>:67: warning: font name 'CW' is deprecated
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":
troff:<stdin>:262: warning: [page 3, line 41]: cannot break line
troff:<stdin>:264: warning: [page 3, line 44]: cannot break 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.11.10-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 perl depends on:
ii libperl5.40 5.40.0-8
ii perl-base 5.40.0-8
ii perl-modules-5.40 5.40.0-8
Versions of packages perl recommends:
ii netbase 6.4
Versions of packages perl suggests:
pn libtap-harness-archive-perl <none>
pn libterm-readline-gnu-perl | libterm-readline-perl-perl <none>
ii make 4.3-4.1
ii perl-doc 5.40.0-8
-- no debconf information
-------------- next part --------------
Input file is cpan.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 cpan.1": (shortened list)
10 input text line longer than 80 bytes
-.-.
Output from "test-groff -mandoc -t -ww -z cpan.1": (shortened list)
1 font name 'CW' is deprecated
-.-.
Output from "mandoc -T lint cpan.1":
mandoc: cpan.1:129:84: STYLE: input text line longer than 80 bytes: config with \f(CW\*(...
mandoc: cpan.1:141:88: STYLE: input text line longer than 80 bytes: If you want this fea...
mandoc: cpan.1:145:85: STYLE: input text line longer than 80 bytes: Print a help message...
mandoc: cpan.1:153:99: STYLE: input text line longer than 80 bytes: Load \f(CW\*(C`local...
mandoc: cpan.1:176:85: STYLE: input text line longer than 80 bytes: A comma-separated li...
mandoc: cpan.1:262:115: STYLE: input text line longer than 80 bytes: Lancaster Consensus:...
mandoc: cpan.1:264:105: STYLE: input text line longer than 80 bytes: Oslo Consensus: <htt...
mandoc: cpan.1:276:85: STYLE: input text line longer than 80 bytes: As with \f(CW\*(C`PE...
mandoc: cpan.1:282:141: STYLE: input text line longer than 80 bytes: the \f(CW\*(C`Log::L...
mandoc: cpan.1:286:85: STYLE: input text line longer than 80 bytes: The path to the \f(C...
-.-.
Change '-' (\-) to '\(en' (en-dash) for a numeric range.
GNU gnulib has recently (2023-06-18) updated its
"build_aux/update-copyright" to recognize "\(en" in man pages.
cpan.1:338:Copyright (c) 2001\-2015, brian d foy, All Rights Reserved.
-.-.
Strings longer than 3/4 of a standard line length (80)
Use "\:" to split the string at the end of an output line, for example a
long URLs (web address)
262 Lancaster Consensus: <https://github.com/Perl\-Toolchain\-Gang/toolchain\-site/blob/master/lancaster\-consensus.md>
264 Oslo Consensus: <https://github.com/Perl\-Toolchain\-Gang/toolchain\-site/blob/master/oslo\-consensus.md>
-.-.
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 &.
N.B.
The number of lines affected can be too large to be in a patch.
92:This script provides a command interface (not a shell) to CPAN. At the
111:Show the module details. This prints one line for each out-of-date module
117:Force the specified action, when it normally would have failed. Use this
118:to install a module even if its tests fail. When you use this option,
126:Turn off CPAN.pm's attempts to lock anything. You should be careful with
128:same directory. This isn't so much of a concern if you're loading a special
145:Print a help message and exit. When you specify \f(CW\*(C`\-h\*(C'\fR, it ignores all
149:Install the specified modules. With no other switches, this switch
153:Load \f(CW\*(C`local::lib\*(C'\fR (think like \f(CW\*(C`\-I\*(C'\fR for loading lib paths). Too bad
157:Load the file that has the CPAN configuration data. This should have the
162:Dump the configuration in the same format that CPAN.pm uses. This is useful
176:A comma-separated list of mirrors to use for just this run. The \f(CW\*(C`\-P\*(C'\fR
180:Do a dry run, but don't actually install anything. (unimplemented)
196:Drop in the CPAN.pm shell. This command does this automatically if you don't
203:Do not test modules. Simply install them.
206:Upgrade all installed modules. Blindly doing this can really break things,
218:Turn on cpan warnings. This checks various things, like directory permissions,
223:mistyped. This requires the optional installation of Text::Levenshtein or
259:while others matter to the levels above them. Some of these are specified
268:that do that correctly. \f(CWcpan(1)\fR sets this to \f(CW1\fR unless it already
272:Use the default answer for a prompted questions. \f(CWcpan(1)\fR sets this
281:Log::Log4perl if it is installed. Possible values are the same as
283:\&\f(CW\*(C`ERROR\*(C'\fR, and \f(CW\*(C`FATAL\*(C'\fR. The default is \f(CW\*(C`INFO\*(C'\fR.
286:The path to the \f(CW\*(C`git\*(C'\fR binary to use for the Git features. The default
291:positive number if it thinks that something failed. Note, however, that
293:not control. For now, the exit codes are vague:
-.-.
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.
N.B.
The number of lines affected can be too large to be in a patch.
Line 129, length 84
config with \f(CW\*(C`\-j\*(C'\fR, and that config sets up its own work directories.
Line 141, length 88
If you want this feature, check out Yanick Champoux's \f(CW\*(C`Git::CPAN::Patch\*(C'\fR
Line 145, length 85
Print a help message and exit. When you specify \f(CW\*(C`\-h\*(C'\fR, it ignores all
Line 153, length 99
Load \f(CW\*(C`local::lib\*(C'\fR (think like \f(CW\*(C`\-I\*(C'\fR for loading lib paths). Too bad
Line 176, length 85
A comma-separated list of mirrors to use for just this run. The \f(CW\*(C`\-P\*(C'\fR
Line 262, length 115
Lancaster Consensus: <https://github.com/Perl\-Toolchain\-Gang/toolchain\-site/blob/master/lancaster\-consensus.md>
Line 264, length 105
Oslo Consensus: <https://github.com/Perl\-Toolchain\-Gang/toolchain\-site/blob/master/oslo\-consensus.md>
Line 276, length 85
As with \f(CW\*(C`PERL5OPT\*(C'\fR, a string of additional \f(CWcpan(1)\fR options to
Line 282, length 141
the \f(CW\*(C`Log::Log4perl\*(C'\fR levels: \f(CW\*(C`TRACE\*(C'\fR, \f(CW\*(C`DEBUG\*(C'\fR, \f(CW\*(C`INFO\*(C'\fR, \f(CW\*(C`WARN\*(C'\fR,
Line 283, length 94
\&\f(CW\*(C`ERROR\*(C'\fR, and \f(CW\*(C`FATAL\*(C'\fR. The default is \f(CW\*(C`INFO\*(C'\fR.
Line 286, length 85
The path to the \f(CW\*(C`git\*(C'\fR binary to use for the Git features. The default
-.-.
Add a zero (0) in front of a decimal fraction that begins with a period
(.)
7:.if t .sp .5v
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
cpan.1:153:Load \f(CW\*(C`local::lib\*(C'\fR (think like \f(CW\*(C`\-I\*(C'\fR for loading lib paths). Too bad
cpan.1:180:Do a dry run, but don't actually install anything. (unimplemented)
cpan.1:269:has a value (even if that value is false).
cpan.1:273:to \f(CW1\fR unless it already has a value (even if that value is false).
cpan.1:276:As with \f(CW\*(C`PERL5OPT\*(C'\fR, a string of additional \f(CWcpan(1)\fR options to
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -z ":
troff:<stdin>:67: warning: font name 'CW' is deprecated
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -z ":
troff:<stdin>:262: warning: [page 3, line 41]: cannot break line
troff:<stdin>:264: warning: [page 3, line 44]: cannot break 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.
-------------- next part --------------
--- cpan.1 2024-12-10 19:27:26.401707987 +0000
+++ cpan.1.new 2024-12-10 01:49:15.063731287 +0000
@@ -4,11 +4,12 @@
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
+.if t .sp 0.5v
.if n .sp
..
.de Vb \" Begin verbatim text
-.ft CW
+.ie \\n(.g .ft CR
+.el .ft CW
.nf
.ne \\$1
..
@@ -126,7 +127,7 @@ to install a module even if its tests fa
Turn off CPAN.pm's attempts to lock anything. You should be careful with
this since you might end up with multiple scripts trying to muck in the
same directory. This isn't so much of a concern if you're loading a special
-config with \f(CW\*(C`\-j\*(C'\fR, and that config sets up its own work directories.
+config with \f(CR\*(C`\-j\*(C'\fR, and that config sets up its own work directories.
.IP "\-g module [ module ... ]" 4
.IX Item "-g module [ module ... ]"
Downloads to the current directory the latest distribution of the module.
@@ -138,11 +139,11 @@ Download to the current directory the la
modules, unpack each distribution, and create a git repository for each
distribution.
.Sp
-If you want this feature, check out Yanick Champoux's \f(CW\*(C`Git::CPAN::Patch\*(C'\fR
+If you want this feature, check out Yanick Champoux's \f(CR\*(C`Git::CPAN::Patch\*(C'\fR
distribution.
.IP \-h 4
.IX Item "-h"
-Print a help message and exit. When you specify \f(CW\*(C`\-h\*(C'\fR, it ignores all
+Print a help message and exit. When you specify \f(CR\*(C`\-h\*(C'\fR, it ignores all
of the other options and arguments.
.IP "\-i module [ module ... ]" 4
.IX Item "-i module [ module ... ]"
@@ -150,13 +151,13 @@ Install the specified modules. With no o
is implied.
.IP \-I 4
.IX Item "-I"
-Load \f(CW\*(C`local::lib\*(C'\fR (think like \f(CW\*(C`\-I\*(C'\fR for loading lib paths). Too bad
-\&\f(CW\*(C`\-l\*(C'\fR was already taken.
+Load \f(CR\*(C`local::lib\*(C'\fR (think like \f(CR\*(C`\-I\*(C'\fR for loading lib paths). Too bad
+\&\f(CR\*(C`\-l\*(C'\fR was already taken.
.IP "\-j Config.pm" 4
.IX Item "-j Config.pm"
Load the file that has the CPAN configuration data. This should have the
same format as the standard \fICPAN/Config.pm\fR file, which defines
-\&\f(CW$CPAN::Config\fR as an anonymous hash.
+\&\f(CR$CPAN::Config\fR as an anonymous hash.
.IP \-J 4
.IX Item "-J"
Dump the configuration in the same format that CPAN.pm uses. This is useful
@@ -173,7 +174,7 @@ List the modules by the specified author
Make the specified modules.
.IP "\-M mirror1,mirror2,..." 4
.IX Item "-M mirror1,mirror2,..."
-A comma-separated list of mirrors to use for just this run. The \f(CW\*(C`\-P\*(C'\fR
+A comma-separated list of mirrors to use for just this run. The \f(CR\*(C`\-P\*(C'\fR
option can find them for you automatically.
.IP \-n 4
.IX Item "-n"
@@ -259,32 +260,34 @@ The build tools, ExtUtils::MakeMaker and
while others matter to the levels above them. Some of these are specified
by the Perl Toolchain Gang:
.PP
-Lancaster Consensus: <https://github.com/Perl\-Toolchain\-Gang/toolchain\-site/blob/master/lancaster\-consensus.md>
+Lancaster Consensus: <https://github.com/\:Perl\-Toolchain\-Gang/\
+\:toolchain\-site/\:blob/master/\:lancaster\-consensus.md>
.PP
-Oslo Consensus: <https://github.com/Perl\-Toolchain\-Gang/toolchain\-site/blob/master/oslo\-consensus.md>
+Oslo Consensus: <https://github.com/\:Perl\-Toolchain\-Gang/\
+\:toolchain\-site/\:blob/master/\:oslo\-consensus.md>
.IP NONINTERACTIVE_TESTING 4
.IX Item "NONINTERACTIVE_TESTING"
Assume no one is paying attention and skips prompts for distributions
-that do that correctly. \f(CWcpan(1)\fR sets this to \f(CW1\fR unless it already
+that do that correctly. \f(CRcpan(1)\fR sets this to \f(CR1\fR unless it already
has a value (even if that value is false).
.IP PERL_MM_USE_DEFAULT 4
.IX Item "PERL_MM_USE_DEFAULT"
-Use the default answer for a prompted questions. \f(CWcpan(1)\fR sets this
-to \f(CW1\fR unless it already has a value (even if that value is false).
+Use the default answer for a prompted questions. \f(CRcpan(1)\fR sets this
+to \f(CR1\fR unless it already has a value (even if that value is false).
.IP CPAN_OPTS 4
.IX Item "CPAN_OPTS"
-As with \f(CW\*(C`PERL5OPT\*(C'\fR, a string of additional \f(CWcpan(1)\fR options to
+As with \f(CR\*(C`PERL5OPT\*(C'\fR, a string of additional \f(CRcpan(1)\fR options to
add to those you specify on the command line.
.IP CPANSCRIPT_LOGLEVEL 4
.IX Item "CPANSCRIPT_LOGLEVEL"
The log level to use, with either the embedded, minimal logger or
Log::Log4perl if it is installed. Possible values are the same as
-the \f(CW\*(C`Log::Log4perl\*(C'\fR levels: \f(CW\*(C`TRACE\*(C'\fR, \f(CW\*(C`DEBUG\*(C'\fR, \f(CW\*(C`INFO\*(C'\fR, \f(CW\*(C`WARN\*(C'\fR,
-\&\f(CW\*(C`ERROR\*(C'\fR, and \f(CW\*(C`FATAL\*(C'\fR. The default is \f(CW\*(C`INFO\*(C'\fR.
+the \f(CR\*(C`Log::Log4perl\*(C'\fR levels: \f(CR\*(C`TRACE\*(C'\fR, \f(CR\*(C`DEBUG\*(C'\fR, \f(CR\*(C`INFO\*(C'\fR, \f(CR\*(C`WARN\*(C'\fR,
+\&\f(CR\*(C`ERROR\*(C'\fR, and \f(CR\*(C`FATAL\*(C'\fR. The default is \f(CR\*(C`INFO\*(C'\fR.
.IP GIT_COMMAND 4
.IX Item "GIT_COMMAND"
-The path to the \f(CW\*(C`git\*(C'\fR binary to use for the Git features. The default
-is \f(CW\*(C`/usr/local/bin/git\*(C'\fR.
+The path to the \f(CR\*(C`git\*(C'\fR binary to use for the Git features. The default
+is \f(CR\*(C`/usr/local/bin/git\*(C'\fR.
.SH "EXIT VALUES"
.IX Header "EXIT VALUES"
The script exits with zero if it thinks that everything worked, or a
@@ -332,9 +335,9 @@ Adam Kennedy pointed out that \fBexit()\
where this script ends up with a .bat extension
.SH AUTHOR
.IX Header "AUTHOR"
-brian d foy, \f(CW\*(C`<bdfoy at cpan.org>\*(C'\fR
+brian d foy, \f(CR\*(C`<bdfoy at cpan.org>\*(C'\fR
.SH COPYRIGHT
.IX Header "COPYRIGHT"
-Copyright (c) 2001\-2015, brian d foy, All Rights Reserved.
+Copyright (c) 2001\(en2015, brian d foy, All Rights Reserved.
.PP
You may redistribute this under the same terms as Perl itself.
More information about the Perl-maintainers
mailing list