Bug#850171: debian-policy: Addition of having an 'EXAMPLES' section in manual pages debian policy 12.1
Package: debian-policy
Version: 3.9.8.0
Severity: wishlist
Dear Maintainer,
While I have already filed #850168 I just remembered that lintian
mostly/usually takes directions from debian-policy.
While I do not want to re-iterate the same thing that I have shared in
#850168, I would say it was a bit of a let-down not to even see a
mention of 'EXAMPLES' in the manual.
Similar to " It is suggested that all configuration files also have a
manual page included as well. Manual pages for protocols and other
auxiliary things are optional." We could have something to the tune of
-
"It is suggested that manual pages should have an EXAMPlE section
which describes with syntax how the package could be used. The Example
section could be optional for library packages."
Having examples in packages should improve documentation and package
usage a bit and would be one more step in making Debian a "Universal
Operating System" .
-- System Information:
Debian Release: stretch/sid
APT prefers testing
APT policy: (600, 'testing'), (500, 'unstable-debug'), (500,
'testing-debug'), (1, 'experimental-debug'), (1, 'experimental'), (1,
'unstable')
Architecture: amd64 (x86_64)
Kernel: Linux 4.8.0-2-amd64 (SMP w/2 CPU cores)
Locale: LANG=en_US.UTF-8, LC_CTYPE=en_US.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
Init: systemd (via /run/systemd/system)
debian-policy depends on no packages.
debian-policy recommends no packages.
Versions of packages debian-policy suggests:
ii doc-base 0.10.7
-- no debconf information
--
Regards,
Shirish Agarwal शिरीष अग्रवाल
My quotes in this email licensed under CC 3.0
http://creativecommons.org/licenses/by-nc/3.0/
http://flossexperiences.wordpress.com
EB80 462B 08E1 A0DE A73A 2C2F 9F3D C7A4 E1C4 D2D8
Reply to: