specifying workbook dir for dist-hook

specifying workbook dir for dist-hook

[Thien-Thi Nguyen]

Rob,

since we're moving TODO and BUGS (and maybe in the future other things)
out of guile-core/ into workbook/, it behooves us to figure out how to
get these files back into the tree on release.  apparently, automake
supports "dist-hook", which we currently use in these makefiles:

  ./doc/Makefile.am
  ./guile-readline/Makefile.am

it is easy to add something like:

  dist-hook:
          @echo doing dist-hook...
  if MAINTAINER_MODE
          @echo 'This is a snapshot of the TODO file.' > TODO
          @echo >> TODO
          cat $(workbook)/tasks/TODO >> TODO
          $(workbook)/../scripts/render-bugs $(workbook)/bugs > BUGS
  endif

to top-level Makefile.am.  the question is how to define $(workbook)?
we can either require maintainers to specify this directory like:

  make workbook=some/path/to/workbook dist

or adopt the convention that workbook is always at
$(top_srcdir)/../workbook and codify that in Makefile.am.

so: what is your preference?
    what other files can we factor out of guile-core/?
    where would we put them in workbook/?
    where is a good place to document all this?  (RELEASE?)

if you see where i'm going w/ this, you can obviously make the changes
yourself, but i'm happy to do them for you if given reasonable answers.

thi

_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel

Re: specifying workbook dir for dist-hook

[Thien-Thi Nguyen]

   From: Thien-Thi Nguyen <ttn@giblet.glug.org>
   Date: Wed, 27 Mar 2002 13:17:14 -0800

   or adopt the convention that workbook is always at
   $(top_srcdir)/../workbook and codify that in Makefile.am.

this convention is now provisionally (not set in stone) codified in
guile-core/am/maintainer-dirs and workbook/build/maintainer-dirs.text.

thi

_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel

Re: specifying workbook dir for dist-hook

[Marius Vollmer]

Thien-Thi Nguyen <ttn@giblet.glug.org> writes:

> this convention is now provisionally (not set in stone) codified in
> guile-core/am/maintainer-dirs and workbook/build/maintainer-dirs.text.

I have trouble using this setup with automake 1.4-p4.  For whatever
reason, automake does not allow the inclusion of files containing a
'-' character, and you can't be inside a conditional when including a
file.

What I am seeing is that automake does not interpret the line

    include $(top_srcdir)/am/maintainer-dirs

in guile-core/Makefile.am, and copies it into (effectively) Makefile.
In turn GNU make will interpret the include directive, but does not
understand the "if" in am/maintainer-dirs:

    $ make
    am/maintainer-dirs:32: *** missing separator.  Stop.


I'm about to report this to the automake guys, but wanted to check
first what other people are saying/doing about this.

_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel

Re: specifying workbook dir for dist-hook

[Rob Browning]

Marius Vollmer <mvo@zagadka.ping.de> writes:

> in guile-core/Makefile.am, and copies it into (effectively) Makefile.
> In turn GNU make will interpret the include directive, but does not
> understand the "if" in am/maintainer-dirs:
>
>     $ make
>     am/maintainer-dirs:32: *** missing separator.  Stop.
>
>
> I'm about to report this to the automake guys, but wanted to check
> first what other people are saying/doing about this.

Generally speaking, you might be able to get around it with a level of
variable indirection.

  if FOO
    include ${BAR}
  endif

I've used a similar trick to get around some libtool limitations in
the past...

FWIW

-- 
Rob Browning
rlb @defaultvalue.org, @linuxdevel.com, and @debian.org
Previously @cs.utexas.edu
GPG=1C58 8B2C FB5E 3F64 EA5C  64AE 78FE E5FE F0CB A0AD

_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel

Re: specifying workbook dir for dist-hook

[Thien-Thi Nguyen]

   From: Marius Vollmer <mvo@zagadka.ping.de>
   Date: 01 Apr 2002 02:09:27 +0200

   I'm about to report this to the automake guys, but wanted to check
   first what other people are saying/doing about this.

automake 1.5 seems to work fine.  (debian woody is stuck on
"1:1.4-p4-1.1", i have 1.5 installed in /usr/local.)

how does automake treat pre-inst-guile, then?

thi

_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel

Re: specifying workbook dir for dist-hook

[Neil Jerram]

