FYI: Sort the Table of Symbols

[Akim Demaille]

>>> "Paul" == Paul Eggert <address@hidden> writes:

 > Akim Demaille <address@hidden> writes:
 >> I think the "Bison Symbols" section should be sorted regardless of
 >> special characters such as %, @ etc. for symbols with real letters in
 >> them.  Currently, $undefined is before error which is before %debug.
 >> 
 >> Shouldn't we re-sort?

 > That sounds reasonable to me.

Index: ChangeLog
from  Akim Demaille  <address@hidden>

        * doc/bison.texinfo (Table of Symbols): Sort.

Index: doc/bison.texinfo
===================================================================
RCS file: /cvsroot/bison/bison/doc/bison.texinfo,v
retrieving revision 1.132
diff -u -u -r1.132 bison.texinfo
--- doc/bison.texinfo 20 Sep 2004 15:25:25 -0000 1.132
+++ doc/bison.texinfo 24 Sep 2004 11:54:19 -0000
@@ -6969,178 +6969,42 @@
 right-hand side of the rule.  @xref{Actions}.
 @end deffn
 
address@hidden {Symbol} $accept
-The predefined nonterminal whose only rule is @samp{$accept: @var{start}
-$end}, where @var{start} is the start symbol.  @xref{Start Decl, , The
-Start-Symbol}.  It cannot be used in the grammar.
address@hidden deffn
-
address@hidden {Symbol} $end
-The predefined token marking the end of the token stream.  It cannot be
-used in the grammar.
address@hidden deffn
-
address@hidden {Symbol} $undefined
-The predefined token onto which all undefined values returned by
address@hidden are mapped.  It cannot be used in the grammar, rather, use
address@hidden
address@hidden deffn
-
address@hidden {Symbol} error
-A token name reserved for error recovery.  This token may be used in
-grammar rules so as to allow the Bison parser to recognize an error in
-the grammar without halting the process.  In effect, a sentence
-containing an error may be recognized as valid.  On a syntax error, the
-token @code{error} becomes the current look-ahead token.  Actions
-corresponding to @code{error} are then executed, and the look-ahead
-token is reset to the token that originally caused the violation.
address@hidden Recovery}.
address@hidden deffn
-
address@hidden {Macro} YYABORT
-Macro to pretend that an unrecoverable syntax error has occurred, by
-making @code{yyparse} return 1 immediately.  The error reporting
-function @code{yyerror} is not called.  @xref{Parser Function, ,The
-Parser Function @code{yyparse}}.
address@hidden deffn
-
address@hidden {Macro} YYACCEPT
-Macro to pretend that a complete utterance of the language has been
-read, by making @code{yyparse} return 0 immediately.
address@hidden Function, ,The Parser Function @code{yyparse}}.
address@hidden deffn
-
address@hidden {Macro} YYBACKUP
-Macro to discard a value from the parser stack and fake a look-ahead
-token.  @xref{Action Features, ,Special Features for Use in Actions}.
address@hidden deffn
-
address@hidden {Macro} YYDEBUG
-Macro to define to equip the parser with tracing code.  @xref{Tracing,
-,Tracing Your Parser}.
address@hidden deffn
-
address@hidden {Macro} YYERROR
-Macro to pretend that a syntax error has just been detected: call
address@hidden and then perform normal error recovery if possible
-(@pxref{Error Recovery}), or (if recovery is impossible) make
address@hidden return 1.  @xref{Error Recovery}.
address@hidden deffn
-
address@hidden {Macro} YYERROR_VERBOSE
-An obsolete macro that you define with @code{#define} in the prologue
-to request verbose, specific error message strings
-when @code{yyerror} is called.  It doesn't matter what definition you
-use for @code{YYERROR_VERBOSE}, just whether you define it.  Using
address@hidden is preferred.
address@hidden deffn
-
address@hidden {Macro} YYINITDEPTH
-Macro for specifying the initial size of the parser stack.
address@hidden Overflow}.
address@hidden deffn
-
address@hidden {Macro} YYLEX_PARAM
-An obsolete macro for specifying an extra argument (or list of extra
-arguments) for @code{yyparse} to pass to @code{yylex}.  he use of this
-macro is deprecated, and is supported only for Yacc like parsers.
address@hidden Calling,, Calling Conventions for Pure Parsers}.
address@hidden deffn
-
address@hidden {Type} YYLTYPE
-Data type of @code{yylloc}; by default, a structure with four
-members.  @xref{Location Type, , Data Types of Locations}.
address@hidden deffn
-
address@hidden {Macro} YYMAXDEPTH
-Macro for specifying the maximum size of the parser stack.  @xref{Stack
-Overflow}.
address@hidden deffn
-
address@hidden {Macro} YYPARSE_PARAM
-An obsolete macro for specifying the name of a parameter that
address@hidden should accept.  The use of this macro is deprecated, and
-is supported only for Yacc like parsers.  @xref{Pure Calling,, Calling
-Conventions for Pure Parsers}.
address@hidden deffn
-
address@hidden {Macro} YYRECOVERING
-Macro whose value indicates whether the parser is recovering from a
-syntax error.  @xref{Action Features, ,Special Features for Use in Actions}.
address@hidden deffn
-
address@hidden {Macro} YYSTACK_USE_ALLOCA
-Macro used to control the use of @code{alloca}.  If defined to @samp{0},
-the parser will not use @code{alloca} but @code{malloc} when trying to
-grow its internal stacks.  Do @emph{not} define @code{YYSTACK_USE_ALLOCA}
-to anything else.
address@hidden deffn
-
address@hidden {Type} YYSTYPE
-Data type of semantic values; @code{int} by default.
address@hidden Type, ,Data Types of Semantic Values}.
address@hidden deffn
-
address@hidden {Variable} yychar
-External integer variable that contains the integer value of the current
-look-ahead token.  (In a pure parser, it is a local variable within
address@hidden)  Error-recovery rule actions may examine this variable.
address@hidden Features, ,Special Features for Use in Actions}.
address@hidden deffn
-
address@hidden {Variable} yyclearin
-Macro used in error-recovery rule actions.  It clears the previous
-look-ahead token.  @xref{Error Recovery}.
address@hidden deffn
-
address@hidden {Variable} yydebug
-External integer variable set to zero by default.  If @code{yydebug}
-is given a nonzero value, the parser will output information on input
-symbols and parser action.  @xref{Tracing, ,Tracing Your Parser}.
address@hidden deffn
-
address@hidden {Macro} yyerrok
-Macro to cause parser to recover immediately to its normal mode
-after a syntax error.  @xref{Error Recovery}.
address@hidden {Delimiter} %%
+Delimiter used to separate the grammar rule section from the
+Bison declarations section or the epilogue.
address@hidden Layout, ,The Overall Layout of a Bison Grammar}.
 @end deffn
 
