GNU bug report logs - #34201
Make @setfilename optional in Texinfo files

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 34201 in the body.
You can then email your comments to 34201 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: Gavin Smith <gavinsmith0123 <at> gmail.com>
To: bug-automake <at> gnu.org
Subject: Make @setfilename optional in Texinfo files
Date: Fri, 25 Jan 2019 21:22:33 +0000

@setfilename should not be required to occur inside Texinfo files, as it 
makes it harder to get them working.

Earlier on this:
https://lists.gnu.org/archive/html/automake/2015-09/msg00000.html

Here is a patch.  I added a test which is passing now, but it wasn't 
passing when I first added the test, so am not sure if it is written 
correctly.  I based it on the existing test 
t/txinfo-setfilename-repeated.sh.

It says GPL version 2 in the licence because that's what was in the 
existing tests, although they should probably all be version 3.

ChangeLog entry:

Do not require @setfilename in Texinfo files.

* bin/automake.in (scan_texinfo_file): Derive name of info file from 
name of input file if no @setfilename line occurs in the file.
* t/texinfo-no-setfilename.sh: New test.

diff --git a/bin/automake.in b/bin/automake.in
index b4ae8f4..01e6a58 100644
--- a/bin/automake.in
+++ b/bin/automake.in
@@ -3083,8 +3083,10 @@ sub scan_texinfo_file
 
   if (! $outfile)
     {
-      err_am "'$filename' missing \@setfilename";
-      return;
+      # Replace a .texi extension with .info
+      $outfile = basename($filename);
+      $outfile =~ s/\.[^.]+$//;
+      $outfile .= '.info';
     }
 
   return ($outfile, $vfile);
diff --git a/t/list-of-tests.mk b/t/list-of-tests.mk
index 84dd29a..32fca84 100644
--- a/t/list-of-tests.mk
+++ b/t/list-of-tests.mk
@@ -1214,6 +1214,7 @@ t/txinfo-no-clutter.sh \
 t/txinfo-no-extra-dist.sh \
 t/txinfo-no-installinfo.sh \
 t/txinfo-no-repeated-targets.sh \
+t/txinfo-no-setfilename.sh \
 t/txinfo-other-suffixes.sh \
 t/txinfo-override-infodeps.sh \
 t/txinfo-override-texinfo-tex.sh \
diff --git a/t/txinfo-no-setfilename.sh b/t/txinfo-no-setfilename.sh
new file mode 100644
index 0000000..3ef1730
--- /dev/null
+++ b/t/txinfo-no-setfilename.sh
@@ -0,0 +1,35 @@
+#! /bin/sh
+# Copyright (C) 2019 Free Software Foundation, Inc.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2, or (at your option)
+# any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+# Check Texinfo files work without a @setfilename line
+
+. test-init.sh
+
+cat > Makefile.am << 'END'
+info_TEXINFOS = file.texi
+END
+
+cat > file.texi << 'END'
+contents
+END
+
+$ACLOCAL
+$AUTOMAKE --add-missing
+
+
+grep 'file.info:' Makefile.in
+
+:

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

From: Gavin Smith <gavinsmith0123 <at> gmail.com>
To: 34201 <at> debbugs.gnu.org
Cc: Automake Mailing List <automake <at> gnu.org>
Subject: Re: bug#34201: Make @setfilename optional in Texinfo files
Date: Sun, 31 Mar 2019 14:33:38 +0100

Is there anybody who has time to look at this issue? The requirement
for a @setfilename line is an unnecessary hurdle to getting Texinfo
and Automake working together. It has been unnecessary for several
years now.

I have a copyright assignment in place for Automake with the FSF, so
all that would be needed would be for someone to have a look at this
patch and apply it for the next Automake release.

On 1/25/19, Gavin Smith <gavinsmith0123 <at> gmail.com> wrote:
> @setfilename should not be required to occur inside Texinfo files, as it
> makes it harder to get them working.
>
> Earlier on this:
> https://lists.gnu.org/archive/html/automake/2015-09/msg00000.html
>
> Here is a patch.  I added a test which is passing now, but it wasn't
> passing when I first added the test, so am not sure if it is written
> correctly.  I based it on the existing test
> t/txinfo-setfilename-repeated.sh.
>
> It says GPL version 2 in the licence because that's what was in the
> existing tests, although they should probably all be version 3.
>
> ChangeLog entry:
>
> Do not require @setfilename in Texinfo files.
>
> * bin/automake.in (scan_texinfo_file): Derive name of info file from
> name of input file if no @setfilename line occurs in the file.
> * t/texinfo-no-setfilename.sh: New test.
>
> diff --git a/bin/automake.in b/bin/automake.in
> index b4ae8f4..01e6a58 100644
> --- a/bin/automake.in
> +++ b/bin/automake.in
> @@ -3083,8 +3083,10 @@ sub scan_texinfo_file
>
>    if (! $outfile)
>      {
> -      err_am "'$filename' missing \@setfilename";
> -      return;
> +      # Replace a .texi extension with .info
> +      $outfile = basename($filename);
> +      $outfile =~ s/\.[^.]+$//;
> +      $outfile .= '.info';
>      }
>
>    return ($outfile, $vfile);
> diff --git a/t/list-of-tests.mk b/t/list-of-tests.mk
> index 84dd29a..32fca84 100644
> --- a/t/list-of-tests.mk
> +++ b/t/list-of-tests.mk
> @@ -1214,6 +1214,7 @@ t/txinfo-no-clutter.sh \
>  t/txinfo-no-extra-dist.sh \
>  t/txinfo-no-installinfo.sh \
>  t/txinfo-no-repeated-targets.sh \
> +t/txinfo-no-setfilename.sh \
>  t/txinfo-other-suffixes.sh \
>  t/txinfo-override-infodeps.sh \
>  t/txinfo-override-texinfo-tex.sh \
> diff --git a/t/txinfo-no-setfilename.sh b/t/txinfo-no-setfilename.sh
> new file mode 100644
> index 0000000..3ef1730
> --- /dev/null
> +++ b/t/txinfo-no-setfilename.sh
> @@ -0,0 +1,35 @@
> +#! /bin/sh
> +# Copyright (C) 2019 Free Software Foundation, Inc.
> +#
> +# This program is free software; you can redistribute it and/or modify
> +# it under the terms of the GNU General Public License as published by
> +# the Free Software Foundation; either version 2, or (at your option)
> +# any later version.
> +#
> +# This program is distributed in the hope that it will be useful,
> +# but WITHOUT ANY WARRANTY; without even the implied warranty of
> +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
> +# GNU General Public License for more details.
> +#
> +# You should have received a copy of the GNU General Public License
> +# along with this program.  If not, see <https://www.gnu.org/licenses/>.
> +
> +# Check Texinfo files work without a @setfilename line
> +
> +. test-init.sh
> +
> +cat > Makefile.am << 'END'
> +info_TEXINFOS = file.texi
> +END
> +
> +cat > file.texi << 'END'
> +contents
> +END
> +
> +$ACLOCAL
> +$AUTOMAKE --add-missing
> +
> +
> +grep 'file.info:' Makefile.in
> +
> +:
>
>
>
>

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

From: Jim Meyering <jim <at> meyering.net>
To: automake-patches <at> gnu.org, Gavin Smith <gavinsmith0123 <at> gmail.com>, 
 Karl Berry <karl <at> freefriends.org>, 36921 <at> debbugs.gnu.org, 34201 <at> debbugs.gnu.org
Subject: [PATCH] automake: do not require @setfilename in Texinfo files
Date: Mon, 2 Sep 2019 10:27:28 -0700

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

Gavin Smith proposed a patch for this back in http://bugs.gnu.org/34201
Another reference to the problem: http://bugs.gnu.org/36921