>>>>> "Marius" == Marius Vollmer <mvo@zagadka.ping.de> writes:

    Marius> What I am seeing is that automake does not interpret the line

    Marius>     include $(top_srcdir)/am/maintainer-dirs

    Marius> in guile-core/Makefile.am, and copies it into (effectively) Makefile.
    Marius> In turn GNU make will interpret the include directive, but does not
    Marius> understand the "if" in am/maintainer-dirs:

    Marius>     $ make
    Marius>     am/maintainer-dirs:32: *** missing separator.  Stop.

Me too.  I'm currently running with the patch below (yes, I know it's
not the RT):

        Neil

Index: Makefile.am
===================================================================
RCS file: /cvsroot/guile/guile/guile-core/Makefile.am,v
retrieving revision 1.26.2.8
diff -u -r1.26.2.8 Makefile.am
--- Makefile.am 31 Mar 2002 10:35:13 -0000      1.26.2.8
+++ Makefile.am 1 Apr 2002 18:47:13 -0000
@@ -39,7 +39,8 @@

 if MAINTAINER_MODE
 # Fill dist tree.
-include $(top_srcdir)/am/maintainer-dirs
+workbook       = $(top_srcdir_absolute)/../workbook
+mscripts       = $(top_srcdir_absolute)/../scripts
 dist-hook:
        ( echo 'This is a snapshot of the TODO file.' ; date ; echo ; \
          cat $(workbook)/tasks/TODO ) > TODO


_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel

Re: specifying workbook dir for dist-hook

[Thien-Thi Nguyen]

   From: Neil Jerram <neil@ossau.uklinux.net>
   Date: 01 Apr 2002 19:47:31 +0100

   Me too.  I'm currently running with the patch below (yes, I know it's
   not the RT):

automake seems to handle "am/pre-inst-guile" fine and i notice that that
file doesn't have "if MAINTAINER_MODE".  perhaps nested "if" clauses are
the real problem.  what happens if you remove "if MAINTAINER_MODE" from
am/maintainer-dirs?

thi

_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel

Re: specifying workbook dir for dist-hook

[Neil Jerram]

>>>>> "Thien-Thi" == Thien-Thi Nguyen <ttn@giblet.glug.org> writes:

    Thien-Thi>    From: Neil Jerram <neil@ossau.uklinux.net>
    Thien-Thi>    Date: 01 Apr 2002 19:47:31 +0100

    Thien-Thi>    Me too.  I'm currently running with the patch below (yes, I know it's
    Thien-Thi>    not the RT):

    Thien-Thi> automake seems to handle "am/pre-inst-guile" fine and i notice that that
    Thien-Thi> file doesn't have "if MAINTAINER_MODE".  perhaps nested "if" clauses are
    Thien-Thi> the real problem.  what happens if you remove "if MAINTAINER_MODE" from
    Thien-Thi> am/maintainer-dirs?

Well you beat me to it, but it seems to be working fine now.  Thanks!

        Neil


_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel

Re: specifying workbook dir for dist-hook

[Marius Vollmer]

Neil Jerram <neil@ossau.uklinux.net> writes:

> >>>>> "Thien-Thi" == Thien-Thi Nguyen <ttn@giblet.glug.org> writes:
> 
>     Thien-Thi> automake seems to handle "am/pre-inst-guile" fine and
>     Thien-Thi> i notice that that file doesn't have "if
>     Thien-Thi> MAINTAINER_MODE".  perhaps nested "if" clauses are
>     Thien-Thi> the real problem.  what happens if you remove "if
>     Thien-Thi> MAINTAINER_MODE" from am/maintainer-dirs?
> 
> Well you beat me to it, but it seems to be working fine now.  Thanks!

Hmm, I'm afraid not.  Automake will still not handle the include
statement properly, but GNU make also has a include statement that
will then include the am/maintainer-dirs file.  As long as no automake
specific things are in this file, this will work.  The original bugs
happens precisely because make stumbles over the if statement that is
intended to be processed by automake.

