automake
[Top][All Lists]
Advanced

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

Re: help2man


From: Alexandre Duret-Lutz
Subject: Re: help2man
Date: Sun, 05 Feb 2006 06:53:28 +0100
User-agent: Gnus/5.110003 (No Gnus v0.3) Emacs/22.0.50 (gnu/linux)

>>> "BR" == Bob Rossi <address@hidden> writes:

 BR> My doc directory is built after all others. I was thinking I could have
 BR> a rule in the doc directory that would run help2man if usage.c has
 BR> changed. However, if usage.c was changed, by this point, the usage.o has
 BR> already been built, so I don't know how I would be able to determine I
 BR> need to run this command.

I don't understand your problem with usage.o; why would we care
about usage.o?  You need to rebuild cgdb.1 whenever usage.c is
newer than cgdb.1.  And since the version can probably be
changed without modifying usage.c, e.g., by changing
configure.ac, you also need to rebuild cgdb.1 whenever
configure.ac is newer.

 BR> Also, I did read this:
 BR> http://www.gnu.org/software/automake/manual/html_mono/automake.html
 BR> section: "Files left in build directory after distclean"

I think this shows all you need.  Adjusted to you case it would
probably give

     dist_man_MANS = cgdb.1

     cgdb.1: $(top_srcdir)/src/usage.c $(top_srcdir)/configure.ac
             cd $(top_builddir)/src && $(MAKE) $(AM_MAKEFLAGS) cgdb$(EXEEXT)
             help2man --output=$@ $(top_builddir)/src/foo$(EXEEXT)

 BR> And finally, at the bottom of that section I may have found an error in
 BR> the documentation. 

Thanks, I'm installing this.

2006-02-05  Alexandre Duret-Lutz  <address@hidden>

        * doc/automake.texi (distcleancheck): Fix bad wording.  Report
        from Bob Rossi.
        (Man pages): Show dist_man_MANS, not EXTRA_DIST = $(man_MANS).

Index: THANKS
===================================================================
RCS file: /cvs/automake/automake/THANKS,v
retrieving revision 1.275
diff -u -r1.275 THANKS
--- THANKS      7 Aug 2005 09:56:09 -0000       1.275
+++ THANKS      5 Feb 2006 05:50:13 -0000
@@ -31,6 +31,7 @@
 Bill Fenner            address@hidden
 Bob Friesenhahn                address@hidden
 Bob Proulx             address@hidden
+Bob Rossi              address@hidden
 Braden N. McDaniel     address@hidden
 Brendan O'Dea          address@hidden
 Brian Ford             address@hidden
Index: doc/automake.texi
===================================================================
RCS file: /cvs/automake/automake/doc/automake.texi,v
retrieving revision 1.126
diff -u -r1.126 automake.texi
--- doc/automake.texi   29 Jan 2006 17:35:12 -0000      1.126
+++ doc/automake.texi   5 Feb 2006 05:50:15 -0000
@@ -6200,18 +6200,16 @@
 installed by default.  The user can still explicitly install them via
 @samp{make install-man}.
 
-Here is how the man pages are handled in GNU @command{cpio} (which
-includes both Texinfo documentation and man pages):
-
address@hidden
-man_MANS = cpio.1 mt.1
-EXTRA_DIST = $(man_MANS)
address@hidden example
-
 Man pages are not currently considered to be source, because it is not
 uncommon for man pages to be automatically generated.  Therefore they
 are not automatically included in the distribution.  However, this can
-be changed by use of the @code{dist_} prefix.
+be changed by use of the @code{dist_} prefix.  For instance here is
+how to distribute and install the two man pages of GNU @command{cpio}
+(which includes both Texinfo documentation and man pages):
+
address@hidden
+dist_man_MANS = cpio.1 mt.1
address@hidden example
 
 The @code{nobase_} prefix is meaningless for man pages and is
 disallowed.
@@ -8606,10 +8604,10 @@
 Distributed files should never depend upon non-distributed built
 files.
 @item
-Distributed files should be distributed will all their dependencies.
+Distributed files should be distributed with all their dependencies.
 @item
-If a file is @emph{intended} be rebuilt by users, there is no point in
-distributing it.
+If a file is @emph{intended} to be rebuilt by users, then there is no point
+in distributing it.
 @end itemize
 @end cartouche
 
-- 
Alexandre Duret-Lutz

Shared books are happy books.     http://www.bookcrossing.com/friend/gadl





reply via email to

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