unofficial mirror of meta@public-inbox.org
 help / color / mirror / Atom feed
* [PATCH] Fix manpage section of perl module documentation
@ 2020-12-18 11:56 Uwe Kleine-König
  2020-12-18 12:17 ` Eric Wong
  0 siblings, 1 reply; 2+ messages in thread
From: Uwe Kleine-König @ 2020-12-18 11:56 UTC (permalink / raw)
  To: meta

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


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH] Fix manpage section of perl module documentation
  2020-12-18 11:56 [PATCH] Fix manpage section of perl module documentation Uwe Kleine-König
@ 2020-12-18 12:17 ` Eric Wong
  0 siblings, 0 replies; 2+ messages in thread
From: Eric Wong @ 2020-12-18 12:17 UTC (permalink / raw)
  To: Uwe Kleine-König; +Cc: meta

Uwe Kleine-König <uwe@kleine-koenig.org> wrote:
> 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".

Thank you, I was wondering about 3pm a few years ago but
forgot about it.  I just checked my FreeBSD system and
that uses 3, so it's definitely system-dependent.
CentOS 7 also uses 3pm.

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

Thanks again, and Debian is still my favorite distro.  I'm not a
build system/packaging pro but the patch looks good to me.

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2020-12-18 12:17 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-12-18 11:56 [PATCH] Fix manpage section of perl module documentation Uwe Kleine-König
2020-12-18 12:17 ` Eric Wong

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