But if automake 1.5 fixes the bug (I haven't checked yet), then we can
just require it.

_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel

Re: specifying workbook dir for dist-hook

[Thien-Thi Nguyen]

   From: Marius Vollmer <mvo@zagadka.ping.de>
   Date: 03 Apr 2002 20:43:15 +0200

   The original bugs happens precisely because make stumbles over the if
   statement that is intended to be processed by automake.

this is fixed in cvs, i believe (am/maintainer-dirs no longer uses "if
MAINTAINER_MODE").

thi

_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel

Re: specifying workbook dir for dist-hook

[Marius Vollmer]

Thien-Thi Nguyen <ttn@giblet.glug.org> writes:

> this is fixed in cvs, i believe (am/maintainer-dirs no longer uses "if
> MAINTAINER_MODE").

Is this a real fix?  As far as I can see, it only works 'accidentally'
when using GNU make.  Do we want to require GNU make?

_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel

Re: specifying workbook dir for dist-hook

[Thien-Thi Nguyen]

   From: Marius Vollmer <mvo@zagadka.ping.de>
   Date: 07 Apr 2002 15:04:13 +0200

   Is this a real fix?  As far as I can see, it only works 'accidentally'
   when using GNU make.  Do we want to require GNU make?

the mechanisms and times are as follows:

* automake scanning happens at autogen.sh time.  automake instantiates a
  Makefile.in from templates, handling "include" directives by diverting
  (recursively) scanning to the included file and omitting the directive
  in the output, and handling "if MAINTAINER_MODE" sections by prefixing
  "@MAINTAINER_MODE_TRUE@" to makefile var definitions (and using other
  generally portable constructs).

* expansion of @MAINTAINER_MODE_TRUE@ happens at configure time.
  configure creates portable Makefile from portable Makefile.in, etc.

* execution of Makefile actions happens at make time by whichever
  make(1) is either available on the system or specified by the user.

here, the root cause of the bug seems to lie in how automake handles
nested "if MAINTAINER_MODE" sections.

because we see different behaviors in different versions of automake and
because the documentation does not explicitly support our funky usage, i
figured that the most slackful fix would be to "don't do that"; the
nature of the fix is to fall back on well-supported (documented, stable)
automake features and avoid conflating them.

you'll also note from point 1 above that none of this has anything to do
w/ GNU make (thankfully :-).

thi

_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel

Re: specifying workbook dir for dist-hook

[Marius Vollmer]

Thien-Thi Nguyen <ttn@giblet.glug.org> writes:

> * automake scanning happens at autogen.sh time.  automake instantiates a
>   Makefile.in from templates, handling "include" directives by diverting
>   (recursively) scanning to the included file and omitting the directive
>   in the output, and handling "if MAINTAINER_MODE" sections by prefixing
>   "@MAINTAINER_MODE_TRUE@" to makefile var definitions (and using other
>   generally portable constructs).

However, automake-1.4-p4 incorrectly does _not_ handle include
directives with filenames that contain a '-'.  It copies these lines
unchanged to the Makefile.in.

Automake 1.5 handles them correctly.

> here, the root cause of the bug seems to lie in how automake handles
> nested "if MAINTAINER_MODE" sections.

Automake 1.5 handles inclusions inside ifs correctly.

> you'll also note from point 1 above that none of this has anything to do
> w/ GNU make (thankfully :-).

It has, unfortunately, because GNU make also handles include
directives and thus covers up for the bug in automake 1.4.  It will
execute the include directive that automake missed.


Sooo, I'd say we should just require automake 1.5.

I'm in the process of committing some fixes that will make us survive
a "distcheck" with automake 1.5.  That version seems to put more
restrictive (but reasonable) permissions on the created distdirs and
not all our dist-hooks play nice.  It also fails to handle 'deep'
directories in EXTRA_DIST properly, something which 1.4 had no problem
with.  Ach, the joys of software...

_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel

Re: specifying workbook dir for dist-hook

[Thien-Thi Nguyen]

   From: Marius Vollmer <mvo@zagadka.ping.de>
   Date: 08 Apr 2002 02:06:14 +0200

   However, automake-1.4-p4 incorrectly does _not_ handle include
   directives with filenames that contain a '-'.  It copies these lines
   unchanged to the Makefile.in.

hmmm, i don't understand how "-" is a problem since there is also
"pre-inst-guile" (see libguile/Makefile.am), which has worked fine for
months.  what you see may be because of other reasons (i gave my best
guesses already, only automake hackers can really say).

   > you'll also note from point 1 above that none of this has anything to do
   > w/ GNU make (thankfully :-).

   It has, unfortunately, because GNU make also handles include
   directives and thus covers up for the bug in automake 1.4.  It will
   execute the include directive that automake missed.

sorry i wasn't clear; root cause is w/ (mis-use of) automake, not GNU
make.  i agree that requiring GNU make is certainly not acceptable.
(supposedly that's why we use these auto* tools.)

   Sooo, I'd say we should just require automake 1.5.

sounds reasonable.  i remember HACKING used to list tool versions, but
that isn't the case presently.

thi

_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel

Re: specifying workbook dir for dist-hook

[Marius Vollmer]

Thien-Thi Nguyen <ttn@giblet.glug.org> writes:

>    From: Marius Vollmer <mvo@zagadka.ping.de>
>    Date: 08 Apr 2002 02:06:14 +0200
> 
>    However, automake-1.4-p4 incorrectly does _not_ handle include
>    directives with filenames that contain a '-'.  It copies these lines
>    unchanged to the Makefile.in.
> 
> hmmm, i don't understand how "-" is a problem since there is also
> "pre-inst-guile" (see libguile/Makefile.am), which has worked fine for
> months.

pre-inst-guile works because GNU make will handle the include
statement and pre-inst-guile does not contain anything that needs to
be seen by automake.

Thus, pre-inst-guile only works when using a make that knows how to
handle a include directive.

> what you see may be because of other reasons (i gave my best guesses
> already, only automake hackers can really say).

You could also try to read the automake sources (although they are in
Perl ;).  You will see that the PATH_PATTERN of automake 1.4 does not
match names with a '-' in it.

>    Sooo, I'd say we should just require automake 1.5.
> 
> sounds reasonable.  i remember HACKING used to list tool versions, but
> that isn't the case presently.

It doesn't?  Why?

_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel

Re: specifying workbook dir for dist-hook

[Thien-Thi Nguyen]

   From: Marius Vollmer <mvo@zagadka.ping.de>
   Date: 08 Apr 2002 18:28:22 +0200

   pre-inst-guile works because GNU make will handle the include
   statement and pre-inst-guile does not contain anything that needs to
   be seen by automake.

   Thus, pre-inst-guile only works when using a make that knows how to
   handle a include directive.

i don't see any "include" in Makefile.in for pre-inst-guile, for make to
handle.  perhaps this is only available w/ automake 1.5.

   It doesn't?  Why?

that's a good question.

thi

_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel

Re: specifying workbook dir for dist-hook

[Thien-Thi Nguyen]

   From: Thien-Thi Nguyen <ttn@giblet.glug.org>
   Date: Mon, 08 Apr 2002 12:26:01 -0700

   perhaps this is only available w/ automake 1.5.

which is what you were trying to get into my thick skull before, i see
now.  sigh.  i think my ego has gotten out of control in the past few
months and needs to be severely curtailed, lest i commit more stupid
oversights like this.  thanks for helping me to see this.

humbly yours,
thi

_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel

Re: specifying workbook dir for dist-hook

[Marius Vollmer]

Thien-Thi Nguyen <ttn@giblet.glug.org> writes:

> which is what you were trying to get into my thick skull before, i see
> now.  sigh.  i think my ego has gotten out of control in the past few
> months and needs to be severely curtailed, lest i commit more stupid
> oversights like this.  thanks for helping me to see this.

Heh, no problem, no harm done.  I'm like that myself at times...

_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel

Re: specifying workbook dir for dist-hook

[Marius Vollmer]

Thien-Thi Nguyen <ttn@giblet.glug.org> writes:

>    It doesn't?  Why?
> 
> that's a good question.

I'll go and ask Gary Houston, who removed them.

_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel

Re: specifying workbook dir for dist-hook

[Thien-Thi Nguyen]

   From: Marius Vollmer <mvo@zagadka.ping.de>
   Date: 01 Apr 2002 02:09:27 +0200

   I have trouble using this setup with automake 1.4-p4.

on the one hand, automake info node "Conditionals" sez (wrt nesting):

    You may only test a single variable in an `if' statement, possibly
 negated using `!'.  The `else' statement may be omitted.  Conditionals
 may be nested to any depth.  You may specify an argument to `else' in
 which case it must be the negation of the condition used for the
 current `if'.  Similarly you may specify the condition which is closed
 by an `end':

on the other hand, info node "Include" sez:

    Note that if a fragment is included inside a conditional, then the
 condition applies to the entire contents of that fragment.

so it looks like included am/* files should not use conditionals as it
might be excluded from automake's scanning (although this is not
explicitly stated; it all depends on which order automake does these
sub-operations).

in any case, i've removed "if MAINTAINER_MODE" from am/maintainer-dirs
and updated workbook/build/maintainer-dirs.text.  sorry for the hiccup.

thi

_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel