- Package:
- python3-docutils
- Source:
- python3-docutils
- Submitter:
- Alejandro Colomar
- Date:
- 2023-01-21 19:45:09 UTC
- Severity:
- normal
- Tags:
Hi, When rst2man has no information to generate the 5th field to the .TH macro (the one that sets the title line, i.e., the header and footer of the manual page), it generates it as an empty argument, that is "". groff(1) and mandoc(1) have good defaults for the 5th field of .TH when it is not specified, so that most manual pages should need to specify it, but to use that default, the field has to be missing, and an empty argument is an existing argument. I'll show an example, which may be more explicative: $ cat th1.man .TH title 7 1234-04-05 foo-1.0 fifth $ man -P cat ./th1.man title(7) fifth title(7) foo‐1.0 1234‐04‐05 title(7) $ cat th2.man .TH title 7 1234-04-05 foo-1.0 "" $ man -P cat ./th2.man title(7) title(7) foo‐1.0 1234‐04‐05 title(7) $ cat th3.man .TH title 7 1234-04-05 foo-1.0 $ man -P cat ./th3.man title(7) Miscellaneous Information Manual title(7) foo‐1.0 1234‐04‐05 title(7) So, please remove that "" and just use 4 fields if there's no information for filling it. Cheers, Alex
s/should/shouldn't/
Hi Alejandro! Regarding this bug, upstream wants to know [1] whether omitting the 5th argument will work with all troff/manpage writers. I believe it is the case, but can you confirm? [1]: https://sourceforge.net/p/docutils/bugs/458/#b7b6
Hi Dmitry, AFAIK, it will work. The behavior may differ, in that groff(1) and mandoc(1) produce a default text, while others may not produce any text at all, but it should work. Cheers, Alex
Hello, Bug #1018737 in python-docutils reported by you has been fixed in the Git repository and is awaiting an upload. You can see the commit message below and you can check the diff of the fix at: https://salsa.debian.org/python-team/packages/python-docutils/-/commit/a32c18d5c5a07610d3c04fbe29cf831f59c006c4 ------------------------------------------------------------------------ Backport upstream patch to not pass empty "manual" argument to the .TH macro. Closes: #1018737. ------------------------------------------------------------------------ (this message was generated automatically) -- Greetings https://bugs.debian.org/1018737
We believe that the bug you reported is fixed in the latest version of
python-docutils, which is due to be installed in the Debian FTP archive.
A summary of the changes between this version and the previous one is
attached.
Thank you for reporting the bug, which will now be closed. If you
have further comments please address them to 1018737@bugs.debian.org,
and the maintainer will reopen the bug report if appropriate.
Debian distribution maintenance software
pp.
Dmitry Shachnev <mitya57@debian.org> (supplier of updated python-docutils package)
(This message was generated automatically at their request; if you
believe that there is a problem with it please contact the archive
administrators by mailing ftpmaster@ftp-master.debian.org)
Format: 1.8
Date: Sat, 21 Jan 2023 20:08:40 +0400
Source: python-docutils
Architecture: source
Version: 0.19+dfsg-3
Distribution: unstable
Urgency: medium
Maintainer: Debian Python Team <team+python@tracker.debian.org>
Changed-By: Dmitry Shachnev <mitya57@debian.org>
Closes: 1018737 1028478
Changes:
python-docutils (0.19+dfsg-3) unstable; urgency=medium
.
* Ignore DeprecationWarnings when running test_buildhtml.py
(closes: #1028478).
* Abort the build when getting --help of some command fails.
* Add a patch to fix FileNotFoundError when generating manpages.
* Break python3-m2r < 0.3 (see #1026288).
* Break ruby-github-markup < 1.7.0+dfsg-5 (see #1013383).
* Backport upstream patch to not pass empty "manual" argument to the .TH
macro (closes: #1018737).
* Bump Standards-Version to 4.6.2, no changes needed.
* Upload to unstable.
Checksums-Sha1:
4655551112dfbdfcdd662ca1b5e14c8332600dfa 2354 python-docutils_0.19+dfsg-3.dsc
1f9ea0e42f66f83aa46723dea96f48fd5d450fc6 32560 python-docutils_0.19+dfsg-3.debian.tar.xz
cffada9a56b9e145e731bf1e297a036bd1eb3b05 5919 python-docutils_0.19+dfsg-3_source.buildinfo
Checksums-Sha256:
b6ef608e5f71264bd296c376327b5e5c809e638af35b493460cadfd91c4a072a 2354 python-docutils_0.19+dfsg-3.dsc
b5c7720484ac74954a69018935a8ce8c262d4d10d356f3d9f6c778bf5aeb0ac6 32560 python-docutils_0.19+dfsg-3.debian.tar.xz
2cecf441a3205072c473f8a478e74bdba0eb08a6b0df5b2d686c0d2138b9a54c 5919 python-docutils_0.19+dfsg-3_source.buildinfo
Files:
254ba87ec7717acd0f086d63ed85395e 2354 python optional python-docutils_0.19+dfsg-3.dsc
970e36c0908c7526c3c17f745f67f2ba 32560 python optional python-docutils_0.19+dfsg-3.debian.tar.xz
c2f7db81d49f1295d85d69cfbdbcb181 5919 python optional python-docutils_0.19+dfsg-3_source.buildinfo
-----BEGIN PGP SIGNATURE-----
iQJHBAEBCgAxFiEE5688gqe4PSusUZcLZkYmW1hrg8sFAmPMFE0THG1pdHlhNTdA
ZGViaWFuLm9yZwAKCRBmRiZbWGuDy6c0D/9Dw++M12oyAuu20NTCfFQimHoIUcu/
RxGSeIzycw3bmEE1K7SAW5IejchdbDtvaqWrBxDLOGiH/01V38/+/+U+1t3oSo+w
1IPhOR0/v6xYs4fIAnrVnyWNF8akFBe3ZH2BeST3npLGuNQ/Eb2YAe6U9O7sslle
5AMnU2rdRM+lpdQ/mivGG31p7e5k4UdEiYfRSDxivAdGp5WU+p/sYWyNBuAS/cn+
kNuX1RIu/i5WsJBdAkPF1crWebyg6hxEh8aCbZozr/ptPnCLq1SbWvCvjU6KFKGC
BbIhC+qx7ak4fULe0H2S9Ecqph/dvfOZTEVXTH+xAKef2VsIpge34l9xK1lio95T
oxBsXEmcr/HTezIOCRgnX0DENyEsgzn+Fvaw9RQAkATjf6RHBaodB9qSxVZZhD8i
cyZcSPP1PLP79hflbric8LxXWlsTynRIzVoyaWz4TjgTudyaJLyb5IEaEnnpnV3b
x3FFHLokYT3/g9a1FruXwxJcgj2QHx6yEIArqci09f2l0AXZtPykf1KMZFBHqkEf
pKpF51+6uyIxs3VsvE3aQvOtNA8GflAprxq7RLxyiX4K5+pn0cLXxjqk1I3YOkV+
qGgk7tNNql5evgfB6H3j6XRLFlGiZq+zC9Tv0qKdiQlaIWU2KaaRJJ2tkh3q4+kz
Cnve9vW5oIlqzw==
=Y4ap
-----END PGP SIGNATURE-----