Re: man pages and new --help output

[Jim Meyering]

Eric Blake <address@hidden> wrote:

> Man pages before you changed --help output looked like:
>
> | AUTHOR
> ...
> | REPORTING BUGS
> |        Report bugs to <address@hidden>.
> |
> | COPYRIGHT
>
> But with the latest git sources, they now look like:
>
> | DESCRIPTION
> ...
> |        Report link bugs to <address@hidden>.  GNU coreutils home  page:
> |        http://www.gnu.org/software/coreutils/ General help using GNU 
> software:
> |        http://www.gnu.org/gethelp/
> |
> | AUTHOR
>
> In other words, we lost the REPORTING BUGS section.  help2man needs to be
> taught how to handle the current coreutils practice of inserting the program
> name in between "Report" and "bugs".

Well spotted.
Thanks for the report!

I've fixed it like this:

>From 2fbee63cc9088cfc3010cefe61c831016eaea2d5 Mon Sep 17 00:00:00 2001
From: Jim Meyering <address@hidden>
Date: Tue, 27 Jan 2009 19:16:10 +0100
Subject: [PATCH] doc: restore "REPORTING BUGS" section to generated man pages

* man/help2man ($PAT_BUGS): Update regexp to match the newer
"Report PROG bugs ..." --help output, as well as "Report bugs...".
Reported by Eric Blake.
---
 man/help2man |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/man/help2man b/man/help2man
index 66d715f..d680425 100755
--- a/man/help2man
+++ b/man/help2man
@@ -1,7 +1,7 @@
 #!/usr/bin/perl -w

 # Generate a short man page from --help and --version output.
-# Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2008
+# Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2008, 2009
 # Free Software Foundation, Inc.

 # This program is free software: you can redistribute it and/or modify
@@ -368,7 +368,7 @@ s/^\./\x80/mg;
 s/^'/\x81/mg;
 s/\\/\x82/g;

-my $PAT_BUGS           = _('Report +bugs|Email +bug +reports +to');
+my $PAT_BUGS           = _('Report +(?:\w+ +)?bugs|Email +bug +reports +to');
 my $PAT_AUTHOR         = _('Written +by');
 my $PAT_OPTIONS                = _('Options');
 my $PAT_EXAMPLES       = _('Examples');
--
1.6.1.1.363.g2a3bd