GNU bug report logs - #7828
Documentation about '-d' in AM_YFLAGS is suboptimal

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 7828 in the body.
You can then email your comments to 7828 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Юрий Пухальский <aikipooh <at> gmail.com>
To: bug-automake <at> gnu.org, Ralf.Wildenhues <at> gmx.de
Subject: Fwd: header file from yacc doesn't go to a distribution (automake
	1.11)
Date: Wed, 12 Jan 2011 12:21:19 +0300

Package isn't enclosed because otherwise the message doesn't get through.

> Finally had time to make some tests, and now i've got it:)
>
> When i set AM_YFLAGS to -dt it doesn't distribute a header, probably
> because it's searching for -d to be alone.
> When i set AM_YFLAGS = -d -t, it works.
>
> A small test package enclosed.
>
> 2010/8/1 Ralf Wildenhues <Ralf.Wildenhues <at> gmx.de>:
>> Hi Юрий,
>>
>> * Юрий Пухальский wrote on Wed, Jul 28, 2010 at 03:38:11PM CEST:
>>> In the documentation it's stated that "The intermediate files
>>> generated by yacc (or lex) will be included in any distribution that
>>> is made. That way the user doesn't need to have yacc or lex."
>>> But albeit the .c files are included, the corresponding .h file isn't.
>>>
>>> Likewise there is no rule to build a missing header file.
>>
>> Please show a small example where this fails for you.
>>
>> Thanks,
>> Ralf
>>
>
>
>
> --
> «The good thing about standards is there are so many to choose from.»
>



-- 
«The good thing about standards is there are so many to choose from.»

Message #8 received at 7828 <at> debbugs.gnu.org (full text, mbox):

From: Stefano Lattarini <stefano.lattarini <at> gmail.com>
To: automake-patches <at> gnu.org
Cc: Юрий Пухальский <aikipooh <at> gmail.com>,
	Ralf.Wildenhues <at> gmx.de, 7828 <at> debbugs.gnu.org
Subject: documentation about '-d' in AM_YFLAGS is suboptimal (was: bug#7828:
	Fwd: header file from yacc doesn't go to a distribution
	(automake 1.11))
Date: Wed, 12 Jan 2011 13:36:08 +0100

[Message part 1 (text/plain, inline)]

Hello Юрий.

In the future, please don't open a new thread to reply to a message of a
previous thread, as this will create a new unrelated bug report in the
Automake bug tracker.  Unless, of course, you deliberately want to open
a new bug report that has originated from a previous discussion -- this
is fully legitimate.

Thank you.

That said ...

On Wednesday 12 January 2011, Юрий Пухальский wrote:
> Package isn't enclosed because otherwise the message doesn't get through.
> 
> > Finally had time to make some tests, and now i've got it:)
> >
> > When i set AM_YFLAGS to -dt it doesn't distribute a header, probably
> > because it's searching for -d to be alone.
> > When i set AM_YFLAGS = -d -t, it works.
> >
... I agree the documentation might be clearer about this.

Ralf, what about the attached patch (for 'yacc-work' and 'maint')?
Tested with "make pdf ps dvi html MAKEINFOFLAGS=--no-split".  The
output in all forms looked fine.

Regards,
  Stefano

[0001-docs-clustered-d-not-recognized-in-YFLAGS.patch (text/x-patch, inline)]

From cf43febea57a25173e665e2c610b1ccafdd26b01 Mon Sep 17 00:00:00 2001
From: Stefano Lattarini <stefano.lattarini <at> gmail.com>
Date: Wed, 12 Jan 2011 13:23:59 +0100
Subject: [PATCH] docs: clustered '-d' not recognized in YFLAGS
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This commit fixes automake bug#7828.

* doc/automake.texi (Yacc and Lex): Tell that automake recognizes
'-d' in AM_YFLAGS only if it's not clusterd with other options.
From a report by �������� ��������������������.
---
 ChangeLog         |    8 ++++++++
 doc/automake.texi |    7 ++++++-
 2 files changed, 14 insertions(+), 1 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index bf44677..eebc559 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2011-01-12   Stefano Lattarini  <stefano.lattarini <at> gmail.com>
