[6898] emacs mode cookie

[Gavin D. Smith]

Revision: 6898
          http://svn.sv.gnu.org/viewvc/?view=rev&root=texinfo&revision=6898
Author:   gavin
Date:     2015-12-27 13:33:32 +0000 (Sun, 27 Dec 2015)
Log Message:
-----------
emacs mode cookie

Modified Paths:
--------------
    trunk/ChangeLog
    trunk/doc/texinfo.texi

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog     2015-12-26 10:41:59 UTC (rev 6897)
+++ trunk/ChangeLog     2015-12-27 13:33:32 UTC (rev 6898)
@@ -1,3 +1,21 @@
+2015-12-27  Gavin Smith  <address@hidden>
+
+       * doc/texinfo.texi (Short Sample): Remove use of "-*-texinfo-*-"
+       and "%** start of header", "%** end of header" from example.
+       Change "names the file" to "names the manual" since @setfilename isn't
+       here any more.
+       (Short Sample Texinfo File): Same changes to complete example 
+       without interleaved commentary.
+       (Sample Beginning): Remove the same parts.
+       (Texinfo File Header): Don't say that "-*-texinfo-*-" is 
+       required.  Delete word "generally".
+       (First Line): Mention optional "-*-texinfo-*-" here, for when 
+       the file type isn't detected from the file extension.
+       (Beginning and Ending a File): Don't say that the name of the 
+       output file has to be specified in a Texinfo file.
+
+       Suggestions from Per Bothner, Eli Zaretskii and Mathieu Lirzin.
+
 2015-12-26  Gavin Smith  <address@hidden>
 
        * doc/texinfo.texi (Inserting Accents, Inserting Quotation Marks):

Modified: trunk/doc/texinfo.texi
===================================================================
--- trunk/doc/texinfo.texi      2015-12-26 10:41:59 UTC (rev 6897)
+++ trunk/doc/texinfo.texi      2015-12-27 13:33:32 UTC (rev 6898)
@@ -1524,26 +1524,16 @@
 
 @noindent
 The header tells @TeX{} which definitions file to
-use, names the file, and carries out other such housekeeping tasks.
+use, names the manual, and carries out other such housekeeping tasks.
 
 @example
 @group
-\input texinfo   @@c -*-texinfo-*-
-@@c %**start of header
+\input texinfo
 @@settitle Sample Manual 1.0
-@@c %**end of header
 @end group
 @end example
 
-If you use Emacs, it is also useful to include mode setting and
-start-of-header and end-of-header lines at the beginning of a Texinfo
-file.  In the first line, @samp{-*-texinfo-*-} causes Emacs to switch 
-into Texinfo mode when you edit the file.
-The @code{@@c ...header} lines above which surround the 
address@hidden@@settitle} line allow you to process, within Emacs, just part of 
-the Texinfo source.  (@xref{Start of Header}.)
 
-
 @subheading Summary Description and Copyright
 
 This segment describes the document and contains the copyright notice 
@@ -1710,9 +1700,8 @@
 previously given (@pxref{Short Sample}).
 
 Certain pieces of information must be provided at the beginning of a
-Texinfo file, such as the name for the output file(s), the title of the
-document, and the Top node.  A table of contents is also generally
-produced here.
+Texinfo file, such the title of the document and the Top node.  A table
+of contents is also generally produced here.
 
 @cindex Frontmatter, text in
 Straight text outside of any command before the Top node should be
@@ -1745,10 +1734,8 @@
 @xref{GNU Sample Texts}, for the full texts to be used in GNU manuals.
 
 @example
-\input texinfo   @@c -*-texinfo-*-
-@@c %**start of header
+\input texinfo
 @@settitle @var{name-of-manual} @var{version}
-@@c %**end of header
 
 @@copying
 This manual is for @var{program}, version @var{version}.
@@ -1828,15 +1815,13 @@
 include in the header.  @code{@@synindex} (@address@hidden@@synindex}}),
 for instance, is another command often included in the header.
 
-Thus, the beginning of a Texinfo file generally looks approximately
+Thus, the beginning of a Texinfo file looks approximately
 like this:
 
 @example
 @group
-\input texinfo   @@c -*-texinfo-*-
-@@c %**start of header
+\input texinfo
 @@settitle Sample Manual 1.0
-@@c %**end of header
 @end group
 @end example
 
@@ -1861,14 +1846,9 @@
 with a line that looks like this:
 
 @example
-\input texinfo   @@c -*-texinfo-*-
+\input texinfo
 @end example
 
address@hidden
-This line serves two functions:
-
address@hidden
address@hidden
 When the file is processed by @TeX{}, the @samp{\input texinfo} command
 tells @TeX{} to load the macros needed for processing a Texinfo file.
 These are in a file called @file{texinfo.tex}, which should have been
@@ -1879,12 +1859,16 @@
 occurs, @TeX{} requires @samp{\}, which is why it appears at the
 beginning of the file.
 
address@hidden
-When the file is edited in GNU Emacs, the @samp{-*-texinfo-*-} mode
-specification tells Emacs to use Texinfo mode.
address@hidden enumerate
+You may optionally follow this line with a comment to tell GNU Emacs
+to use Texinfo mode when the file is edited:
 
address@hidden
+\input texinfo   @@c -*-texinfo-*-
address@hidden example
 
address@hidden This may be useful when Emacs doesn't detect the file type 
+from the file extension automatically.
+
 @node Start of Header
 @subsection Start of Header
 @cindex Start of header line
@@ -21371,10 +21355,8 @@
 
 @sp 1
 @example
-\input texinfo   @@c -*-texinfo-*-
-@@c %**start of header
+\input texinfo
 @@settitle Sample Manual 1.0
-@@c %**end of header
 
 @@copying
 This is a short example of a complete Texinfo file.