[5770] document formfeeds in node separators

[Gavin D. Smith]

Revision: 5770
          http://svn.sv.gnu.org/viewvc/?view=rev&root=texinfo&revision=5770
Author:   gavin
Date:     2014-08-21 19:05:21 +0000 (Thu, 21 Aug 2014)
Log Message:
-----------
document formfeeds in node separators

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

Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog     2014-08-21 18:47:25 UTC (rev 5769)
+++ trunk/ChangeLog     2014-08-21 19:05:21 UTC (rev 5770)
@@ -1,9 +1,10 @@
 2014-08-21  Gavin Smith  <address@hidden>
 
        * doc/texinfo.texi (Appendix F Info Format Specification): Update
-       including quoting mechanism, use of non-ASCII characters in node names,
-       tag table being optional in non-split files, use of "(dir)" in
-       node lines.
+       including quoting mechanism, use of non-ASCII characters in node
+       names, tag table being optional in non-split files, use of "(dir)" in
+       node lines.  Mention possibility of formfeed characters in section
+       separators.
 
 2014-08-21  Gavin Smith  <address@hidden>
 

Modified: trunk/doc/texinfo.texi
===================================================================
--- trunk/doc/texinfo.texi      2014-08-21 18:47:25 UTC (rev 5769)
+++ trunk/doc/texinfo.texi      2014-08-21 19:05:21 UTC (rev 5770)
@@ -23639,6 +23639,17 @@
 alternation, @samp{#} comment.  Exception: @samp{*} at the beginning
 of a line is literal.
 
+The sections in an Info file (such as nodes or tag tables) are separated
+with a sequence:
+
address@hidden
+(^L)?^_(^L)?^J
address@hidden example
+
address@hidden
+That is, a @samp{CTRL-_} character followed by a newline, with optional
+formfeed characters.  We refer to such sequences as @t{<separator>}.
+
 We specify literal parentheses (those that are part of the Info
 format) with @t{<lparen>} and @t{<rparen>}, meaning the single
 characters @samp{(} and @samp{)} respectively.  We specify the
@@ -23754,7 +23765,7 @@
 
 @example
     <indirect table> =
-^_
+<separator>
 Indirect:
 (<filename>: <bytepos>)*
 @end example
@@ -23769,7 +23780,7 @@
 The top-level file @file{gdb.info} will contain something like this:
 
 @example
-^_
+<separator>
 Indirect:
 gdb.info-1: 1878
 gdb.info-2: 295733
@@ -23796,11 +23807,11 @@
 
 @example
     <tag table> =
-^_
+<separator>
 Tag Table:
 (<lparen>Indirect<rparen>)?
 (Node|Ref): <nodeid>^?<bytepos>
-^_
+<separator>
 End Tag Table
 @end example
 
@@ -23851,7 +23862,7 @@
 
 @example
     <local variables> =
-^_
+<separator>
 Local Variables:
 coding: <encoding>
 End:
@@ -23869,7 +23880,7 @@
 
 @example
     <node> =
-^_
+<separator>
 File: <fn>, Node: <id1>, (Next: <id2>, )? (Prev: <id3>, )? Up: <id4>
 
 <general text, until the next ^_ or end-of-file>