Package: git-man
Version: 1:2.47.2-0.1
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 ' $' -e '\\~$' <file>" to find obvious 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>:260: warning [page 3, line 23]: 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.12.17-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)
-- no debconf information
Input file is git-imap-send.1
Output from "mandoc -T lint git-imap-send.1": (shortened list)
2 input text line longer than 80 bytes: A boolean to enable/...
1 input text line longer than 80 bytes: An integer port numb...
1 input text line longer than 80 bytes: Command used to set ...
1 input text line longer than 80 bytes: Everything above thi...
1 input text line longer than 80 bytes: If your Gmail accoun...
1 input text line longer than 80 bytes: It is still your res...
1 input text line longer than 80 bytes: Just make sure to di...
1 input text line longer than 80 bytes: Specify the authenti...
1 input text line longer than 80 bytes: Talk to the IMAP ser...
1 input text line longer than 80 bytes: The folder to drop t...
1 input text line longer than 80 bytes: This command uploads...
1 input text line longer than 80 bytes: Thunderbird in parti...
1 input text line longer than 80 bytes: To use the tool, \fB...
1 input text line longer than 80 bytes: Use libcurl to commu...
1 input text line longer than 80 bytes: You may want to use ...
1 input text line longer than 80 bytes: You might need to in...
1 input text line longer than 80 bytes: prefix for secure co...
1 skipping paragraph macro: PP after SH
3 skipping paragraph macro: br after br
3 skipping paragraph macro: br before sp
7 skipping paragraph macro: sp after SH
-.-.
Output from "test-nroff -mandoc -t -ww -z git-imap-send.1": (shortened list)
1 cannot break line
-.-.
Show if docman-to-man created this.
Who is actually creating this man page? Debian or upstream?
Is the generating software out of date?
3:.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4:.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.-.
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 URL (web address)
260 Thunderbird in particular is known to be problematic\&. Thunderbird users may wish to visit this web page for more information: \m[blue]\fBhttps://kb\&.mozillazine\&.org/Plain_text_e\-mail_\-_Thunderbird#Completely_plain_email\fR\m[]
-.-.
Wrong distance (not two spaces) 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 final abbreviation point as such by suffixing it with "\&".
Some sentences (etc.) do not begin on a new line.
Split (sometimes) lines after a punctuation mark; before a conjunction.
Lines with only one (or two) space(s) between sentences could be split,
so latter sentences begin on a new line.
Use
#!/usr/bin/sh
sed -e '/^\./n' \
-e 's/\([[:alpha:]]\)\. */\1.\n/g' $1
to split lines after a sentence period.
Check result with the difference between the formatted outputs.
See also the attachment "general.bugs"
[List of affected lines removed.]
-.-.
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.
Add "\:" to split the string for the output, "\<newline>" in the source.
[List of affected lines removed.]
-.-.
The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).
263:\fBgit-format-patch\fR(1), \fBgit-send-email\fR(1), mbox(5)
-.-.
Add a zero (0) in front of a decimal fraction that begins with a period
(.)
191:.sp .5v
224:.sp .5v
240:.sp .5v
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
git-imap-send.1:190:You may want to use \fBsslVerify=false\fR while troubleshooting, if you suspect that the reason you are having trouble connecting is because the certificate you use at the private server \fBexample\&.com\fR you are trying to set up (or have set up) may not be verified correctly\&.
git-imap-send.1:255:Just make sure to disable line wrapping in the email client (Gmail\(cqs web interface will wrap lines no matter what, so you need to use a real IMAP client)\&.
git-imap-send.1:258:It is still your responsibility to make sure that the email message sent by your email program meets the standards of your project\&. Many projects do not like patches to be attached\&. Some mail agents will transform patches (e\&.g\&. wrap lines, send them as format=flowed) in ways that make them fail\&. You will get angry flames ridiculing you if you don\(cqt check this\&.
-.-.
No need for '\&' to be in front of a period (.),
if there is a character in front of it.
Remove with "sed -e 's/\\&\././g'".
[List of affected lines removed.]
-,-
One space only after a possible end of sentence
(after a punctuation, that
can end a sentence).
[List of affected lines removed.]
-.-
Put a subordinate sentence (after a comma) on a new line.
[List of affected lines removed.]
-.-.
Remove quotes when there is a printable
but no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.
git-imap-send.1:10:.TH "GIT\-IMAP\-SEND" "1" "01/19/2025" "Git 2\&.47\&.2" "Git Manual"
git-imap-send.1:30:.SH "NAME"
git-imap-send.1:32:.SH "SYNOPSIS"
git-imap-send.1:38:.SH "DESCRIPTION"
git-imap-send.1:45:.SH "OPTIONS"
git-imap-send.1:66:.SH "CONFIGURATION"
git-imap-send.1:127:.SH "EXAMPLES"
git-imap-send.1:256:.SH "CAUTION"
git-imap-send.1:264:.SH "GIT"
-.-.
Use ".na" (no adjustment) instead of ".ad l" (and ".ad" to begin the
same adjustment again as before).
26:.ad l
-.-.
Put a (long) web address on a new line to reduce the posibility of
splitting the address between two output lines.
Or inhibit hyphenation with "\%" in front of the name.
260:Thunderbird in particular is known to be problematic\&. Thunderbird users may wish to visit this web page for more information: \m[blue]\fBhttps://kb\&.mozillazine\&.org/Plain_text_e\-mail_\-_Thunderbird#Completely_plain_email\fR\m[]
-.-.
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ":
troff:<stdin>:260: warning [page 3, line 23]: cannot break line
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- git-imap-send.1 2025-03-13 18:30:08.296097490 +0000
+++ git-imap-send.1.new 2025-03-13 18:49:12.211871441 +0000
@@ -257,7 +257,10 @@ Just make sure to disable line wrapping
.sp
It is still your responsibility to make sure that the email message sent by your email program meets the standards of your project\&. Many projects do not like patches to be attached\&. Some mail agents will transform patches (e\&.g\&. wrap lines, send them as format=flowed) in ways that make them fail\&. You will get angry flames ridiculing you if you don\(cqt check this\&.
.sp
-Thunderbird in particular is known to be problematic\&. Thunderbird users may wish to visit this web page for more information: \m[blue]\fBhttps://kb\&.mozillazine\&.org/Plain_text_e\-mail_\-_Thunderbird#Completely_plain_email\fR\m[]
+Thunderbird in particular is known to be problematic.
+Thunderbird users may wish to visit this web page for more information:
+.br
+\m[blue]\fBhttps://kb.mozillazine.org/\:Plain_text_e\-mail_\-_Thunderbird#\:Completely_plain_email\fR\m[]
.SH "SEE ALSO"
.sp
\fBgit-format-patch\fR(1), \fBgit-send-email\fR(1), mbox(5)
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
-.-
Any "autogenerator" should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
It should also check its input files for too long (> 80) lines.
This is just a simple quality control measure.
The "autogenerator" may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Not removing trailing spaces (in in- and output).
The reason for these trailing spaces should be found and eliminated.
"git" has a "tool" to point out whitespace,
see for example "git-apply(1)" and git-config(1)")
Not beginning each input sentence on a new line.
Line length and patch size should thus be reduced.
The script "reportbug" uses 'quoted-printable' encoding when a line is
longer than 1024 characters in an 'ascii' file.
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 -d -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 from 'diff -d -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)
-.-