address@hidden {Function} yyerror
-User-supplied function to be called by @code{yyparse} on error.
address@hidden Reporting, ,The Error
-Reporting Function @code{yyerror}}.
address@hidden Don't insert spaces, or check the DVI output.
address@hidden {Delimiter} address@hidden@address@hidden
+All code listed between @address@hidden and @address@hidden is copied directly 
to
+the output file uninterpreted.  Such code forms the prologue of the input
+file.  @xref{Grammar Outline, ,Outline of a Bison
+Grammar}.
 @end deffn
 
address@hidden {Function} yylex
-User-supplied lexical analyzer function, called with no arguments to get
-the next token.  @xref{Lexical, ,The Lexical Analyzer Function
address@hidden
address@hidden {Construct} /address@hidden/
+Comment delimiters, as in C.
 @end deffn
 
address@hidden {Variable} yylval
-External variable in which @code{yylex} should place the semantic
-value associated with a token.  (In a pure parser, it is a local
-variable within @code{yyparse}, and its address is passed to
address@hidden)  @xref{Token Values, ,Semantic Values of Tokens}.
address@hidden {Delimiter} :
+Separates a rule's result from its components.  @xref{Rules, ,Syntax of
+Grammar Rules}.
 @end deffn
 
address@hidden {Variable} yylloc
-External variable in which @code{yylex} should place the line and column
-numbers associated with a token.  (In a pure parser, it is a local
-variable within @code{yyparse}, and its address is passed to
address@hidden)  You can ignore this variable if you don't use the
address@hidden@@} feature in the grammar actions.  @xref{Token Locations,
-,Textual Locations of Tokens}.
address@hidden {Delimiter} ;
+Terminates a rule.  @xref{Rules, ,Syntax of Grammar Rules}.
 @end deffn
 
address@hidden {Variable} yynerrs
-Global variable which Bison increments each time there is a syntax error.
-(In a pure parser, it is a local variable within @code{yyparse}.)
address@hidden Reporting, ,The Error Reporting Function @code{yyerror}}.
address@hidden {Delimiter} |
+Separates alternate rules for the same result nonterminal.
address@hidden, ,Syntax of Grammar Rules}.
 @end deffn
 
