Re: [PATCH] texi: info files can be generated in the builddir

[Stefano Lattarini]

On 01/02/2013 12:11 AM, Stefano Lattarini wrote:
> References:
> <http://lists.gnu.org/archive/html/automake-patches/2012-12/msg00107.html>
> <http://lists.gnu.org/archive/html/automake-patches/2012-12/msg00125.html>
> 
> On 12/31/2012 07:45 PM, Stefano Lattarini wrote:
>> On 12/31/2012 11:02 AM, Stefano Lattarini wrote:
>>> See the commit messages of the individual patches for rationales and
>>> background.  I plan to push this series to master in 72 hours.
>>>
>>> Stefano Lattarini (3):
>>>   texinfo: info files can be generated in the builddir
>>>   docs: document the new 'info-in-builddir' option
>>>   texinfo: remove hack about info files in CLEANFILES variables
>>>
>> Actually, I think it might make sense to apply the first two patches
>> to maint (after the 1.13.1 bug-fixing release is out).  This should
>> be OK, since the change itself is very unobtrusive and no possible
>> source of bugs (Murphy spare me for having said so :-).  In addition,
>> having this new option earlier will allow a proper deprecation of the
>> old CLEANFILES hack, so that its final removal in Automake 1.14 won't
>> be too abrupt.
>>
>> Opinions, objections?
>>
> OK, so here is the first patch for maint, that I hope to get into
> Automake 1.13.2.  I will push it in a couple of days if there is no
> review by then.  The deprecation of the obsolescent "CLEANFILES hack"
> (that too for maint) and its removal (that for master only, to appear
> as part of 1.14) will follow at leisure.
> 
> Thanks,
>   Stefano
> 
> ---- 8< ---- 8< ---- 8< ---- 8< ---- 8< ---- 8< ---- 8< ---- 8< ---- 8< ----
> 
> From 36ee783a1000b5a1e52b81e5564de19ffb99fd37 Mon Sep 17 00:00:00 2001
> Message-Id: <address@hidden>
> From: Stefano Lattarini <address@hidden>
> Date: Tue, 3 Apr 2012 22:02:55 +0200
> Subject: [PATCH] texi: info files can be generated in the builddir
> 
> User can now ask info files to be built in the $(builddir), rather than
> the $(srcdir), by specifying the Automake option 'info-in-builddir'.
> This feature was requested by the developers of GCC, GDB, GNU binutils
> and the GNU bfd library.  See the extensive discussion about automake
> bug#11034 for more details.
> 
> OK, to be honest, having '.info' files built in the builddir was
> *already* possible, but only using ugly and undocumented hacks involving
> definition of the CLEANFILES and/or DISTCLEANFILES.  For example, the
> binutils project did something like this in the relevant 'Makefile.am':
> 
>     # Automake 1.9 will only build info files in the objdir if they are
>     # mentioned in DISTCLEANFILES.  It doesn't have to be unconditional,
>     # though, so we use a bogus condition.
>     if GENINSRC_NEVER
>     DISTCLEANFILES = binutils.info
>     endif
> 
> See also the extensive discussion about automake bug#11034; in
> particular, the following messages:
> <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=11034#65>
> <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=11034#80>
> <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=11034#86>
> <http://debbugs.gnu.org/cgi/bugreport.cgi?bug=11034#101>
> 
> * lib/Automake/Options.pm (_is_valid_easy_option): Recognize the
> new 'info-in-builddir' option.
> * automake.in (handle_texinfo_helper): If that option is set,
> initialize '$insrc' to '0', so that info files will be generated
> in the builddir.  Adjust comments to match.
> * t/txinfo-builddir.sh: New test.
> * t/list-of-tests.mk: Add it.
> * NEWS: Update.
> * doc/automake.texi: Document the new options.
> 
Merged into maint.  This change will appear in Automake 1.13.2.

Regards,
  Stefano