Your message dated Sat, 10 Nov 2018 16:56:07 -0700 with message-id <87k1lktrl4....@iris.silentflame.com> and subject line Re: Bug#850171: Recommend that manpages contain an EXAMPLES section has caused the Debian Bug report #850171, regarding debian-policy: Addition of having an 'EXAMPLES' section in manual pages debian policy 12.1 to be marked as done.
This means that you claim that the problem has been dealt with. If this is not the case it is now your responsibility to reopen the Bug report if necessary, and/or fix the problem forthwith. (NB: If you are a system administrator and have no idea what this message is talking about, this may indicate a serious mail system misconfiguration somewhere. Please contact ow...@bugs.debian.org immediately.) -- 850171: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=850171 Debian Bug Tracking System Contact ow...@bugs.debian.org with problems
--- Begin Message ---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
--- End Message ---
--- Begin Message ---tag 850171 +wontfix thanks On Sun 04 Nov 2018 at 09:11AM -0800, Russ Allbery wrote: > Mattia Rizzolo <mat...@debian.org> writes: > >> What I mean is: if there is really enough people wanting this change by >> all means do it, but 1. make the wording clear that is really optional >> (in this view, I see "recommended" as too strong a word) and 2. I really >> hope lintian won't start bothering for this. > > Maybe https://wiki.debian.org/UpstreamGuide would be a better place for > this? Currently, it doesn't even explicitly recommend that upstream > provide man pages. Given the lack of consensus, let's just do this instead. I've edited that page. -- Sean Whittonsignature.asc
Description: PGP signature
--- End Message ---