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

Bug#979735: man pages: manuals created from a docbook file need postprocessing



Control: reassign -1 docbook-xml
Control: forcemerge -1 979737 979736

On Sun, Jan 10, 2021 at 10:44:19PM +0000, Bjarni Ingi Gislason wrote:
> Package: apt-utils
> Version: 2.1.15
> Severity: minor
> 
> Dear Maintainer,
> 
>   the attachment contains a shell script to fix man pages created from
> a docbook file.
> 
>   Main improvements are:
> 
> # Remove trailing spaces.
> # Remove .PP after .SH and .SH.
> # Remove '\&' before a period inside or after a word.
> #  '\&' suppresses kerning between characters on both sides of it.
> # Break lines after a punctuation mark and before a parentheses.
> #  To make lines shorter and easier to read, edit, and make a diff.
> 
> sed -e '/\\"/n' \
>   -e '/^\.TS,^\.TE/n' \
>   -e 's/  *$//' \
>   -e '/^\.S[SH]/{n; /\.PP/d}' \
>   -e 's/\([^ ]\)\\&\./\1./g' \
>   -e 's/\([^ ][.,;!?]\)  */\1\n/g' \
>   -e 's/ (/\n(/g' ${1:--}
> 

Is this a joke?

We're not going to pass our manual page output through a sed blackbox to
make it match your personal preferences. If you are unhappy with the
output of docbook, raise this with docbook, and don't report bug in
downstream users with obscure sed blackboxes they can't maintain.

Anyway, reassigning to docbook, and merging the duplicate apt bugs,
and the aptitude bug. If docbook manual pages need post-processing, it
is up to docbook to provide the tools to do so.
-- 
debian developer - deb.li/jak | jak-linux.org - free software dev
ubuntu core developer                              i speak de, en


Reply to: