Re: [gnu-prog-discuss] url's in --help output

[Eric Blake]

Simon Josefsson <simon <at> josefsson.org> writes:

> +2009-01-22  Simon Josefsson  <simon <at> josefsson.org>
> +
> +     * lib/version-etc.h: Add emit_bug_reporting_address.
> +     * lib/version-etc.c (emit_bug_reporting_address): New function.
> +     * modules/version-etc (Description): Reflect new features.

The current wording makes for awkward man pages when using help2man; for 
example, the generated m4.1 now looks like:

REPORTING BUGS
       Report    bugs    to    <address@hidden>.     GNU    M4    home   page:
       http://www.gnu.org/software/m4/  General  help  using   GNU   software:
       http://www.gnu.org/gethelp/

COPYRIGHT
       Copyright  (C) 2009 Free Software Foundation, Inc.  License GPLv3+: GNU
       GPL version 3 or later <http://gnu.org/licenses/gpl.html>
       This is free software: you are free  to  change  and  redistribute  it.
       There is NO WARRANTY, to the extent permitted by law.


What do you think of this followup, which makes complete sentences, and 
consistently brackets URLs inside <>?


From: Eric Blake <address@hidden>
Date: Tue, 27 Jan 2009 10:00:51 -0700
Subject: [PATCH] version-etc: use consistent URL formatting

* lib/version-etc.c (emit_bug_reporting_address): Improve
formatting.

Signed-off-by: Eric Blake <address@hidden>
---
 ChangeLog         |    6 ++++++
 lib/version-etc.c |    6 +++---
 2 files changed, 9 insertions(+), 3 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 3dab71e..d574692 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2009-01-27  Eric Blake  <address@hidden>
+
+       version-etc: use consistent URL formatting
+       * lib/version-etc.c (emit_bug_reporting_address, version_etc_va):
+       Improve formatting.
+
 2009-01-26  Jim Meyering  <address@hidden>
 
        fflush: avoid warnings on modern systems
diff --git a/lib/version-etc.c b/lib/version-etc.c
index 0fe5d6c..b00190e 100644
--- a/lib/version-etc.c
+++ b/lib/version-etc.c
@@ -66,7 +66,7 @@ version_etc_va (FILE *stream,
 
   fputs (_("\
 \n\
-License GPLv3+: GNU GPL version 3 or later 
<http://gnu.org/licenses/gpl.html>\n\
+License GPLv3+: GNU GPL version 3 or later 
<http://gnu.org/licenses/gpl.html>.\n\
 This is free software: you are free to change and redistribute it.\n\
 There is NO WARRANTY, to the extent permitted by law.\n\
 \n\
@@ -179,7 +179,7 @@ emit_bug_reporting_address (void)
      "Report translation bugs to <...>\n" with the address for translation
      bugs (typically your translation team's web or email address).  */
   printf (_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
-  printf (_("%s home page: http://www.gnu.org/software/%s/\n";),
+  printf (_("%s home page: <http://www.gnu.org/software/%s/>.\n"),
          PACKAGE_NAME, PACKAGE);
-  printf (_("General help using GNU software: http://www.gnu.org/gethelp/\n";));
+  printf (_("General help using GNU software: 
<http://www.gnu.org/gethelp/>.\n"));
 }
-- 
1.6.0.4