texinfo ChangeLog doc/texinfo.txi

[Karl Berry]

CVSROOT:        /sources/texinfo
Module name:    texinfo
Changes by:     Karl Berry <karl>       12/06/29 17:48:28

Modified files:
        .              : ChangeLog 
        doc            : texinfo.txi 

Log message:
        merge nodes about @top

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1378&r2=1.1379
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.450&r2=1.451

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1378
retrieving revision 1.1379
diff -u -b -r1.1378 -r1.1379
--- ChangeLog   28 Jun 2012 00:00:28 -0000      1.1378
+++ ChangeLog   29 Jun 2012 17:48:27 -0000      1.1379
@@ -1,3 +1,10 @@
+2012-06-29  Karl Berry  <address@hidden>
+
+       * doc/texinfo.txi (top command): new node, merging the
+       mostly-redundant information from the nodes:
+       (makeinfo top command, makeinfo top): remove these.
+       Leave anchors with the old node names behind.
+
 2012-06-19  Patrice Dumas  <address@hidden>
         and Karl Berry  <address@hidden>
 

Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.450
retrieving revision 1.451
diff -u -b -r1.450 -r1.451
--- doc/texinfo.txi     28 Jun 2012 00:00:28 -0000      1.450
+++ doc/texinfo.txi     29 Jun 2012 17:48:27 -0000      1.451
@@ -1,5 +1,5 @@
 \input texinfo.tex    @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.450 2012/06/28 00:00:28 karl Exp $
address@hidden $Id: texinfo.txi,v 1.451 2012/06/29 17:48:27 karl Exp $
 @c Ordinarily, Texinfo files have the extension .texi.  But texinfo.texi
 @c clashes with texinfo.tex on 8.3 filesystems, so we use texinfo.txi.
 
@@ -278,7 +278,6 @@
 
 * Tree Structuring::            A manual is like an upside down tree @dots{}
 * Structuring Command Types::   How to divide a manual into parts.
-* makeinfo top::                The @code{@@top} command for the `Top' node.
 * chapter::
 * unnumbered & appendix::
 * majorheading & chapheading::
@@ -306,7 +305,7 @@
 * Node Line Tips::              Keep names short.
 * Node Line Requirements::      Keep names unique, without @@-commands.
 * First Node::                  How to write a `Top' node.
-* makeinfo top command::        How to use the @code{@@top} command.
+* top command::                 How to use the @code{@@top} command.
 
 Menus
 
@@ -3802,8 +3801,8 @@
 @findex top
 It is conventional and desirable to write an @code{@@top} sectioning
 command line containing the title of the document immediately after
-the @code{@@node Top} line (@pxref{makeinfo top command, , The
address@hidden@@top} Sectioning Command}).
+the @code{@@node Top} line (@pxref{top command,, The @code{@@top}
+Sectioning Command}).
 
 The contents of the `Top' node should appear only in the online output;
 none of it should appear in printed output, so enclose it between
@@ -4368,7 +4367,6 @@
 @menu
 * Tree Structuring::            A manual is like an upside down tree @dots{}
 * Structuring Command Types::   How to divide a manual into parts.
-* makeinfo top::                The @code{@@top} command for the `Top' node.
 * chapter::
 * unnumbered & appendix::
 * majorheading & chapheading::
@@ -4463,8 +4461,9 @@
 The @code{@@unnumbered} series of commands produce unnumbered entries
 both in the body of a document and in its table of contents.  The
 @code{@@top} command, which has a special use, is a member of this
-series (@pxref{makeinfo top, , @code{@@top}}).  An @code{@@unnumbered}
-section is a normal part of the document structure.
+series (@pxref{top command,, The @code{@@top} Sectioning Command}).
+An @code{@@unnumbered} section is a normal part of the document
+structure.
 
 @item
 The @code{@@heading} series of commands produce simple unnumbered
@@ -4499,29 +4498,6 @@
 @end tex
 
 
