clang-22.1: Some remarks and a patch with editorial changes for this man page
Bjarni Ingi Gislason
bjarniig at simnet.is
Tue Jun 9 21:40:53 BST 2026
Package: clang-22
Version: 1:22.1.6-1
Severity: minor
Tags: patch
Additional remarks.
Mails from me to "submit at bugs.debian.org" are no longer acknowledged. A
Debian maintainer told me, that he would contact the mail administrator
about me not wanting to send bugs upstream.
-.-
Dear Maintainer,
>From "/usr/share/doc/debian/bug-reporting.txt.gz":
Don't file bugs upstream
If you file a bug in Debian, don't send a copy to the upstream software
maintainers yourself, as it is possible that the bug exists only in
Debian. If necessary, the maintainer of the package will forward the
bug upstream.
-.-
For forwarding bug reports to upstream see:
https://www.debian.org/Bugs/Developer#forward
-.-
"Handling bug reports" in
http://people.debian.org/~enrico/dcg/ch03s02.html
-.-
I do not send reports upstream if I have to get an account there.
The Debian maintainers have one already.
If I get a negative (or no) response from upstream, I send henceforth
bugs to Debian.
-.-
* 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=0 -ww -z < "man page"
[Use
grep -n -e ' $' -e '\\~$' -e ' \\f.$' -e ' \\"' <file>
to find (most) 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?
-mandoc -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z
* 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: forky/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 7.0.10+deb14-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 clang-22 depends on:
ii binutils 2.46-3
ii libc6 2.42-16
ii libc6-dev 2.42-16
ii libclang-common-22-dev 1:22.1.6-1
ii libclang-cpp22 1:22.1.6-1
ii libclang1-22 1:22.1.6-1
ii libgcc-15-dev 15.2.0-17
ii libgcc-s1 16.1.0-1
ii libllvm22 1:22.1.6-1
ii libobjc-15-dev 15.2.0-17
ii libstdc++-15-dev 15.2.0-17
ii libstdc++6 16.1.0-1
ii llvm-22-linker-tools 1:22.1.6-1
Versions of packages clang-22 recommends:
ii clang-tools-22 1:22.1.6-1
pn llvm-22-dev <none>
ii python3 3.13.9-3+b1
Versions of packages clang-22 suggests:
ii clang-22-doc 1:22.1.6-1
pn wasi-libc <none>
-- no debconf information
-------------- next part --------------
Input file is clang-22.1
Output from "mandoc -T lint clang-22.1": (shortened list)
10 STYLE: input text line longer than 80 bytes
4 STYLE: input text line longer than 80 bytes:
5 WARNING: skipping paragraph macro
-.-.
Output from
test-mandoc -Kutf8 -ww -z clang-22.1: (shortened list)
1 register 'an-margin' not defined [-w reg]
-.-.
Show if generated from reStructuredText or rd2
A patch to a generated man page is to show where the generator
failed to make a "clean" man page rendering (that is without warnings) and
sometimes to show a better format for it.
Generated files create bigger and more difficult to read/check patches
when the generator creats long lines, instead of shorter ones or by
postprocesing its output in such a way.
1:.\" Man page generated from reStructuredText
Latest version: docutils (Docutils 0.22.4, Python 3.13.12, on linux)
-.-.
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.
'-' is rendered as a hyphen (u2010) in UTF-8 encoding.
clang-22.1:1047:2007-2026, The Clang Team
-.-.
Wrong distance (not two spaces, not a new line character (\n)) 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 (fill completely
an A4 sized page line on a terminal)
into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
[List of affected lines removed.]
Longest line is number 940 with 257 characters
.B \-fshow\-column, \-fshow\-source\-location, \-fcaret\-diagnostics, \-fdiagnostics\-fixit\-info, \-fdiagnostics\-parseable\-fixits, \-fdiagnostics\-print\-source\-range\-info, \-fprint\-source\-range\-info, \-fdiagnostics\-show\-option, \-fmessage\-length
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
[List of affected lines removed.]
-.-
No need for '\&' to be in front of a period (.),
if there is a character in front of it.
Remove with "sed -e 's/\(.\)\\&\./\1./g'".
19 lines are with such a use.
-.-.
Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).
[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.
clang-22.1:31:.TH "CLANG" "1" "May 19, 2026" "15" "Clang"
-.-.
Use "\-" instead of "-" (rendered as a hyphen (u2010) in UTF-8 encoding)
in web addresses.
92:the same driver. Please see <\%<https://\:clang-analyzer\:.llvm\:.org>> for more details
1038:To report bugs, please visit <\%<https://\:github\:.com/\:llvm/\:llvm-project/\:issues/>>. Most bug reports should
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
-.-
Tables:
Use the preprocessor 'tbl' to make tables.
Put data, that are wider than the header in the (centered) last column,
in a "T{...\nT}" block(, when the table gets wider than the output line).
Table headings, that are wider than any data in the corresponding
column, do not need to be centered, so left adjustment (l, L) is
sufficient.
-------------- next part --------------
--- clang-22.1 2026-06-09 20:11:21.999278827 +0000
+++ clang-22.1.new 2026-06-09 20:29:43.011493276 +0000
@@ -28,14 +28,12 @@ level margin: \\n[rst2man-indent\\n[rst2
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "CLANG" "1" "May 19, 2026" "15" "Clang"
+.TH CLANG 1 "May 19, 2026" 15 Clang
.SH NAME
clang \- the Clang C, C++, and Objective-C compiler
.SH SYNOPSIS
-.sp
\fBclang\fP [\fIoptions\fP] \fIfilename ???\fP
.SH DESCRIPTION
-.sp
\fBclang\fP is a C, C++, and Objective\-C compiler which encompasses
preprocessing, parsing, optimization, code generation, assembly, and linking.
Depending on which high\-level mode setting is passed, Clang will stop before
@@ -89,7 +87,7 @@ an ???a.out???, ???.dylib??? or ???.so??
.sp
The Clang Static Analyzer is a tool that scans source code to try to find bugs
through code analysis. This tool uses many parts of Clang and is built into
-the same driver. Please see <\%<https://\:clang-analyzer\:.llvm\:.org>> for more details
+the same driver. Please see <\%<https://\:clang\-analyzer\:.llvm\:.org>> for more details
on how to use the static analyzer.
.SH OPTIONS
.SS Stage Selection Options
@@ -595,7 +593,6 @@ Enable use of the Objective\-C non\-frag
the default ABI, it can be disabled with \fB\-fno\-objc\-nonfragile\-abi\fP\&.
.UNINDENT
.SS Target Selection Options
-.sp
Clang fully supports cross compilation as an inherent part of its design.
Depending on how your version of Clang is configured, it may have support for a
number of cross compilers, or may only support a native target.
@@ -1034,15 +1031,13 @@ paths to be used when processing the cor
delimited as for the \fBCPATH\fP environment variable.
.UNINDENT
.SH BUGS
-.sp
-To report bugs, please visit <\%<https://\:github\:.com/\:llvm/\:llvm-project/\:issues/>>. Most bug reports should
+To report bugs, please visit <\%<https://\:github\:.com/\:llvm/\:llvm\-project/\:issues/>>. Most bug reports should
include preprocessed source files (use the \fB\-E\fP option) and the full
output of the compiler, along with information to reproduce.
.SH SEE ALSO
-.sp
\fBas(1)\fP, \fBld(1)\fP
.SH Author
Maintained by the Clang / LLVM Team (<http://clang.llvm.org>)
.SH Copyright
-2007-2026, The Clang Team
+2007\(en2026, The Clang Team
.\" End of generated man page.
-------------- next part --------------
Check the output from "lintian" in the Debian distribution.
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>
To find most trailing spaces use
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
The same goes for man pages that are used as an input.
-.-
For a style guide use
mandoc -T lint
-.-
For general input conventions consult the man page "nroff(7)" (item
"Input conventions") or the Texinfo manual about the same item.
-.-
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 when that has been fixed.
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)
-.-
-------------- next part --------------
An embedded message was scrubbed...
From: unknown sender
Subject: clean files of trailing whitespace
Date: no date
Size: 488
URL: <http://alioth-lists.debian.net/pipermail/pkg-llvm-team/attachments/20260609/4f301d3f/attachment-0001.eml>
More information about the Pkg-llvm-team
mailing list