+
+	docs: clustered '-d' not recognized in YFLAGS
+	This change fixes automake bug#7828.
+	* doc/automake.texi (Yacc and Lex): Tell that automake recognizes
+	'-d' in AM_YFLAGS only if it's not clusterd with other options.
+	From a report by �������� ��������������������.
+
 2011-01-02   Stefano Lattarini  <stefano.lattarini <at> gmail.com>
 
 	* NEWS: Fix typo (forgotten word).
diff --git a/doc/automake.texi b/doc/automake.texi
index 43ad581..1561ad5 100644
--- a/doc/automake.texi
+++ b/doc/automake.texi
@@ -6078,7 +6078,12 @@ intended for the @file{Makefile.am} author.
 @code{AM_YFLAGS} is usually used to pass the @option{-d} option to
 @command{yacc}.  Automake knows what this means and will automatically
 adjust its rules to update and distribute the header file built by
-@samp{yacc -d}.  What Automake cannot guess, though, is where this
+@samp{yacc -d}@footnote{Please note that @command{automake} recognizes
+@option{-d} in @code{AM_YFLAGS} only if it is not clustered with other
+options; for example, it won't be recognized if @code{AM_YFLAGS} is
+@samp{-dt}, but it will be if @code{AM_YFLAGS} is @samp{-d -t} or
+@samp{-t -d}.}.
+What Automake cannot guess, though, is where this
 header will be used: it is up to you to ensure the header gets built
 before it is first used.  Typically this is necessary in order for
 dependency tracking to work when the header is included by another
-- 
1.7.2.3

Message #15 received at 7828 <at> debbugs.gnu.org (full text, mbox):

From: Юрий Пухальский <aikipooh <at> gmail.com>
To: 7828 <at> debbugs.gnu.org
Subject: Fwd: header file from yacc doesn't go to a distribution (automake
	1.11)
Date: Wed, 12 Jan 2011 12:26:38 +0300

[Message part 1 (text/plain, inline)]

Test package.

[test-1.0.tar.gz (application/x-gzip, attachment)]

Message #18 received at 7828 <at> debbugs.gnu.org (full text, mbox):

From: Ralf Wildenhues <Ralf.Wildenhues <at> gmx.de>
To: Stefano Lattarini <stefano.lattarini <at> gmail.com>
Cc: Юрий Пухальский <aikipooh <at> gmail.com>,
	automake-patches <at> gnu.org, 7828 <at> debbugs.gnu.org
Subject: Re: documentation about '-d' in AM_YFLAGS is suboptimal
Date: Wed, 12 Jan 2011 19:24:10 +0100

* Stefano Lattarini wrote on Wed, Jan 12, 2011 at 01:36:08PM CET:
> On Wednesday 12 January 2011, Юрий Пухальский wrote:
> > Package isn't enclosed because otherwise the message doesn't get through.
> > 
> > > Finally had time to make some tests, and now i've got it:)
> > >
> > > When i set AM_YFLAGS to -dt it doesn't distribute a header, probably
> > > because it's searching for -d to be alone.
> > > When i set AM_YFLAGS = -d -t, it works.
> > >
> ... I agree the documentation might be clearer about this.
> 
> Ralf, what about the attached patch (for 'yacc-work' and 'maint')?
> Tested with "make pdf ps dvi html MAKEINFOFLAGS=--no-split".  The
> output in all forms looked fine.

OK with nits addressed.

Thanks!
Ralf

> From cf43febea57a25173e665e2c610b1ccafdd26b01 Mon Sep 17 00:00:00 2001
> From: Stefano Lattarini <stefano.lattarini <at> gmail.com>
> Date: Wed, 12 Jan 2011 13:23:59 +0100
> Subject: [PATCH] docs: clustered '-d' not recognized in YFLAGS
> MIME-Version: 1.0
> Content-Type: text/plain; charset=UTF-8
> Content-Transfer-Encoding: 8bit
> 
> This commit fixes automake bug#7828.
> 
> * doc/automake.texi (Yacc and Lex): Tell that automake recognizes

