Processed: Re: Bug#850168: lintian should have checks for manual pages to see if they have an EXAMPlES section

2017-01-04 Thread Debian Bug Tracking System
Processing control commands:

> severity -1 wishlist
Bug #850168 [lintian] lintian should have checks for manual pages to see if 
they have an EXAMPlES section
Severity set to 'wishlist' from 'normal'

-- 
850168: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=850168
Debian Bug Tracking System
Contact ow...@bugs.debian.org with problems



Bug#850168: lintian should have checks for manual pages to see if they have an EXAMPlES section

2017-01-04 Thread anarcat
Control: severity -1 wishlist

I agree!

I often find myself frustrated by more obscure bits of software where I
would love to see some EXAMPLES sections to help me get started.

Maybe this could be a "Informative" or "Pedantic" level instead of
"Warning"? It certainly shouldn't be at the "Error" level, or at least
not worse than the current "manpage missing" message.

Thanks!

-- 
If it's important for you, you'll find a way.
If it's not, you'll find an excuse.
- Unknown


signature.asc
Description: Digital signature


Bug#850168: lintian should have checks for manual pages to see if they have an EXAMPlES section

2017-01-04 Thread shirish शिरीष
Package: lintian
Version: 2.5.49
Severity: normal

Dear Maintainer,
lintian has checks for binary-without-manpage tag and page
https://lintian.debian.org/tags/binary-without-manpage.html . While
this is good, it would be nice if we could also increase the
usefulness of the manpages that we have.

Many a times, the usefulness of a package remains low because the
documentation even with the manpage is not accessible to the common
user as there are no examples to get her/im understood the syntax and
how the program behaves.

This loses time and leads to more effort on both the user and the
developer to understand and would lead to less popcon scores leading
to lower adoption and lower interest to the package concerned.

It would be nicer if lintian would have such a check. Improving
documentation of a package  would not only improves usage of the
package in Debian but also the free software community as a whole.

Having packages popular, usable and stable for a long time is
something that both the project itself and users expect from Debian.

-- 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)

Versions of packages lintian depends on:
ii  binutils  2.27.51.20161220-1
ii  bzip2 1.0.6-8
ii  diffstat  1.61-1
ii  file  1:5.29-2
ii  gettext   0.19.8.1-1
ii  intltool-debian   0.35.0+20060710.4
ii  libapt-pkg-perl   0.1.30
ii  libarchive-zip-perl   1.59-1
ii  libclass-accessor-perl0.34-1
ii  libclone-perl 0.38-2+b1
ii  libdpkg-perl  1.18.18
ii  libemail-valid-perl   1.202-1
ii  libfile-basedir-perl  0.07-1
ii  libipc-run-perl   0.94-1
ii  liblist-moreutils-perl0.416-1+b1
ii  libparse-debianchangelog-perl 1.2.0-12
ii  libperl5.24 [libdigest-sha-perl]  5.24.1~rc4-1
ii  libtext-levenshtein-perl  0.13-1
ii  libtimedate-perl  2.3000-2
ii  liburi-perl   1.71-1
ii  libyaml-libyaml-perl  0.63-1+b1
ii  man-db2.7.6.1-2
ii  patchutils0.3.4-2
ii  perl  5.24.1~rc4-1
ii  t1utils   1.39-2
ii  xz-utils  5.2.2-1.2

Versions of packages lintian recommends:
ii  dpkg 1.18.18
ii  libautodie-perl  2.29-2
ii  libperlio-gzip-perl  0.19-1+b2
ii  perl 5.24.1~rc4-1
ii  perl-modules-5.24 [libautodie-perl]  5.24.1~rc4-1

Versions of packages lintian suggests:
pn  binutils-multiarch 
ii  dpkg-dev   1.18.18
ii  libhtml-parser-perl3.72-3
ii  libtext-template-perl  1.46-1

-- 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