[Drbd-dev] drbdmanage lintian warnings

[Drbd-dev] drbdmanage lintian warnings

[Dietmar Maurer]

I compile my own debian package on jessie, but get many lintian warnings about
man pages:

# lintian drbdmanage_0.34-1_amd64.deb
warning: the authors of lintian do not recommend running it with root
privileges!
W: drbdmanage: manpage-has-bad-whatis-entry
usr/share/man/man8/dm-add-resource.8.gz
W: drbdmanage: manpage-section-mismatch
usr/share/man/man8/dm-add-resource.8.gz:2 8 != ADD-RESOURCE
W: drbdmanage: manpage-has-bad-whatis-entry
usr/share/man/man8/dm-add-volume.8.gz
W: drbdmanage: manpage-section-mismatch usr/share/man/man8/dm-add-volume.8.gz:2
8 != ADD-VOLUME
W: drbdmanage: manpage-has-bad-whatis-entry usr/share/man/man8/dm-assign.8.gz
W: drbdmanage: manpage-has-bad-whatis-entry
usr/share/man/man8/dm-assignments.8.gz
W: drbdmanage: manpage-has-bad-whatis-entry usr/share/man/man8/dm-attach.8.gz
...

Can someone reproduce that?

Re: [Drbd-dev] drbdmanage lintian warnings

[Roland Kammerer]

On Mon, May 11, 2015 at 10:54:03AM +0200, Dietmar Maurer wrote:
> I compile my own debian package on jessie, but get many lintian warnings about
> man pages:
> 
> # lintian drbdmanage_0.34-1_amd64.deb
> warning: the authors of lintian do not recommend running it with root
> privileges!
> W: drbdmanage: manpage-has-bad-whatis-entry
> usr/share/man/man8/dm-add-resource.8.gz
> W: drbdmanage: manpage-section-mismatch
> usr/share/man/man8/dm-add-resource.8.gz:2 8 != ADD-RESOURCE
> W: drbdmanage: manpage-has-bad-whatis-entry
> usr/share/man/man8/dm-add-volume.8.gz
> W: drbdmanage: manpage-section-mismatch usr/share/man/man8/dm-add-volume.8.gz:2
> 8 != ADD-VOLUME
> W: drbdmanage: manpage-has-bad-whatis-entry usr/share/man/man8/dm-assign.8.gz
> W: drbdmanage: manpage-has-bad-whatis-entry
> usr/share/man/man8/dm-assignments.8.gz
> W: drbdmanage: manpage-has-bad-whatis-entry usr/share/man/man8/dm-attach.8.gz
> ...
> 
> Can someone reproduce that?

Yes. 

The man-pages are autogenerated (see setup.py) and the process is not
perfect. Patches welcome. ;-)

Regards, rck

Re: [Drbd-dev] drbdmanage lintian warnings

[Roland Kammerer]

[-- Attachment #1: Type: text/plain, Size: 286 bytes --]

On Mon, May 11, 2015 at 11:22:06AM +0200, Roland Kammerer wrote:
>  Patches welcome. ;-)

See attached patch. It fixes the bulk of the lintian warnings. There are
still some other unrelated manpage errors left that would need a closer
look (e.g. command string too long).

Regards, rck

[-- Attachment #2: 0001-man-pages-Fixed-some-lintian-warnings.patch --]
[-- Type: text/x-diff, Size: 1449 bytes --]

From 88ef35ee774bf66184937c68de5a373a352d7e6e Mon Sep 17 00:00:00 2001
From: Roland Kammerer <roland.kammerer@linbit.com>
Date: Mon, 11 May 2015 11:53:16 +0200
Subject: [PATCH] man-pages: Fixed some lintian warnings

This fixes the "manpage-has-bad-wahtis-entry" warnings.
---
 setup.py | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/setup.py b/setup.py
index 900f9c9..d8faa99 100755
--- a/setup.py
+++ b/setup.py
@@ -98,7 +98,7 @@ class BuildManCommand(Command):
             if os.path.isfile(outfile):
                 continue
             print "Generating %s ..." % (outfile)
-            mangen = ["help2man", "-n", toplevel, '-s', '8',
+            mangen = ["help2man", "-n", toplevel, '-s', mansection,
                       '--version-string=%s' % (get_version()), "-N",
                       '"./drbdmanage_client.py %s"' % (toplevel)]
 
@@ -106,6 +106,9 @@ class BuildManCommand(Command):
             manpage = subprocess.check_output(toexec, shell=True)
             manpage = manpage.replace(replace[0], replace[1])
             manpage = manpage.replace(replace[0].upper(), replace[1].upper())
+            manpage = manpage.replace(toplevel.upper(), mansection)
+            manpage = manpage.replace("%s %s" % (replace[1], toplevel),
+                                      "%s_%s" % (replace[1], toplevel))
             with gzip.open(outfile, 'wb') as f:
                 f.write(manpage)
 
-- 
2.1.4

Re: [Drbd-dev] drbdmanage lintian warnings

[Dietmar Maurer]

> See attached patch. It fixes the bulk of the lintian warnings. There are
> still some other unrelated manpage errors left that would need a closer
> look (e.g. command string too long).

Many thanks, that fixes almost all warnings.