In the attached (in Gavin's name), I've added a NEWS entry and
adjusted the ChangeLog entry. Will push in a day or so if no comment.

[automake-relax-setfilename.diff (application/octet-stream, attachment)]

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

From: Mathieu Lirzin <mthl <at> gnu.org>
To: Jim Meyering <jim <at> meyering.net>
Cc: 34201 <at> debbugs.gnu.org, Gavin Smith <gavinsmith0123 <at> gmail.com>,
 36921 <at> debbugs.gnu.org, automake-patches <at> gnu.org,
 Karl Berry <karl <at> freefriends.org>
Subject: Re: [PATCH] automake: do not require @setfilename in Texinfo files
Date: Tue, 03 Sep 2019 09:53:34 +0200

Hello Jim,

Jim Meyering <jim <at> meyering.net> writes:

> Gavin Smith proposed a patch for this back in http://bugs.gnu.org/34201
> Another reference to the problem: http://bugs.gnu.org/36921
>
> In the attached (in Gavin's name), I've added a NEWS entry and
> adjusted the ChangeLog entry. Will push in a day or so if no comment.

Thanks for taking care of this. :-)

> From 309a6c477eec80b847078699303c65ccd7787eb0 Mon Sep 17 00:00:00 2001
> From: Gavin Smith <gavinsmith0123 <at> gmail.com>
> Date: Sun, 25 Aug 2019 21:07:58 -0700
> Subject: [PATCH] automake: do not require @setfilename in Texinfo files
>
> Texinfo no longer requires a @setfilename directive in each
> .texi file, so automake now also relaxes its restriction.
> * bin/automake.in (scan_texinfo_file): Derive name of info file from
> name of input file if no @setfilename line occurs in the file.
> * t/txinfo-no-setfilename.sh: New test.
> * t/list-of-tests.mk: Add it.
> * NEWS: Mention it.
>
> Fixes automake bugs #36921 and #34201.
> ---

Not really important but HACKING <Writing a good commit message>
recommends a slightly different style.

--8<---------------cut here---------------start------------->8---
      topic: brief description (this is the "summary line")

      <reference to relevant bugs, if any>

      Here goes a more detailed explanation of why the commit is needed,
      and a general overview of what it does, and how.  This section
      should almost always be provided, possibly only with the expection
      of obvious fixes or very trivial changes.

      And if the detailed explanation is quite long or detailed, you can
      want to break it in more paragraphs.

      Then you can add references to relevant mailing list discussions
      (if any), with proper links.  But don't take this as an excuse for
      writing incomplete commit messages!  The "distilled" conclusions
      reached in such discussions should have been placed in the
      paragraphs above.

      Finally, here you can thank people that motivated or helped the
      change.  So, thanks to John Doe for bringing up the issue, and to
      J. Random Hacker for providing suggestions and testing the patch.

      <detailed list of touched files>
--8<---------------cut here---------------end--------------->8---

-- 
Mathieu Lirzin
GPG: F2A3 8D7E EB2B 6640 5761  070D 0ADE E100 9460 4D37

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

From: Gavin Smith <gavinsmith0123 <at> gmail.com>
To: Jim Meyering <jim <at> meyering.net>
Cc: 34201 <at> debbugs.gnu.org, 36921 <at> debbugs.gnu.org, automake-patches <at> gnu.org,
 Karl Berry <karl <at> freefriends.org>
Subject: Re: bug#34201: [PATCH] automake: do not require @setfilename in
 Texinfo files
Date: Sat, 14 Sep 2019 13:34:35 +0100

On Mon, Sep 2, 2019 at 6:28 PM Jim Meyering <jim <at> meyering.net> wrote:
>
> Gavin Smith proposed a patch for this back in http://bugs.gnu.org/34201
> Another reference to the problem: http://bugs.gnu.org/36921
>
> In the attached (in Gavin's name), I've added a NEWS entry and
> adjusted the ChangeLog entry. Will push in a day or so if no comment.

Thanks for taking the time to look at this.

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

From: Jim Meyering <jim <at> meyering.net>
To: Gavin Smith <gavinsmith0123 <at> gmail.com>
Cc: 34201 <at> debbugs.gnu.org, 36921 <at> debbugs.gnu.org, automake-patches <at> gnu.org,
 Karl Berry <karl <at> freefriends.org>
Subject: Re: bug#34201: [PATCH] automake: do not require @setfilename in
 Texinfo files
Date: Sun, 15 Sep 2019 09:57:03 -0700

On Sat, Sep 14, 2019 at 5:35 AM Gavin Smith <gavinsmith0123 <at> gmail.com> wrote:
> On Mon, Sep 2, 2019 at 6:28 PM Jim Meyering <jim <at> meyering.net> wrote:
> >
> > Gavin Smith proposed a patch for this back in http://bugs.gnu.org/34201
> > Another reference to the problem: http://bugs.gnu.org/36921
> >
> > In the attached (in Gavin's name), I've added a NEWS entry and
> > adjusted the ChangeLog entry. Will push in a day or so if no comment.
>
> Thanks for taking the time to look at this.

Oh! Thanks for the reminder. I've just pushed that.

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

From: Karl Berry <karl <at> freefriends.org>
To: 34201-done <at> debbugs.gnu.org
Date: Sun, 14 Feb 2021 19:24:02 -0700

Previous Next

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