[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[6842] mention that @setfilename may still be required
From: |
Gavin D. Smith |
Subject: |
[6842] mention that @setfilename may still be required |
Date: |
Tue, 08 Dec 2015 11:59:14 +0000 |
Revision: 6842
http://svn.sv.gnu.org/viewvc/?view=rev&root=texinfo&revision=6842
Author: gavin
Date: 2015-12-08 11:58:51 +0000 (Tue, 08 Dec 2015)
Log Message:
-----------
mention that @setfilename may still be required
Modified Paths:
--------------
trunk/ChangeLog
trunk/doc/texinfo.texi
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2015-12-07 20:29:14 UTC (rev 6841)
+++ trunk/ChangeLog 2015-12-08 11:58:51 UTC (rev 6842)
@@ -1,3 +1,8 @@
+2015-12-08 Gavin Smith <address@hidden>
+
+ * doc/texinfo.texi (@setfilename): Some reordering. Mention
+ that @setfilename may still be required.
+
2015-11-27 Gavin Smith <address@hidden>
* README-hacking: Refer to PDF reference.
Modified: trunk/doc/texinfo.texi
===================================================================
--- trunk/doc/texinfo.texi 2015-12-07 20:29:14 UTC (rev 6841)
+++ trunk/doc/texinfo.texi 2015-12-08 11:58:51 UTC (rev 6842)
@@ -1918,16 +1918,22 @@
@cindex Texinfo requires @code{@@setfilename}
@cindex Output file name, required
-The first Texinfo command (that is, after the @code{\input texinfo})
-in a document is generally @code{@@setfilename}:
+The @code{@@setfilename} line specifies the name of the output file to
+be generated.
+When present, it should be the first Texinfo command (that is, after
address@hidden texinfo}).
+Write the @code{@@setfilename} command at the beginning of a line and
+follow it on the same line by the Info file name.
@example
@@setfilename @var{info-file-name}
@end example
-Write the @code{@@setfilename} command at the beginning of a line and
-follow it on the same line by the Info file name. Do not write
-anything else on the line.
+The name must be different from the name of the
+Texinfo file. There are two conventions for choosing the name: you
+can either remove the extension (such as @samp{.texi}) entirely from
+the input file name, or (recommended) replace it with the @samp{.info}
+extension.
@cindex Ignored before @code{@@setfilename}
@cindex @samp{\input} source line ignored
@@ -1936,13 +1942,23 @@
is why the very first line of the file (the @code{\input} line) does
not show up in the output.
-The @code{@@setfilename} line specifies the name of the output file to
-be generated. This name must be different from the name of the
-Texinfo file. There are two conventions for choosing the name: you
-can either remove the extension (such as @samp{.texi}) entirely from
-the input file name, or (recommended) replace it with the @samp{.info}
-extension.
+If there is no @code{@@setfilename} line, @code{makeinfo} uses the
+input file name to determine the output name: first, any of the
+extensions @code{.texi}, @code{.tex}, @code{.txi} or @code{.texinfo}
+is removed from the input file name; then, the output format specific
+extension is address@hidden when generating HTML, @code{.info}
+when generating Info, etc. The @code{\input} line is still ignored in
+this processing, as well as leading blank lines.
+When producing another output format, @code{makeinfo} will replace any
+final extension with the output format-specific extension (@samp{html}
+when generating HTML, for example), or add a dot followed by the
+extension (@samp{.html} for HTML) if the given name has no extension.
+
address@hidden@@setfilename} used to be required by the Texinfo processors, and
+some other programs may still expect it to be present; for example,
+Automake (@pxref{Texinfo,,,automake, GNU Automake}).
+
@cindex Length of file names
@cindex File name collision
@cindex Info file name, choosing
@@ -1961,19 +1977,6 @@
the original file name to leave enough space for the subfile suffix,
thus producing files named @file{texin-10}, @file{gcc.i12}, etc.
-When producing another output format, @code{makeinfo} will replace any
-final extension with the output format-specific extension (@samp{html}
-when generating HTML, for example), or add a dot followed by the
-extension (@samp{.html} for HTML) if the given name has no extension.
-
-If there is no @code{@@setfilename} line, @code{makeinfo} uses the
-input file name to determine the output name: first, any of the
-extensions @code{.texi}, @code{.tex}, @code{.txi} or @code{.texinfo}
-is removed from the input file name; then, the output format specific
-extension is address@hidden when generating HTML, @code{.info}
-when generating Info, etc. The @code{\input} line is still ignored in
-this processing, as well as leading blank lines.
-
See also the @option{--output} option in @ref{Invoking @command{texi2any}}.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [6842] mention that @setfilename may still be required,
Gavin D. Smith <=