[Libguestfs] [PATCH 1/3] podwrapper: Enforce that every manual page must have a DESCRIPTION section.

[Richard W.M. Jones]

For every user command line tool (eg. guestfish or virt-cat) require
that the manual page has a DESCRIPTION section.  This doesn't apply to
non-CLI man pages (eg. guestfs-perl, guestfs-faq).
---
 podwrapper.pl.in | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/podwrapper.pl.in b/podwrapper.pl.in
index 771782e..37e3e84 100755
--- a/podwrapper.pl.in
+++ b/podwrapper.pl.in
@@ -218,6 +218,9 @@ die "$progname: $input: no output format specified.  Use --man and/or --html and
 $name = basename ($input, ".pod") unless defined $name;
 $section = 1 unless defined $section;
 
+# Is it a user command line tool?
+my $cli_tool = $section == 1 && $name !~ /^guestfs-/;
+
 # Note that these @...@ are substituted by ./configure.
 my $abs_top_srcdir = "@abs_top_srcdir@";
 my $abs_top_builddir = "@abs_top_builddir@";
@@ -300,6 +303,8 @@ $content =~ s/^=(.*)/\n=encoding utf8\n\n=$1/m;
 
 if ($strict_checks) {
     # Verify sections present / not present.
+    die "$progname: $input: missing DESCRIPTION section\n"
+        if $cli_tool && $content !~ /^=head1 DESCRIPTION/m;
     die "$progname: $input: missing AUTHOR or AUTHORS section\n"
         unless $content =~ /^=head1 AUTHOR/m;
     die "$progname: $input: missing SEE ALSO section\n"
-- 
2.5.0