s/Tell/Document/
("tell" is rarely a good choice in written text.  I don't know why.)

> '-d' in AM_YFLAGS only if it's not clusterd with other options.

clustered

> From a report by ???????? ????????????????????.

My email client renders this as a bunch of question marks only.  Please
ensure that both the git log entry and the ChangeLog entry are properly
encoded in UTF-8.

> --- a/doc/automake.texi
> +++ b/doc/automake.texi
> @@ -6078,7 +6078,12 @@ intended for the @file{Makefile.am} author.
>  @code{AM_YFLAGS} is usually used to pass the @option{-d} option to
>  @command{yacc}.  Automake knows what this means and will automatically
>  adjust its rules to update and distribute the header file built by
> -@samp{yacc -d}.  What Automake cannot guess, though, is where this
> +@samp{yacc -d}@footnote{Please note that @command{automake} recognizes
> +@option{-d} in @code{AM_YFLAGS} only if it is not clustered with other
> +options; for example, it won't be recognized if @code{AM_YFLAGS} is
> +@samp{-dt}, but it will be if @code{AM_YFLAGS} is @samp{-d -t} or
> +@samp{-t -d}.}.

Generally, @footnote's should be used sparingly, as they disrupt the
flow of reading and don't render well in the info output.  I guess it's
acceptable here though.

Please use @option for denoting the options here.

> +What Automake cannot guess, though, is where this
>  header will be used: it is up to you to ensure the header gets built
>  before it is first used.  Typically this is necessary in order for
>  dependency tracking to work when the header is included by another

Message #23 received at 7828-done <at> debbugs.gnu.org (full text, mbox):

From: Stefano Lattarini <stefano.lattarini <at> gmail.com>
To: Ralf Wildenhues <Ralf.Wildenhues <at> gmx.de>
Cc:  Пухальский
	<aikipooh <at> gmail.com>, 7828-done <at> debbugs.gnu.org,
	Юрий, automake-patches <at> gnu.org
Subject: Re: documentation about '-d' in AM_YFLAGS is suboptimal
Date: Wed, 12 Jan 2011 23:57:55 +0100

On Wednesday 12 January 2011, Ralf Wildenhues wrote:
> 
> OK with nits addressed.
> 
> Thanks!
> Ralf
>
> [CUT]
> 
> > From a report by ???????? ????????????????????.
> 
> My email client renders this as a bunch of question marks only.  Please
> ensure that both the git log entry and the ChangeLog entry are properly
> encoded in UTF-8.
>
They should be (they both looks ok in vim with :set enc=utf-8).

> > --- a/doc/automake.texi
> > +++ b/doc/automake.texi
> > @@ -6078,7 +6078,12 @@ intended for the @file{Makefile.am} author.
> >  @code{AM_YFLAGS} is usually used to pass the @option{-d} option to
> >  @command{yacc}.  Automake knows what this means and will automatically
> >  adjust its rules to update and distribute the header file built by
> > -@samp{yacc -d}.  What Automake cannot guess, though, is where this
> > +@samp{yacc -d}@footnote{Please note that @command{automake} recognizes
> > +@option{-d} in @code{AM_YFLAGS} only if it is not clustered with other
> > +options; for example, it won't be recognized if @code{AM_YFLAGS} is
> > +@samp{-dt}, but it will be if @code{AM_YFLAGS} is @samp{-d -t} or
> > +@samp{-t -d}.}.
> 
> Generally, @footnote's should be used sparingly, as they disrupt the
> flow of reading and don't render well in the info output.  I guess it's
> acceptable here though.
> 
> Please use @option for denoting the options here.
>
OK.  Sorry for the noise, but for some stupid reason I thought that using
@option with more (whitespace-separated) arguments was inappropriate.  Go
figure.

Merged into maint and yacc-work, and merged both into master.

Thanks,
  Stefano

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.