Stefano Lattarini <stefano.lattarini@HIDDEN>
to control <at> debbugs.gnu.org
.
Full text available.Ralf Wildenhues <Ralf.Wildenhues@HIDDEN>
to control <at> debbugs.gnu.org
.
Full text available.Received: (at 7766) by debbugs.gnu.org; 9 Jan 2011 18:58:53 +0000 From debbugs-submit-bounces <at> debbugs.gnu.org Sun Jan 09 13:58:52 2011 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>) id 1Pc0Tc-0001hc-DH for submit <at> debbugs.gnu.org; Sun, 09 Jan 2011 13:58:52 -0500 Received: from mailout-de.gmx.net ([213.165.64.22] helo=mail.gmx.net) by debbugs.gnu.org with smtp (Exim 4.69) (envelope-from <Ralf.Wildenhues@HIDDEN>) id 1Pc0TZ-0001hM-VD for 7766 <at> debbugs.gnu.org; Sun, 09 Jan 2011 13:58:51 -0500 Received: (qmail invoked by alias); 09 Jan 2011 19:06:11 -0000 Received: from xdsl-89-0-131-211.netcologne.de (EHLO localhost.localdomain) [89.0.131.211] by mail.gmx.net (mp054) with SMTP; 09 Jan 2011 20:06:11 +0100 X-Authenticated: #13673931 X-Provags-ID: V01U2FsdGVkX18PKzISnucPD4ukGBFT16VIqJ6E3m2fOPWPgZDOl1 ivjIZ8LCAu8Br0 Received: from ralf by localhost.localdomain with local (Exim 4.69) (envelope-from <Ralf.Wildenhues@HIDDEN>) id 1Pc0ag-0003NQ-7l; Sun, 09 Jan 2011 20:06:10 +0100 Date: Sun, 9 Jan 2011 20:06:10 +0100 From: Ralf Wildenhues <Ralf.Wildenhues@HIDDEN> To: Karl Berry <karl@HIDDEN> Subject: Re: bug#7766: (lack of) config.h description in manual Message-ID: <20110109190610.GR17091@HIDDEN> References: <201101010000.p0100KNA009987@HIDDEN> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <201101010000.p0100KNA009987@HIDDEN> Organization: Institute for Numerical Simulation, University of Bonn User-Agent: Mutt/1.5.20 (2010-08-04) X-Y-GMX-Trusted: 0 X-Spam-Score: -2.7 (--) X-Debbugs-Envelope-To: 7766 Cc: 7766 <at> debbugs.gnu.org X-BeenThere: debbugs-submit <at> debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: <debbugs-submit.debbugs.gnu.org> List-Unsubscribe: <http://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe> List-Archive: <http://debbugs.gnu.org/pipermail/debbugs-submit> List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org> List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help> List-Subscribe: <http://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe> Sender: debbugs-submit-bounces <at> debbugs.gnu.org Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org X-Spam-Score: -2.7 (--) retitle 7766 docs: work on index issues thanks * Karl Berry wrote on Sat, Jan 01, 2011 at 01:00:20AM CET: > > Subsidiary points: in the general index (I continue to very strongly > encourage you to merge all indexes, BTW), I didn't find anything useful > for "preprocessor", or "#define", or "config.h", or anything else I > could think of. Fortran preprocessing was the only thing. AFAICS the index issues are the only remaining ones from this PR, so I'm adjusting the title accordingly.
owner <at> debbugs.gnu.org, bug-automake@HIDDEN
:bug#7766
; Package automake
.
Full text available.Received: (at 7766) by debbugs.gnu.org; 9 Jan 2011 00:10:22 +0000 From debbugs-submit-bounces <at> debbugs.gnu.org Sat Jan 08 19:10:22 2011 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>) id 1PbirW-0000An-DZ for submit <at> debbugs.gnu.org; Sat, 08 Jan 2011 19:10:22 -0500 Received: from b0.f7.net ([66.148.120.132] helo=freefriends.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from <karl@HIDDEN>) id 1PbirT-0000AZ-JA for 7766 <at> debbugs.gnu.org; Sat, 08 Jan 2011 19:10:20 -0500 X-Envelope-From: karl@HIDDEN Received: from freefriends.org (sls-af11p1 [127.0.0.1]) by freefriends.org (8.14.4/8.14.4) with ESMTP id p090Habh030388; Sat, 8 Jan 2011 19:17:39 -0500 Received: (from nobody@localhost) by freefriends.org (8.14.4/8.14.4/submit) id p090HaEP030387; Sun, 9 Jan 2011 00:17:36 GMT Date: Sun, 9 Jan 2011 00:17:36 GMT Message-Id: <201101090017.p090HaEP030387@HIDDEN> X-Authentication-Warning: localhost.localdomain: nobody set sender to karl@HIDDEN using -f From: karl@HIDDEN (Karl Berry) To: Ralf.Wildenhues@HIDDEN Subject: Re: bug#7766: (lack of) config.h description in manual In-Reply-To: <20110108192129.GL4786@HIDDEN> X-Spam-Score: -3.8 (---) X-Debbugs-Envelope-To: 7766 Cc: 7766 <at> debbugs.gnu.org, automake-patches@HIDDEN X-BeenThere: debbugs-submit <at> debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: <debbugs-submit.debbugs.gnu.org> List-Unsubscribe: <http://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe> List-Archive: <http://debbugs.gnu.org/pipermail/debbugs-submit> List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org> List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help> List-Subscribe: <http://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe> Sender: debbugs-submit-bounces <at> debbugs.gnu.org Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org X-Spam-Score: -3.7 (---) Hmm, I see a natural split into two, not three nodes. Ok, fine. Below, I replaced the existing one rather than using another lower hierarchy level. Does this seem acceptable to you? Sure, but I suggest making the @node names closer to the @section names, and not using that unusual-looking /. @node amhello/configure.ac -> @node amhello's configure.ac Setup Explained @subsection Configure setup explained -> @subsection @code{amhello}'s @file{configure.ac} Setup Explained Ditto for the other node. And then I think the upper-level menu could just use the node names. (In general, despite longstanding precedent in various GNU manuals, my belief is that it is not helpful to readers to have @node names that unnecessarily differ from their section names. The result is confusion when an xref is made.) Re capitalization, I seem to recall that we tried to systematically Capitalize Node/Section Names a while back. I don't see other downcased names in the top-level menu just now, anyway. +@anchor{amhello Explained} Very good. Extra credit for thinking to do that :). Thanks, k
owner <at> debbugs.gnu.org, bug-automake@HIDDEN
:bug#7766
; Package automake
.
Full text available.Received: (at 7766) by debbugs.gnu.org; 8 Jan 2011 19:14:13 +0000 From debbugs-submit-bounces <at> debbugs.gnu.org Sat Jan 08 14:14:13 2011 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>) id 1PbeEv-0000qa-8b for submit <at> debbugs.gnu.org; Sat, 08 Jan 2011 14:14:13 -0500 Received: from mailout-de.gmx.net ([213.165.64.23] helo=mail.gmx.net) by debbugs.gnu.org with smtp (Exim 4.69) (envelope-from <Ralf.Wildenhues@HIDDEN>) id 1PbeEt-0000qO-0O for 7766 <at> debbugs.gnu.org; Sat, 08 Jan 2011 14:14:12 -0500 Received: (qmail invoked by alias); 08 Jan 2011 19:21:30 -0000 Received: from xdsl-78-34-215-107.netcologne.de (EHLO localhost.localdomain) [78.34.215.107] by mail.gmx.net (mp033) with SMTP; 08 Jan 2011 20:21:30 +0100 X-Authenticated: #13673931 X-Provags-ID: V01U2FsdGVkX18nwi564bUnjl9F4SJAcYILuGeF4nh0TtX4LFKtu6 f0FMVFnHsHlb+I Received: from ralf by localhost.localdomain with local (Exim 4.69) (envelope-from <Ralf.Wildenhues@HIDDEN>) id 1PbeLx-0005Rw-7w; Sat, 08 Jan 2011 20:21:29 +0100 Date: Sat, 8 Jan 2011 20:21:29 +0100 From: Ralf Wildenhues <Ralf.Wildenhues@HIDDEN> To: Karl Berry <karl@HIDDEN>, automake-patches@HIDDEN Subject: Re: bug#7766: (lack of) config.h description in manual Message-ID: <20110108192129.GL4786@HIDDEN> Mail-Followup-To: Karl Berry <karl@HIDDEN>, automake-patches@HIDDEN, 7766 <at> debbugs.gnu.org References: <201101010000.p0100KNA009987@HIDDEN> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <201101010000.p0100KNA009987@HIDDEN> Organization: Institute for Numerical Simulation, University of Bonn User-Agent: Mutt/1.5.20 (2010-08-04) X-Y-GMX-Trusted: 0 X-Spam-Score: -2.9 (--) X-Debbugs-Envelope-To: 7766 Cc: 7766 <at> debbugs.gnu.org X-BeenThere: debbugs-submit <at> debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: <debbugs-submit.debbugs.gnu.org> List-Unsubscribe: <http://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe> List-Archive: <http://debbugs.gnu.org/pipermail/debbugs-submit> List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org> List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help> List-Subscribe: <http://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe> Sender: debbugs-submit-bounces <at> debbugs.gnu.org Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org X-Spam-Score: -2.9 (--) Hi Karl, * Karl Berry wrote on Sat, Jan 01, 2011 at 01:00:20AM CET: > Finally, the "amhello explained" node is pretty long. It seems to break > up naturally into three pieces, for each of the files being explained. > Perhaps it would be good to make them each separate (sub)nodes. Hmm, I see a natural split into two, not three nodes. Below, I replaced the existing one rather than using another lower hierarchy level. Does this seem acceptable to you? Thanks, Ralf docs: split 'amhello Explained' node. * doc/automake.texi (amhello Explained): Split node ... (amhello/configure.ac, amhello/Makefile.am): ... into these two. (Top, Hello World): Adjust, and add @anchor for stable URL links. Suggestion by Karl Berry in automake bug#7766. diff --git a/doc/automake.texi b/doc/automake.texi index c63dbf3..9e29951 100644 --- a/doc/automake.texi +++ b/doc/automake.texi @@ -157,7 +157,8 @@ Top A Small Hello World * Creating amhello:: Create @file{amhello-1.0.tar.gz} from scratch -* amhello Explained:: @file{configure.ac} and @file{Makefile.am} explained +* amhello/configure.ac:: Configure setup explained +* amhello/Makefile.am:: Makefile setup explained General ideas @@ -1392,9 +1393,11 @@ Hello World meaning of the @file{configure.ac} and @file{Makefile.am} files read by the Autotools. +@anchor{amhello Explained} @menu * Creating amhello:: Create @file{amhello-1.0.tar.gz} from scratch -* amhello Explained:: @file{configure.ac} and @file{Makefile.am} explained +* amhello/configure.ac:: Configure setup explained +* amhello/Makefile.am:: Makefile setup explained @end menu @node Creating amhello @@ -1555,8 +1558,10 @@ Creating amhello direct you to the right manual when seeking answers. -@node amhello Explained -@subsection @file{amhello-1.0} Explained +@node amhello/configure.ac +@subsection Configure setup explained + +@cindex @file{configure.ac}, Hello World Let us begin with the contents of @file{configure.ac}. @@ -1664,6 +1669,10 @@ amhello Explained @command{autoscan} to Create @file{configure.ac}, autoconf, The Autoconf Manual}). + +@node amhello/Makefile.am +@subsection Makefile setup explained + @cindex @file{Makefile.am}, Hello World We now turn to @file{src/Makefile.am}. This file contains
owner <at> debbugs.gnu.org, bug-automake@HIDDEN
:bug#7766
; Package automake
.
Full text available.Received: (at submit) by debbugs.gnu.org; 31 Dec 2010 23:53:32 +0000 From debbugs-submit-bounces <at> debbugs.gnu.org Fri Dec 31 18:53:32 2010 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>) id 1PYomp-00045F-0y for submit <at> debbugs.gnu.org; Fri, 31 Dec 2010 18:53:32 -0500 Received: from eggs.gnu.org ([140.186.70.92]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from <karl@HIDDEN>) id 1PYomm-000452-L5 for submit <at> debbugs.gnu.org; Fri, 31 Dec 2010 18:53:29 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from <karl@HIDDEN>) id 1PYotX-0000x1-G8 for submit <at> debbugs.gnu.org; Fri, 31 Dec 2010 19:00:28 -0500 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00 autolearn=unavailable version=3.3.1 Received: from lists.gnu.org ([199.232.76.165]:34213) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from <karl@HIDDEN>) id 1PYotX-0000wx-Bj for submit <at> debbugs.gnu.org; Fri, 31 Dec 2010 19:00:27 -0500 Received: from [140.186.70.92] (port=50281 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1PYotW-00051D-9t for bug-automake@HIDDEN; Fri, 31 Dec 2010 19:00:27 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from <karl@HIDDEN>) id 1PYotV-0000wl-01 for bug-automake@HIDDEN; Fri, 31 Dec 2010 19:00:26 -0500 Received: from b0.f7.net ([66.148.120.132]:58833 helo=freefriends.org) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from <karl@HIDDEN>) id 1PYotU-0000wh-N7 for bug-automake@HIDDEN; Fri, 31 Dec 2010 19:00:24 -0500 X-Envelope-From: karl@HIDDEN X-Envelope-To: <bug-automake@HIDDEN> Received: from freefriends.org (sls-af11p1 [127.0.0.1]) by freefriends.org (8.14.4/8.14.4) with ESMTP id p0100KCb009988 for <bug-automake@HIDDEN>; Fri, 31 Dec 2010 19:00:23 -0500 Received: (from nobody@localhost) by freefriends.org (8.14.4/8.14.4/submit) id p0100KNA009987; Sat, 1 Jan 2011 00:00:20 GMT Date: Sat, 1 Jan 2011 00:00:20 GMT Message-Id: <201101010000.p0100KNA009987@HIDDEN> X-Authentication-Warning: localhost.localdomain: nobody set sender to karl@HIDDEN using -f From: karl@HIDDEN (Karl Berry) To: bug-automake@HIDDEN Subject: (lack of) config.h description in manual X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 2) X-Spam-Score: -5.7 (-----) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit <at> debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: <debbugs-submit.debbugs.gnu.org> List-Unsubscribe: <http://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe> List-Archive: <http://debbugs.gnu.org/pipermail/debbugs-submit> List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org> List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help> List-Subscribe: <http://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe> Sender: debbugs-submit-bounces <at> debbugs.gnu.org Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org X-Spam-Score: -5.8 (-----) Hi Ralf and all, A new GNU maintainer just asked me about how to use $(pkgdatadir) from his C program. I looked at the Automake manual and didn't see anywhere especially good to point him at :(. A couple thoughts I had as a result of looking at this for him: First, tiny English point in node Optional: < As for `AC_CONFIG_FILES' (*note Requirements::), parts of the > As with ... The main point: although "amhello Explained" talks about AC_CONFIG_HEADERS and gives a partial example, I don't see any "real" description of how to determine what ends up in config.h and what the #define names are. If I'm not just missing something, I suggest a new node, perhaps under "Generalities", which talks about Automake/C linkage, including autoheader, etc. The apparent reference definition for AC_CONFIG_HEADERS (in node "Optional") says nothing about what it really does. It belatedly occurs to me that perhaps this topic is gone into in more detail in the Autoconf manual. I don't have the energy to search through it now, but if that is so, at least a cross-reference to that would be nice. (FWIW, I looked at all occurrences of config\.h and CONFIG_HEADERS in the automake manual.) Subsidiary points: in the general index (I continue to very strongly encourage you to merge all indexes, BTW), I didn't find anything useful for "preprocessor", or "#define", or "config.h", or anything else I could think of. Fortran preprocessing was the only thing. Finally, the "amhello explained" node is pretty long. It seems to break up naturally into three pieces, for each of the files being explained. Perhaps it would be good to make them each separate (sub)nodes. Of course, all the above are just some ideas, please do whatever makes sense and forget the rest. Happy hacking in 2011, karl
karl@HIDDEN (Karl Berry)
:bug-automake@HIDDEN
.
Full text available.owner <at> debbugs.gnu.org, bug-automake@HIDDEN
:bug#7766
; Package automake
.
Full text available.
GNU bug tracking system
Copyright (C) 1999 Darren O. Benham,
1997 nCipher Corporation Ltd,
1994-97 Ian Jackson.