address@hidden {Function} yyparse
-The parser function produced by Bison; call this function to start
-parsing.  @xref{Parser Function, ,The Parser Function @code{yyparse}}.
address@hidden {Symbol} $accept
+The predefined nonterminal whose only rule is @samp{$accept: @var{start}
+$end}, where @var{start} is the start symbol.  @xref{Start Decl, , The
+Start-Symbol}.  It cannot be used in the grammar.
 @end deffn
 
 @deffn {Directive} %debug
@@ -7171,8 +7035,20 @@
 @acronym{GLR} Parsers}.
 @end deffn
 
address@hidden {Directive} %initial-action
-Run user code before parsing.  @xref{Initial Action Decl, , Performing Actions 
before Parsing}.
address@hidden {Symbol} $end
+The predefined token marking the end of the token stream.  It cannot be
+used in the grammar.
address@hidden deffn
+
address@hidden {Symbol} error
+A token name reserved for error recovery.  This token may be used in
+grammar rules so as to allow the Bison parser to recognize an error in
+the grammar without halting the process.  In effect, a sentence
+containing an error may be recognized as valid.  On a syntax error, the
+token @code{error} becomes the current look-ahead token.  Actions
+corresponding to @code{error} are then executed, and the look-ahead
+token is reset to the token that originally caused the violation.
address@hidden Recovery}.
 @end deffn
 
 @deffn {Directive} %error-verbose
@@ -7190,6 +7066,10 @@
 Parsers, ,Writing @acronym{GLR} Parsers}.
 @end deffn
 
address@hidden {Directive} %initial-action
+Run user code before parsing.  @xref{Initial Action Decl, , Performing Actions 
before Parsing}.
address@hidden deffn
+
 @deffn {Directive} %left
 Bison declaration to assign left associativity to token(s).
 @xref{Precedence Decl, ,Operator Precedence}.
@@ -7276,45 +7156,161 @@
 ,Nonterminal Symbols}.
 @end deffn
 
address@hidden {Symbol} $undefined
+The predefined token onto which all undefined values returned by
address@hidden are mapped.  It cannot be used in the grammar, rather, use
address@hidden
address@hidden deffn
+
 @deffn {Directive} %union
 Bison declaration to specify several possible data types for semantic
 values.  @xref{Union Decl, ,The Collection of Value Types}.
 @end deffn
 
address@hidden 1
address@hidden {Macro} YYABORT
+Macro to pretend that an unrecoverable syntax error has occurred, by
+making @code{yyparse} return 1 immediately.  The error reporting
+function @code{yyerror} is not called.  @xref{Parser Function, ,The
+Parser Function @code{yyparse}}.
address@hidden deffn
 
-These are the punctuation and delimiters used in Bison input:
address@hidden {Macro} YYACCEPT
+Macro to pretend that a complete utterance of the language has been
+read, by making @code{yyparse} return 0 immediately.
address@hidden Function, ,The Parser Function @code{yyparse}}.
address@hidden deffn
 
address@hidden {Delimiter} %%
-Delimiter used to separate the grammar rule section from the
-Bison declarations section or the epilogue.
address@hidden Layout, ,The Overall Layout of a Bison Grammar}.
address@hidden {Macro} YYBACKUP
+Macro to discard a value from the parser stack and fake a look-ahead
+token.  @xref{Action Features, ,Special Features for Use in Actions}.
 @end deffn
 
address@hidden Don't insert spaces, or check the DVI output.
address@hidden {Delimiter} address@hidden@address@hidden
-All code listed between @address@hidden and @address@hidden is copied directly 
to
-the output file uninterpreted.  Such code forms the prologue of the input
-file.  @xref{Grammar Outline, ,Outline of a Bison
-Grammar}.
address@hidden {Variable} yychar
+External integer variable that contains the integer value of the current
+look-ahead token.  (In a pure parser, it is a local variable within
address@hidden)  Error-recovery rule actions may examine this variable.
address@hidden Features, ,Special Features for Use in Actions}.
 @end deffn
 
address@hidden {Construct} /address@hidden/
-Comment delimiters, as in C.
address@hidden {Variable} yyclearin
+Macro used in error-recovery rule actions.  It clears the previous
+look-ahead token.  @xref{Error Recovery}.
 @end deffn
 
address@hidden {Delimiter} :
-Separates a rule's result from its components.  @xref{Rules, ,Syntax of
-Grammar Rules}.
address@hidden {Macro} YYDEBUG
+Macro to define to equip the parser with tracing code.  @xref{Tracing,
+,Tracing Your Parser}.
 @end deffn
 
address@hidden {Delimiter} ;
-Terminates a rule.  @xref{Rules, ,Syntax of Grammar Rules}.
address@hidden {Variable} yydebug
+External integer variable set to zero by default.  If @code{yydebug}
+is given a nonzero value, the parser will output information on input
+symbols and parser action.  @xref{Tracing, ,Tracing Your Parser}.
 @end deffn
 
