--- Begin Message ---
Package: libpython3.13-dev
Version: 3.13.2-2
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 "grep -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?
an.tmac:<stdin>:1: style: .TH missing fourth argument; consider package/project
name and version (e.g., "groff 1.23.0")
an.tmac:<stdin>:5: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:7: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:10: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:13: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:16: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:19: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:22: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:25: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:28: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:31: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:40: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:43: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:46: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:49: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:52: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:55: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:58: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:61: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:64: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
* 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.20-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 libpython3.13-dev depends on:
ii libexpat1-dev 2.7.1-1
ii libpython3.13 3.13.2-2
ii libpython3.13-stdlib 3.13.2-2
ii zlib1g-dev 1:1.3.dfsg+really1.3.1-1+b1
Versions of packages libpython3.13-dev recommends:
ii libc6-dev [libc-dev] 2.41-6
libpython3.13-dev suggests no packages.
-- no debconf information
Input file is x86_64-linux-gnu-python3.13-config.1
Output from "mandoc -T lint x86_64-linux-gnu-python3.13-config.1": (shortened
list)
1 input text line longer than 80 bytes: gcc $(python\-config...
1 input text line longer than 80 bytes: print the prefix use...
1 input text line longer than 80 bytes: similar to \fI\-\-cf...
1 skipping paragraph macro: PP empty
1 skipping paragraph macro: sp after PP
-.-.
Output from "test-nroff -mandoc -t -ww -z
x86_64-linux-gnu-python3.13-config.1": (shortened list)
19 Use macro '.B' for one argument or split argument.
19 .BI is for at least 2 arguments, got 1
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
5:.BI "python\-config"
7:.BI "\-\-prefix"
10:.BI "\-\-exec\-prefix"
13:.BI "\-\-includes"
16:.BI "\-\-libs"
19:.BI "\-\-cflags"
22:.BI "\-\-ldflags"
25:.BI "\-\-extension\-suffix"
28:.BI "\-\-abiflags"
31:.BI "\-\-help"
40:.BI "\-\-abiflags"
43:.BI "\-\-cflags"
46:.BI "\-\-ldflags"
49:.BI "\-\-includes"
52:.BI "\-\-libs"
55:.BI "\-\-prefix"
58:.BI "\-\-exec\-prefix"
61:.BI "\-\-extension\-suffix"
64:.BI "\-\-help"
-.-.
Find a repeated word
! 41 --> the
-.-.
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.
Line 50, length 84
similar to \fI\-\-cflags\fP but only with \-I options (path to python header
files).
Line 59, length 82
print the prefix used for executable program directories (such as bin, sbin,
etc).
Line 90, length 83
gcc $(python\-config \-\-cflags \-\-ldflags) \-shared \-fPIC progr.cpp \-o
progr.so
Longest line is number 50 with 84 characters
-.-.
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.]
x86_64-linux-gnu-python3.13-config.1:36:extension modules that can be loaded
dynamically (at run time) into
x86_64-linux-gnu-python3.13-config.1:50:similar to \fI\-\-cflags\fP but only
with \-I options (path to python header files).
x86_64-linux-gnu-python3.13-config.1:53:similar to \fI\-\-ldflags\fP but only
with \-l options (used libraries).
x86_64-linux-gnu-python3.13-config.1:56:prints the prefix (base directory)
under which python can be found.
x86_64-linux-gnu-python3.13-config.1:59:print the prefix used for executable
program directories (such as bin, sbin, etc).
-.-.
Put a subordinate sentence (after a comma) on a new line.
x86_64-linux-gnu-python3.13-config.1:35:helps compiling and linking programs,
which embed the Python interpreter, or
x86_64-linux-gnu-python3.13-config.1:59:print the prefix used for executable
program directories (such as bin, sbin, etc).
-.-.
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.
x86_64-linux-gnu-python3.13-config.1:5:.BI "python\-config"
x86_64-linux-gnu-python3.13-config.1:7:.BI "\-\-prefix"
x86_64-linux-gnu-python3.13-config.1:10:.BI "\-\-exec\-prefix"
x86_64-linux-gnu-python3.13-config.1:13:.BI "\-\-includes"
x86_64-linux-gnu-python3.13-config.1:16:.BI "\-\-libs"
x86_64-linux-gnu-python3.13-config.1:19:.BI "\-\-cflags"
x86_64-linux-gnu-python3.13-config.1:22:.BI "\-\-ldflags"
x86_64-linux-gnu-python3.13-config.1:25:.BI "\-\-extension\-suffix"
x86_64-linux-gnu-python3.13-config.1:28:.BI "\-\-abiflags"
x86_64-linux-gnu-python3.13-config.1:31:.BI "\-\-help"
x86_64-linux-gnu-python3.13-config.1:40:.BI "\-\-abiflags"
x86_64-linux-gnu-python3.13-config.1:43:.BI "\-\-cflags"
x86_64-linux-gnu-python3.13-config.1:46:.BI "\-\-ldflags"
x86_64-linux-gnu-python3.13-config.1:49:.BI "\-\-includes"
x86_64-linux-gnu-python3.13-config.1:52:.BI "\-\-libs"
x86_64-linux-gnu-python3.13-config.1:55:.BI "\-\-prefix"
x86_64-linux-gnu-python3.13-config.1:58:.BI "\-\-exec\-prefix"
x86_64-linux-gnu-python3.13-config.1:61:.BI "\-\-extension\-suffix"
x86_64-linux-gnu-python3.13-config.1:64:.BI "\-\-help"
-.-.
Section headings (.SH and .SS) do not need quoting their arguments.
93:.SH "SEE ALSO"
-.-.
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.
96:http://docs.python.org/extending/extending.html
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:1: style: .TH missing fourth argument; consider package/project
name and version (e.g., "groff 1.23.0")
an.tmac:<stdin>:5: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:7: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:10: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:13: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:16: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:19: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:22: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:25: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:28: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:31: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:40: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:43: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:46: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:49: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:52: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:55: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:58: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:61: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:64: misuse, warning: .BI is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- x86_64-linux-gnu-python3.13-config.1 2025-04-01 02:49:00.467230489
+0000
+++ x86_64-linux-gnu-python3.13-config.1.new 2025-04-01 08:38:37.894547008
+0000
@@ -2,33 +2,33 @@
.SH NAME
python\-config \- output build options for python C/C++ extensions or embedding
.SH SYNOPSIS
-.BI "python\-config"
+.B python\-config
[
-.BI "\-\-prefix"
+.B \-\-prefix
]
[
-.BI "\-\-exec\-prefix"
+.B \-\-exec\-prefix
]
[
-.BI "\-\-includes"
+.B \-\-includes
]
[
-.BI "\-\-libs"
+.B \-\-libs
]
[
-.BI "\-\-cflags"
+.B \-\-cflags
]
[
-.BI "\-\-ldflags"
+.B \-\-ldflags
]
[
-.BI "\-\-extension\-suffix"
+.B \-\-extension\-suffix
]
[
-.BI "\-\-abiflags"
+.B \-\-abiflags
]
[
-.BI "\-\-help"
+.B \-\-help
]
.SH DESCRIPTION
.B python\-config
@@ -37,34 +37,36 @@ extension modules that can be loaded dyn
the interpreter.
.SH OPTIONS
.TP
-.BI "\-\-abiflags"
+.B \-\-abiflags
print the the ABI flags as specified by PEP 3149.
.TP
-.BI "\-\-cflags"
+.B \-\-cflags
print the C compiler flags.
.TP
-.BI "\-\-ldflags"
+.B \-\-ldflags
print the flags that should be passed to the linker.
.TP
-.BI "\-\-includes"
-similar to \fI\-\-cflags\fP but only with \-I options (path to python header
files).
-.TP
-.BI "\-\-libs"
-similar to \fI\-\-ldflags\fP but only with \-l options (used libraries).
+.B \-\-includes
+similar to \fI\-\-cflags\fP but only with \-I options
+(path to python header files).
+.TP
+.B \-\-libs
+similar to \fI\-\-ldflags\fP but only with \-l options
+(used libraries).
.TP
-.BI "\-\-prefix"
+.B \-\-prefix
prints the prefix (base directory) under which python can be found.
.TP
-.BI "\-\-exec\-prefix"
-print the prefix used for executable program directories (such as bin, sbin,
etc).
+.B \-\-exec\-prefix
+print the prefix used for executable program directories
+(such as bin, sbin, etc).
.TP
-.BI "\-\-extension\-suffix"
+.B \-\-extension\-suffix
print the extension suffix used for binary extensions.
.TP
-.BI "\-\-help"
+.B \-\-help
print the usage message.
-.PP
-
+.
.SH EXAMPLES
To build the singe\-file c program \fIprog\fP against the python library, use
.PP
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)
-.-
--- End Message ---
pgpV7cTFBwy5w.pgp
