bug-coreutils
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: man pages and new --help output


From: Jim Meyering
Subject: Re: man pages and new --help output
Date: Tue, 27 Jan 2009 19:46:19 +0100

Eric Blake <address@hidden> wrote:
> Man pages before you changed --help output looked like:
> |        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/

Thanks again.
Along the lines you suggested elsewhere,

>From ddf9282ca3f83c1d8b3ce4ea21da97dfb2e6c052 Mon Sep 17 00:00:00 2001
From: Jim Meyering <address@hidden>
Date: Tue, 27 Jan 2009 19:43:45 +0100
Subject: [PATCH 2/2] doc: emit better bug-reporting info

* src/system.h (emit_bug_reporting_address): Start sentences
with a capital, end with period, mark URLs with <...>.
Based on a suggestion from Eric Blake.
---
 src/system.h |    7 ++++---
 1 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/src/system.h b/src/system.h
index 963ba37..3a19a40 100644
--- a/src/system.h
+++ b/src/system.h
@@ -621,9 +621,10 @@ emit_bug_reporting_address (void)
 {
   printf (_("\nReport %s bugs to <%s>.\n"), last_component (program_name),
          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";));
+  fputs (_("General help using GNU software: 
<http://www.gnu.org/gethelp/>.\n"),
+        stdout);

   /* TRANSLATORS: Replace LANG_CODE in this URL with your language code
      <http://translationproject.org/team/LANG_CODE.html> to form one of
@@ -631,7 +632,7 @@ emit_bug_reporting_address (void)
      the entire URL with your translation team's email address.  */
   if (hard_locale (LC_MESSAGES))
     printf (_("Report %s translation bugs to "
-             "<http://translationproject.org/team/>\n"),
+             "<http://translationproject.org/team/>.\n"),
            last_component (program_name));
 }

--
1.6.1.1.374.g0d9d7


>From 6f8a5b71643c11cef39e7e8868ef098d1e1a834a Mon Sep 17 00:00:00 2001
From: Jim Meyering <address@hidden>
Date: Tue, 27 Jan 2009 19:42:00 +0100
Subject: [PATCH 1/2] ensure that emit_bug_reporting_address changes propagate 
to *.1

* man/Makefile.am ($(MAN)): Depend on system.h.
---
 man/Makefile.am |    6 +++++-
 1 files changed, 5 insertions(+), 1 deletions(-)

diff --git a/man/Makefile.am b/man/Makefile.am
index 415eb82..2b28052 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -1,6 +1,6 @@
 # Make coreutils man pages.                            -*-Makefile-*-

-# Copyright (C) 2002-2008 Free Software Foundation, Inc.
+# Copyright (C) 2002-2009 Free Software Foundation, Inc.

 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -132,6 +132,10 @@ who.1:             $(common_dep)   $(srcdir)/who.x         
../src/who.c
 whoami.1:      $(common_dep)   $(srcdir)/whoami.x      ../src/whoami.c
 yes.1:         $(common_dep)   $(srcdir)/yes.x         ../src/yes.c

+# This is required so that changes to e.g., emit_bug_reporting_address
+# provoke regeneration of all $(MAN) files.
+$(MAN): $(top_srcdir)/src/system.h
+
 SUFFIXES = .x .1

 # Ensure that help2man runs the ../src/ginstall binary as
--
1.6.1.1.374.g0d9d7




reply via email to

[Prev in Thread] Current Thread [Next in Thread]