Package: python3.13-minimal
Version: 3.13.11-1+b1
Severity: minor
Tags: patch

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.

-.-

  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?


Output from "test-nroff  -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":

an.tmac:<stdin>:174: warning: cannot nest .TP or .TQ inside .TP; supply a tag
an.tmac:<stdin>:274: misuse, warning: .IB is for at least 2 arguments, got 1
        Use macro '.I' for one argument or split the argument.
an.tmac:<stdin>:507: misuse, warning: .IB is for at least 2 arguments, got 1
        Use macro '.I' for one argument or split the argument.
an.tmac:<stdin>:512: misuse, warning: .IR is for at least 2 arguments, got 1
        Use macro '.I' for one argument or split the argument.
an.tmac:<stdin>:585: misuse, warning: .IB is for at least 2 arguments, got 1
        Use macro '.I' for one argument or split the argument.
an.tmac:<stdin>:587: misuse, warning: .IB is for at least 2 arguments, got 1
        Use macro '.I' for one argument or split the argument.
an.tmac:<stdin>:592: misuse, warning: .IR is for at least 2 arguments, got 1
        Use macro '.I' for one argument or split the argument.
an.tmac:<stdin>:602: misuse, warning: .IR is for at least 2 arguments, got 1
        Use macro '.I' for one argument or split the argument.
an.tmac:<stdin>:682: misuse, warning: .IB is for at least 2 arguments, got 1
        Use macro '.I' for one argument or split the argument.
an.tmac:<stdin>:689: misuse, warning: .IR is for at least 2 arguments, got 1
        Use macro '.I' for one argument or split the 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: forky/sid
  APT prefers testing
  APT policy: (500, 'testing')
Architecture: amd64 (x86_64)

Kernel: Linux 6.17.11+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 python3.13-minimal depends on:
ii  libc6                  2.42-5
ii  libexpat1              2.7.3-1
ii  libpython3.13-minimal  3.13.11-1+b1
ii  zlib1g                 1:1.3.dfsg+really1.3.1-1+b1

Versions of packages python3.13-minimal recommends:
ii  python3.13  3.13.11-1+b1

Versions of packages python3.13-minimal suggests:
ii  binfmt-support  2.2.2-8

-- no debconf information
Input file is python3.13.1

Output from "mandoc -T lint  python3.13.1": (shortened list)

      2 STYLE: input text line longer than 80 bytes: 
      1 WARNING: line scope broken: TP breaks TP
      1 WARNING: missing date, using "": TH
      5 WARNING: skipping paragraph macro: br before text line with leading 
blank

-.-.

Output from
test-nroff -mandoc -t -ww -z python3.13.1: (shortened list)

      9         Use macro '.I' for one argument or split the argument.
      5 .IB is for at least 2 arguments, got 1
      4 .IR is for at least 2 arguments, got 1
      1 cannot nest .TP or .TQ inside .TP; supply a tag

-.-.

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.

259:  -Wdefault  # Warn once per call location
260:  -Werror    # Convert to exceptions
261:  -Walways   # Warn every time
262:  -Wall      # Same as -Walways
263:  -Wmodule   # Warn once per calling module
264:  -Wonce     # Warn once per Python process
265:  -Wignore   # Never warn

-.-.

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 (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.
Add "\:" to split the string for the output, "\<newline>" in the source.  

[List of affected lines removed.]

Longest line is number 373 with 87 characters
    \fB\-X presite=\fIMOD\fR: import this module before site; also 
\fBPYTHON_PRESITE\fR

-.-.

Split a punctuation from a single argument, if a two-font macro is meant.

433:.I '\-c'.

-.-.

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.]

