Package: python3-virtualenv
Version: 20.28.0+ds-1
Severity: minor
Tags: upstream
* 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 ' $' <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 third argument; consider document
modification date in ISO 8601 format (YYYY-MM-DD)
an.tmac:<stdin>:1: style: .TH missing fourth argument; consider package/project
name and version (e.g., "groff 1.23.0")
troff:<stdin>:79: warning: trailing space in the 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.9-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-virtualenv depends on:
ii python3 3.12.8-1
ii python3-distlib 0.3.9-1
ii python3-filelock 3.16.1-1
ii python3-pip-whl 24.3.1+dfsg-1
ii python3-platformdirs 4.3.6-1
ii python3-setuptools-whl 75.6.0-1
ii python3-wheel-whl 0.45.1-1
Versions of packages python3-virtualenv recommends:
pn build-essential <none>
ii ca-certificates 20241223
ii python3-dev 3.12.8-1
python3-virtualenv suggests no packages.
-- no debconf information
Input file is virtualenv.1
Output from "mandoc -T lint virtualenv.1": (shortened list)
1 input text line longer than 80 bytes: The virtualenv utili...
1 input text line longer than 80 bytes: This man-page was cr...
1 input text line longer than 80 bytes: a path containing wh...
1 input text line longer than 80 bytes: activators to genera...
1 input text line longer than 80 bytes: config file $HOME/.c...
1 input text line longer than 80 bytes: give the virtual env...
1 input text line longer than 80 bytes: pass to disable down...
1 input text line longer than 80 bytes: pass to enable downl...
1 input text line longer than 80 bytes: remove the destinati...
1 input text line longer than 80 bytes: symlink the python p...
1 input text line longer than 80 bytes: target interpreter f...
1 input text line longer than 80 bytes: try to use copies ra...
1 input text line longer than 80 bytes: try to use symlinks ...
1 input text line longer than 80 bytes: verbosity = verbose ...
1 missing date, using "": TH
1 skipping paragraph macro: PP after SH
1 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z virtualenv.1": (shortened list)
1 trailing space in the line
-.-.
Show if help2man generated this.
Who is actually generating this man page? Debian or upstream?
Is the generating software out of date?
120:This man-page was created using help2man and then updated by Scott
Kitterman <sc...@kitterman.com> and is licensed under the same terms as
virtualenv.
-.-.
Remove space characters (whitespace) at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
Number of lines affected is
1
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
virtualenv.1:19:on failure also display the stacktrace internals of virtualenv
(default: False)
virtualenv.1:22:a data folder used as cache by the virtualenv (default: <temp
folder>)
virtualenv.1:25:start with empty app data folder (default: False)
virtualenv.1:34:increase verbosity (default: 2)
virtualenv.1:37:decrease verbosity (default: 0)
virtualenv.1:43:interpreter discovery method (default: builtin)
virtualenv.1:46:target interpreter for which to create a virtual (either
absolute path or identifier string) (default: \fI\,/usr/bin/python3\/\fP)
virtualenv.1:52:create environment via (builtin = cpython3\-posix) (default:
builtin)
virtualenv.1:58:remove the destination directory if exist before starting (will
overwrite files otherwise) (default: False)
virtualenv.1:61:give the virtual environment access to the system
site\-packages dir (default: False)
virtualenv.1:64:try to use symlinks rather than copies, when symlinks are not
the default for the platform (default: True)
virtualenv.1:67:try to use copies rather than symlinks, even when symlinks are
the default for the platform (default: False)
virtualenv.1:73:seed packages install method (default: app\-data)
virtualenv.1:76:do not install seed packages (default: False)
virtualenv.1:79:pass to enable download of the latest pip, setuptools, and
wheel from PyPI (default: False)
virtualenv.1:82:pass to disable download of the latest pip, setuptools, and
wheel from PyPI (default: True)
virtualenv.1:85:a path containing wheels the seeder may also use beside bundled
(can be set 1+ times) (default: [])
virtualenv.1:88:pip version to install, bundle for bundled (default: latest)
virtualenv.1:91:setuptools version to install, bundle for bundled (default:
latest)
virtualenv.1:94:wheel version to install, bundle for bundled (default: latest)
virtualenv.1:97:do not install pip (default: False)
virtualenv.1:100:do not install setuptools (default: False)
virtualenv.1:103:do not install wheel (default: False)
virtualenv.1:106:symlink the python packages from the app-data folder (requires
seed pip>=19.3) (default: False)
virtualenv.1:112:activators to generate \- default is all supported (default:
bash,cshell,fish,powershell,python,xonsh)
virtualenv.1:115:provides an alternative prompt prefix for this environment
(default: None)
virtualenv.1:117:config file $HOME/.config/virtualenv/virtualenv.ini (change
via env var VIRTUALENV_CONFIG_FILE)
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:1: style: .TH missing third argument; consider document
modification date in ISO 8601 format (YYYY-MM-DD)
an.tmac:<stdin>:1: style: .TH missing fourth argument; consider package/project
name and version (e.g., "groff 1.23.0")
troff:<stdin>:79: warning: trailing space in the 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.
There is no need to add a '\&' before a full stop (.) if it has a character
before it!
'\&' is only needed at the beginning of a line, if it otherwise starts with
a control character "." or "'".
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.
Not beginning each input sentence on a new line.
Line length 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 -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 -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)
-.-