address@hidden {Delimiter} |
-Separates alternate rules for the same result nonterminal.
address@hidden, ,Syntax of Grammar Rules}.
address@hidden {Macro} yyerrok
+Macro to cause parser to recover immediately to its normal mode
+after a syntax error.  @xref{Error Recovery}.
address@hidden deffn
+
address@hidden {Macro} YYERROR
+Macro to pretend that a syntax error has just been detected: call
address@hidden and then perform normal error recovery if possible
+(@pxref{Error Recovery}), or (if recovery is impossible) make
address@hidden return 1.  @xref{Error Recovery}.
address@hidden deffn
+
address@hidden {Function} yyerror
+User-supplied function to be called by @code{yyparse} on error.
address@hidden Reporting, ,The Error
+Reporting Function @code{yyerror}}.
address@hidden deffn
+
address@hidden {Macro} YYERROR_VERBOSE
+An obsolete macro that you define with @code{#define} in the prologue
+to request verbose, specific error message strings
+when @code{yyerror} is called.  It doesn't matter what definition you
+use for @code{YYERROR_VERBOSE}, just whether you define it.  Using
address@hidden is preferred.
address@hidden deffn
+
address@hidden {Macro} YYINITDEPTH
+Macro for specifying the initial size of the parser stack.
address@hidden Overflow}.
address@hidden deffn
+
address@hidden {Function} yylex
+User-supplied lexical analyzer function, called with no arguments to get
+the next token.  @xref{Lexical, ,The Lexical Analyzer Function
address@hidden
address@hidden deffn
+
address@hidden {Macro} YYLEX_PARAM
+An obsolete macro for specifying an extra argument (or list of extra
+arguments) for @code{yyparse} to pass to @code{yylex}.  he use of this
+macro is deprecated, and is supported only for Yacc like parsers.
address@hidden Calling,, Calling Conventions for Pure Parsers}.
address@hidden deffn
+
address@hidden {Variable} yylloc
+External variable in which @code{yylex} should place the line and column
+numbers associated with a token.  (In a pure parser, it is a local
+variable within @code{yyparse}, and its address is passed to
address@hidden)  You can ignore this variable if you don't use the
address@hidden@@} feature in the grammar actions.  @xref{Token Locations,
+,Textual Locations of Tokens}.
address@hidden deffn
+
address@hidden {Type} YYLTYPE
+Data type of @code{yylloc}; by default, a structure with four
+members.  @xref{Location Type, , Data Types of Locations}.
address@hidden deffn
+
address@hidden {Variable} yylval
+External variable in which @code{yylex} should place the semantic
+value associated with a token.  (In a pure parser, it is a local
+variable within @code{yyparse}, and its address is passed to
address@hidden)  @xref{Token Values, ,Semantic Values of Tokens}.
address@hidden deffn
+
address@hidden {Macro} YYMAXDEPTH
+Macro for specifying the maximum size of the parser stack.  @xref{Stack
+Overflow}.
address@hidden deffn
+
address@hidden {Variable} yynerrs
+Global variable which Bison increments each time there is a syntax error.
+(In a pure parser, it is a local variable within @code{yyparse}.)
address@hidden Reporting, ,The Error Reporting Function @code{yyerror}}.
address@hidden deffn
+
address@hidden {Function} yyparse
+The parser function produced by Bison; call this function to start
+parsing.  @xref{Parser Function, ,The Parser Function @code{yyparse}}.
address@hidden deffn
+
address@hidden {Macro} YYPARSE_PARAM
+An obsolete macro for specifying the name of a parameter that
address@hidden should accept.  The use of this macro is deprecated, and
+is supported only for Yacc like parsers.  @xref{Pure Calling,, Calling
+Conventions for Pure Parsers}.
address@hidden deffn
+
address@hidden {Macro} YYRECOVERING
+Macro whose value indicates whether the parser is recovering from a
+syntax error.  @xref{Action Features, ,Special Features for Use in Actions}.
address@hidden deffn
+
address@hidden {Macro} YYSTACK_USE_ALLOCA
+Macro used to control the use of @code{alloca}.  If defined to @samp{0},
+the parser will not use @code{alloca} but @code{malloc} when trying to
+grow its internal stacks.  Do @emph{not} define @code{YYSTACK_USE_ALLOCA}
+to anything else.
address@hidden deffn
+
address@hidden {Type} YYSTYPE
+Data type of semantic values; @code{int} by default.
address@hidden Type, ,Data Types of Semantic Values}.
 @end deffn
 
 @node Glossary