From: "Uwe Kleine-König" <uwe@kleine-koenig.org>
To: meta@public-inbox.org
Subject: [PATCH] Fix manpage section of perl module documentation
Date: Fri, 18 Dec 2020 12:56:14 +0100 [thread overview]
Message-ID: <20201218115614.613227-1-uwe@kleine-koenig.org> (raw)
On Debian (at least) perl documentation is supposed to be installed in
section 3pm. With the build system hardcoding this to 3 instead this
results in a warning by the Debian package linter:
W: public-inbox: wrong-manual-section usr/share/man/man3/PublicInbox::Git.3.gz:74 3 != 3pm
W: public-inbox: wrong-manual-section usr/share/man/man3/PublicInbox::Import.3.gz:74 3 != 3pm
W: public-inbox: wrong-manual-section usr/share/man/man3/PublicInbox::SaPlugin::ListMirror.3.gz:74 3 != 3pm
W: public-inbox: wrong-manual-section ... use --no-tag-display-limit to see all (or pipe to a file/program)
So use "$(MAN3EXT)" instead of "3".
---
Hello,
I'm continuing to package public-inbox for Debian now. I'm not a perl
pro, so take this patch with a grain of salt. The only indication I have
that this patch is fine is that it makes the lintian warning go away :-)
Best regards
Uwe
Makefile.PL | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Makefile.PL b/Makefile.PL
index 3fe9acf80bc0..dc9bf4701e65 100644
--- a/Makefile.PL
+++ b/Makefile.PL
@@ -107,7 +107,7 @@ my %man3 = map {; # semi-colon tells Perl this is a BLOCK (and not EXPR)
my $mod = $base;
$mod =~ s!/!::!g;
$mod =~ s/\.\w+\z//;
- "lib/PublicInbox/$_" => "blib/man3/PublicInbox::$mod.3"
+ "lib/PublicInbox/$_" => "blib/man3/PublicInbox::$mod.\$(MAN3EXT)"
} qw(Git.pm Import.pm WWW.pod SaPlugin/ListMirror.pod);
WriteMakefile(
--
2.29.2
next reply other threads:[~2020-12-18 11:56 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-12-18 11:56 Uwe Kleine-König [this message]
2020-12-18 12:17 ` [PATCH] Fix manpage section of perl module documentation Eric Wong
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://public-inbox.org/README
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20201218115614.613227-1-uwe@kleine-koenig.org \
--to=uwe@kleine-koenig.org \
--cc=meta@public-inbox.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).