python3.13.1:122:semantics of the core language in (perhaps too) much detail.
python3.13.1:147:and comparing bytes/bytearray with str. (\-bb: issue errors)
python3.13.1:150:Specify the command to execute (see next section).
python3.13.1:257:emitted by a process (even those that are otherwise ignored by 
default):
python3.13.1:293:field matches the warning category (ex: "DeprecationWarning"). 
This must be a
python3.13.1:342:        cumulative time (including nested imports) and self 
time (excluding
python3.13.1:351:       The default is "on" (or "off" if you are running a 
local build).
python3.13.1:521:for non-debug builds (the normal case) and \fBoff\fR for debug 
builds.
python3.13.1:617:\fB\-s\fP option (Don't add the user site directory to 
sys.path).
python3.13.1:628:begins with ${prefix}/lib/python<version> (see PYTHONHOME 
above).

-.-.

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.

python3.13.1:1:.TH PYTHON "1"
python3.13.1:168:.B "\-\-help\-env"
python3.13.1:171:.B "\-\-help\-xoptions"
python3.13.1:175:.B "\-\-help\-all"
python3.13.1:583:.IB encodingname ":" errorhandler

-.-.

Put a (long) web address on a new output line to reduce the posibility of
splitting the address between two output lines.
Or inhibit hyphenation with "\%" in front of the name.


723:The Python Software Foundation: https://www.python.org/psf/
725:Main website:  https://www.python.org/
727:Documentation:  https://docs.python.org/
729:Developer resources:  https://devguide.python.org/
731:Downloads:  https://www.python.org/downloads/
733:Module repository:  https://pypi.org/

-.-.

Use just one space character after a colon

725:Main website:  https://www.python.org/
727:Documentation:  https://docs.python.org/
729:Developer resources:  https://devguide.python.org/
731:Downloads:  https://www.python.org/downloads/
733:Module repository:  https://pypi.org/
735:Newsgroups:  comp.lang.python, comp.lang.python.announce

-.-.

Output from "test-groff  -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":

an.tmac:<stdin>:174: warning: cannot nest .TP or .TQ inside .TP; supply a tag
an.tmac:<stdin>:274: misuse, warning: .IB is for at least 2 arguments, got 1
        Use macro '.I' for one argument or split the argument.
an.tmac:<stdin>:507: misuse, warning: .IB is for at least 2 arguments, got 1
        Use macro '.I' for one argument or split the argument.
an.tmac:<stdin>:512: misuse, warning: .IR is for at least 2 arguments, got 1
        Use macro '.I' for one argument or split the argument.
an.tmac:<stdin>:585: misuse, warning: .IB is for at least 2 arguments, got 1
        Use macro '.I' for one argument or split the argument.
an.tmac:<stdin>:587: misuse, warning: .IB is for at least 2 arguments, got 1
        Use macro '.I' for one argument or split the argument.
an.tmac:<stdin>:592: misuse, warning: .IR is for at least 2 arguments, got 1
        Use macro '.I' for one argument or split the argument.
an.tmac:<stdin>:602: misuse, warning: .IR is for at least 2 arguments, got 1
        Use macro '.I' for one argument or split the argument.
an.tmac:<stdin>:682: misuse, warning: .IB is for at least 2 arguments, got 1
        Use macro '.I' for one argument or split the argument.
an.tmac:<stdin>:689: misuse, warning: .IR is for at least 2 arguments, got 1
        Use macro '.I' for one argument or split the argument.

-.-

Generally:

Split (sometimes) lines after a punctuation mark; before a conjunction.
--- python3.13.1        2025-12-16 18:13:15.620712906 +0000
+++ python3.13.1.new    2025-12-16 18:38:39.751769945 +0000
@@ -1,4 +1,4 @@
-.TH PYTHON "1"
+.TH PYTHON 1
 
 .\" To view this file while editing, run it through groff:
 .\"   groff -Tascii -man python.man | less
@@ -165,14 +165,13 @@ the behavior of the interpreter.
 .B \-h ", " \-? ", "\-\-help
 Prints the usage for the interpreter executable and exits.
 .TP
-.B "\-\-help\-env"
+.B \-\-help\-env
 Prints help about Python-specific environment variables and exits.
 .TP
-.B "\-\-help\-xoptions"
+.B \-\-help\-xoptions
 Prints help about implementation-specific \fB\-X\fP options and exits.
 .TP
-.TP
-.B "\-\-help\-all"
+.B \-\-help\-all
 Prints complete usage information and exits.
 .TP
 .B \-i
@@ -256,13 +255,13 @@ to
 The simplest settings apply a particular action unconditionally to all warnings
 emitted by a process (even those that are otherwise ignored by default):
 
-  -Wdefault  # Warn once per call location
-  -Werror    # Convert to exceptions
-  -Walways   # Warn every time
-  -Wall      # Same as -Walways
-  -Wmodule   # Warn once per calling module
-  -Wonce     # Warn once per Python process
-  -Wignore   # Never warn
+  \-Wdefault  # Warn once per call location
+  \-Werror    # Convert to exceptions
+  \-Walways   # Warn every time
+  \-Wall      # Same as -Walways
+  \-Wmodule   # Warn once per calling module
+  \-Wonce     # Warn once per Python process
+  \-Wignore   # Never warn
 
 The action names can be abbreviated as desired and the interpreter will resolve
 them to the appropriate action name. For example,
@@ -271,7 +270,7 @@ is the same as
 .B \-Wignore .
 
 The full form of argument is:
-.IB action:message:category:module:lineno
+.IB action : message : category : module : lineno
 
 Empty fields match all values; trailing empty fields may be omitted. For
 example
@@ -430,7 +429,7 @@ is an empty string; if
 is used,
 .I sys.argv[0]
 contains the string
-.I '\-c'.
+.RI ' \-c '.
 Note that options interpreted by the Python interpreter itself
 are not placed in
 .IR sys.argv .
@@ -504,12 +503,12 @@ the \fB\-d\fP option. If set to an integ
 specifying \fB\-d\fP multiple times.
 .IP PYTHONEXECUTABLE
 If this environment variable is set,
-.IB sys.argv[0]
+.I sys.argv[0]
 will be set to its value instead of the value got through the C runtime. Only
 works on Mac OS X.
 .IP PYTHONFAULTHANDLER
 If this environment variable is set to a non-empty string,
-.IR faulthandler.enable()
+.I faulthandler.enable()
 is called at startup: install a handler for SIGSEGV, SIGFPE, SIGABRT, SIGBUS
 and SIGILL signals to dump the Python traceback.
 .IP
@@ -580,16 +579,16 @@ This is equivalent to the \fB\-X int_max
 .IP PYTHONIOENCODING
 If this is set before running the interpreter, it overrides the encoding used
 for stdin/stdout/stderr, in the syntax
-.IB encodingname ":" errorhandler
+.IB encodingname : errorhandler
 The
-.IB errorhandler
+.I errorhandler
 part is optional and has the same meaning as in str.encode. For stderr, the
-.IB errorhandler
+.I errorhandler
 part is ignored; the handler will always be \'backslashreplace\'.
 .IP PYTHONMALLOC
 Set the Python memory allocators and/or install debug hooks. The available
 memory allocators are
-.IR malloc
+.I malloc
 and
 .IR pymalloc .
 The available debug hooks are
@@ -599,7 +598,7 @@ and
 .IR pymalloc_debug .
 .IP
 When Python is compiled in debug mode, the default is
-.IR pymalloc_debug
+.I pymalloc_debug
 and the debug hooks are automatically used. Otherwise, the default is
 .IR pymalloc .
 .IP PYTHONMALLOCSTATS
@@ -679,14 +678,14 @@ Python memory allocations using the trac
 .IP
 The value of the variable is the maximum number of frames stored in a
 traceback of a trace. For example,
-.IB PYTHONTRACEMALLOC=1
+.I PYTHONTRACEMALLOC=1
 stores only the most recent frame.
 .IP PYTHONUNBUFFERED
 If this is set to a non-empty string it is equivalent to specifying
 the \fB\-u\fP option.
 .IP PYTHONUSERBASE
 Defines the user base directory, which is used to compute the path of the user
-.IR site\-packages
+.I site\-packages
 directory and installation paths for
 .IR "python \-m pip install \-\-user" .
 .IP PYTHONUTF8
@@ -722,17 +721,17 @@ This is equivalent to the \fB\-X presite
 .SH AUTHOR
 The Python Software Foundation: https://www.python.org/psf/
 .SH INTERNET RESOURCES
-Main website:  https://www.python.org/
+Main website: https://www.python.org/
 .br
-Documentation:  https://docs.python.org/
+Documentation: https://docs.python.org/
 .br
-Developer resources:  https://devguide.python.org/
+Developer resources: https://devguide.python.org/
 .br
-Downloads:  https://www.python.org/downloads/
+Downloads: https://www.python.org/downloads/
 .br
-Module repository:  https://pypi.org/
+Module repository: https://pypi.org/
 .br
-Newsgroups:  comp.lang.python, comp.lang.python.announce
+Newsgroups: comp.lang.python, comp.lang.python.announce
 .SH LICENSING
 Python is distributed under an Open Source license.  See the file
 "LICENSE" in the Python source distribution for information on terms &
  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 trailing space 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)

-.-

Reply via email to