address@hidden FIXXME more or less a duplicate of 'makeinfo top'
address@hidden makeinfo top
address@hidden @code{@@top}
-
-The @code{@@top} command is a special sectioning command that you
-should only use after an @samp{@@node Top} line at the beginning of a
-Texinfo file.  The @code{@@top} command tells the @code{makeinfo}
-formatter which node is to be used as the root of the node tree (if
-your manual uses implicit node pointers).  It produces the same sort
-of output as @code{@@unnumbered} (@pxref{unnumbered & appendix,,
address@hidden@@unnumbered} and @code{@@appendix}}).  For detailed
-information, see @ref{makeinfo top command, , The @code{@@top}
-Command}.
-
-The @code{@@top} node is conventionally wrapped in an
address@hidden@@ifnottex} conditional so that it will not appear in @TeX{}
-output.
-
address@hidden@@top} is ignored when raising or lowering sections
-(@pxref{Raise/lower sections}).  That is, it is never lowered and
-nothing can be raised to it.
-
-
 @node chapter
 @section @code{@@chapter}
 @findex chapter
@@ -5165,7 +5141,7 @@
 * Node Line Tips::              Keep names short.
 * Node Line Requirements::      Keep names unique.
 * First Node::                  How to write a `Top' node.
-* makeinfo top command::        How to use the @code{@@top} command.
+* top command::                 How to use the @code{@@top} command.
 @end menu
 
 
@@ -5414,29 +5390,26 @@
 @end example
 
 
address@hidden makeinfo top command
address@hidden top command
 @subsection The @code{@@top} Sectioning Command
 @findex top
 
-A special sectioning command, @code{@@top} should be used after the
address@hidden@@node Top} line.  The @code{@@top} sectioning command tells
address@hidden that it marks the top-level node in the file.  It provides
-the information that @code{makeinfo} needs to insert node pointers
-automatically.  Write the @code{@@top} command at the beginning of the
-line immediately following the @code{@@node Top} line, followed by the
-text of the title (on the same line).
-
-In Info, the @code{@@top} sectioning command causes the title to appear
-on a line by itself, with a line of asterisks inserted underneath, as
-other sectioning commands do.
-
-In @TeX{} and @code{texinfo-format-buffer}, the @code{@@top}
-sectioning command is merely a synonym for @code{@@unnumbered}.
-Neither of these formatters require an @code{@@top} command, and do
-nothing special with it.  Indeed, it's conventional for the `Top' node
-to be delimited by @code{@@ifnottex}, so that @TeX{} will not see it
-(@pxref{Conditionals}).
address@hidden address@hidden name of an older node with this info
address@hidden top address@hidden another name
+
+The @code{@@top} command is a special sectioning command that you
+should only use after an @samp{@@node Top} line at the beginning of a
+Texinfo file.  The @code{@@top} command tells the @code{makeinfo}
+formatter which node is to be used as the root of the node tree
+(needed if your manual uses implicit node pointers).
+
+It produces the same sort of output as @code{@@unnumbered}
+(@pxref{unnumbered & appendix,, @code{@@unnumbered} and
address@hidden@@appendix}}).
 
+The @code{@@top} node is conventionally wrapped in an
address@hidden@@ifnottex} conditional so that it will not appear in @TeX{}
+output (@pxref{Conditionals}).
 Thus, in practice, a Top node usually looks like this:
 
 @example
@@ -5446,9 +5419,12 @@
 
 @var{very-high-level-summary}
 @@end ifnottex
-
 @end example
 
address@hidden@@top} is ignored when raising or lowering sections.  That is,
+it is never lowered and nothing can be raised to it
+(@pxref{Raise/lower sections}).
+
 
 @node makeinfo Pointer Creation
 @section Creating Pointers with @code{makeinfo}
@@ -5468,7 +5444,7 @@
 
 In addition, you must follow the `Top' @code{@@node} line with a line
 beginning with @code{@@top} to mark the top-level node in the
-file.  @xref{makeinfo top, , @code{@@top}}.
+file.  @xref{top command,, The @code{@@top} Sectioning Command}.
 
 Finally, you must write the name of each node (except for the `Top'
 node) in a menu that is one or more hierarchical levels above the
@@ -22006,7 +21982,7 @@
 Revision Control System}) or other version control systems, which
 expand it into a string such as:
 @example
-$Id: texinfo.txi,v 1.450 2012/06/28 00:00:28 karl Exp $
+$Id: texinfo.txi,v 1.451 2012/06/29 17:48:27 karl Exp $
 @end example
 (This is useful in all sources that use version control, not just manuals.)
 You may wish to include the @samp{$Id:} comment in the @code{@@copying}