[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#1098526: apt-cache.8: Some remarks and a patch with editorial changes for this man page



Control: tags -1 - patch

Hi,

Am Fri, Feb 21, 2025 at 11:14:15PM +0000, schrieb Bjarni Ingi Gislason:
>      Checking for defects with a new version

As you(?) noticed later in the diff remarks:

> 4:.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>

As such, the problems you found would need to be fixed in the man page
generation OR if that stems from misusing the generator somehow a patch
against the input would be nice: (e.g.)
https://salsa.debian.org/apt-team/apt/-/blob/main/doc/apt-cache.8.xml
https://salsa.debian.org/apt-team/apt/-/blob/main/doc/apt-mark.8.xml

You can find the CMake runes that build the man pages via xsltproc
from the previously mentioned xml sources in DocBook format:
https://salsa.debian.org/apt-team/apt/-/blob/main/CMake/Documentation.cmake#L128
(the translated man pages make a detour over po4a first)


As it stands patching a generated build-artifact is not a workable
solution and so I dropped the 'patch' tag as any change in the generator
or the source would potentially break the patch.


Note that we might eventually rework the man pages entirely and in that
process move to a different source format (but it is very unlikely we
will end up writing man pages by hand). That is some big project not
very well suited for close-to-freeze moments like now through and even
after that probably needs a while if ever attempted.


> Who is actually creating this man page?  Debian or upstream?

For src:apt there is no difference between "Debian maintainer" and
"upstream" because apt is native to Debian and hence also its upstream,
so what are you actually asking and what would the answer solve?


Best regards

David Kalnischkies

Attachment: signature.asc
Description: PGP signature


Reply to: