* THANKS: Update my email address.

[bison.git] / doc / bison.texinfo

diff --git a/doc/bison.texinfo b/doc/bison.texinfo
index c0fa7f08b8148e6344116244ea3a09a8c08ef3b0..054b5f28c3c892fc7754c74a9651a47e89dca5ee 100644 (file)
--- a/doc/bison.texinfo
+++ b/doc/bison.texinfo
@@ -45,10 +45,10 @@ being ``A @acronym{GNU} Manual,'' and with the Back-Cover Texts as in
 (a) below.  A copy of the license is included in the section entitled
 ``@acronym{GNU} Free Documentation License.''
 
 (a) below.  A copy of the license is included in the section entitled
 ``@acronym{GNU} Free Documentation License.''
 

-(a) The @acronym{FSF}'s Back-Cover Text is: ``You have freedom to copy
-and modify this @acronym{GNU} Manual, like @acronym{GNU} software.
-Copies published by the Free Software Foundation raise funds for
-@acronym{GNU} development.''
+(a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
+modify this @acronym{GNU} manual.  Buying copies from the @acronym{FSF}
+supports it in developing @acronym{GNU} and promoting software
+freedom.''

 @end quotation
 @end copying
 
 @end quotation
 @end copying
 


@@ -4514,8 +4514,8 @@ The result is that the communication variables @code{yylval} and
 @code{yylloc} become local variables in @code{yyparse}, and a different
 calling convention is used for the lexical analyzer function
 @code{yylex}.  @xref{Pure Calling, ,Calling Conventions for Pure
 @code{yylloc} become local variables in @code{yyparse}, and a different
 calling convention is used for the lexical analyzer function
 @code{yylex}.  @xref{Pure Calling, ,Calling Conventions for Pure

-Parsers}, for the details of this.  The variable @code{yynerrs} 
-becomes local in @code{yyparse} in pull mode but it becomes a member 
+Parsers}, for the details of this.  The variable @code{yynerrs}
+becomes local in @code{yyparse} in pull mode but it becomes a member

 of yypstate in push mode.  (@pxref{Error Reporting, ,The Error
 Reporting Function @code{yyerror}}).  The convention for calling
 @code{yyparse} itself is unchanged.
 of yypstate in push mode.  (@pxref{Error Reporting, ,The Error
 Reporting Function @code{yyerror}}).  The convention for calling
 @code{yyparse} itself is unchanged.


@@ -4530,14 +4530,14 @@ valid grammar.
 @cindex push parser
 @findex %define api.push_pull
 
 @cindex push parser
 @findex %define api.push_pull
 

-A pull parser is called once and it takes control until all its input 
-is completely parsed.  A push parser, on the other hand, is called 
+A pull parser is called once and it takes control until all its input
+is completely parsed.  A push parser, on the other hand, is called

 each time a new token is made available.
 
 each time a new token is made available.
 

-A push parser is typically useful when the parser is part of a 
+A push parser is typically useful when the parser is part of a

 main event loop in the client's application.  This is typically
 main event loop in the client's application.  This is typically

-a requirement of a GUI, when the main event loop needs to be triggered 
-within a certain time period.  
+a requirement of a GUI, when the main event loop needs to be triggered
+within a certain time period.

 
 Normally, Bison generates a pull parser.
 The following Bison declaration says that you want the parser to be a push
 
 Normally, Bison generates a pull parser.
 The following Bison declaration says that you want the parser to be a push


@@ -4549,7 +4549,7 @@ parser (@pxref{Decl Summary,,%define api.push_pull}):
 
 In almost all cases, you want to ensure that your push parser is also
 a pure parser (@pxref{Pure Decl, ,A Pure (Reentrant) Parser}).  The only
 
 In almost all cases, you want to ensure that your push parser is also
 a pure parser (@pxref{Pure Decl, ,A Pure (Reentrant) Parser}).  The only

-time you should create an impure push parser is to have backwards 
+time you should create an impure push parser is to have backwards

 compatibility with the impure Yacc pull mode interface.  Unless you know
 what you are doing, your declarations should look like this:
 
 compatibility with the impure Yacc pull mode interface.  Unless you know
 what you are doing, your declarations should look like this:
 


@@ -4558,17 +4558,17 @@ what you are doing, your declarations should look like this:
 %define api.push_pull "push"
 @end example
 
 %define api.push_pull "push"
 @end example
 

-There is a major notable functional difference between the pure push parser 
-and the impure push parser.  It is acceptable for a pure push parser to have 
+There is a major notable functional difference between the pure push parser
+and the impure push parser.  It is acceptable for a pure push parser to have

 many parser instances, of the same type of parser, in memory at the same time.
 An impure push parser should only use one parser at a time.
 
 When a push parser is selected, Bison will generate some new symbols in
 many parser instances, of the same type of parser, in memory at the same time.
 An impure push parser should only use one parser at a time.
 
 When a push parser is selected, Bison will generate some new symbols in

-the generated parser.  @code{yypstate} is a structure that the generated 
-parser uses to store the parser's state.  @code{yypstate_new} is the 
+the generated parser.  @code{yypstate} is a structure that the generated
+parser uses to store the parser's state.  @code{yypstate_new} is the

 function that will create a new parser instance.  @code{yypstate_delete}
 will free the resources associated with the corresponding parser instance.
 function that will create a new parser instance.  @code{yypstate_delete}
 will free the resources associated with the corresponding parser instance.

-Finally, @code{yypush_parse} is the function that should be called whenever a 
+Finally, @code{yypush_parse} is the function that should be called whenever a

 token is available to provide the parser.  A trivial example
 of using a pure push parser would look like this:
 
 token is available to provide the parser.  A trivial example
 of using a pure push parser would look like this:
 


@@ -4582,10 +4582,10 @@ yypstate_delete (ps);
 @end example
 
 If the user decided to use an impure push parser, a few things about
 @end example
 
 If the user decided to use an impure push parser, a few things about

-the generated parser will change.  The @code{yychar} variable becomes 
+the generated parser will change.  The @code{yychar} variable becomes

 a global variable instead of a variable in the @code{yypush_parse} function.
 For this reason, the signature of the @code{yypush_parse} function is
 a global variable instead of a variable in the @code{yypush_parse} function.
 For this reason, the signature of the @code{yypush_parse} function is

-changed to remove the token as a parameter.  A nonreentrant push parser 
+changed to remove the token as a parameter.  A nonreentrant push parser

 example would thus look like this:
 
 @example
 example would thus look like this:
 
 @example


@@ -4599,26 +4599,26 @@ do @{
 yypstate_delete (ps);
 @end example
 
 yypstate_delete (ps);
 @end example
 

-That's it. Notice the next token is put into the global variable @code{yychar} 
+That's it. Notice the next token is put into the global variable @code{yychar}

 for use by the next invocation of the @code{yypush_parse} function.
 
 for use by the next invocation of the @code{yypush_parse} function.
 

-Bison also supports both the push parser interface along with the pull parser 
+Bison also supports both the push parser interface along with the pull parser

 interface in the same generated parser.  In order to get this functionality,
 interface in the same generated parser.  In order to get this functionality,

-you should replace the @code{%define api.push_pull "push"} declaration with the 
+you should replace the @code{%define api.push_pull "push"} declaration with the

 @code{%define api.push_pull "both"} declaration.  Doing this will create all of
 the symbols mentioned earlier along with the two extra symbols, @code{yyparse}
 @code{%define api.push_pull "both"} declaration.  Doing this will create all of
 the symbols mentioned earlier along with the two extra symbols, @code{yyparse}

-and @code{yypull_parse}.  @code{yyparse} can be used exactly as it normally 
-would be used.  However, the user should note that it is implemented in the 
+and @code{yypull_parse}.  @code{yyparse} can be used exactly as it normally
+would be used.  However, the user should note that it is implemented in the

 generated parser by calling @code{yypull_parse}.
 This makes the @code{yyparse} function that is generated with the
 @code{%define api.push_pull "both"} declaration slower than the normal
 @code{yyparse} function.  If the user
 calls the @code{yypull_parse} function it will parse the rest of the input
 generated parser by calling @code{yypull_parse}.
 This makes the @code{yyparse} function that is generated with the
 @code{%define api.push_pull "both"} declaration slower than the normal
 @code{yyparse} function.  If the user
 calls the @code{yypull_parse} function it will parse the rest of the input

-stream.  It is possible to @code{yypush_parse} tokens to select a subgrammar 
-and then @code{yypull_parse} the rest of the input stream.  If you would like 
-to switch back and forth between between parsing styles, you would have to 
-write your own @code{yypull_parse} function that knows when to quit looking 
-for input.  An example of using the @code{yypull_parse} function would look 
+stream.  It is possible to @code{yypush_parse} tokens to select a subgrammar
+and then @code{yypull_parse} the rest of the input stream.  If you would like
+to switch back and forth between between parsing styles, you would have to
+write your own @code{yypull_parse} function that knows when to quit looking
+for input.  An example of using the @code{yypull_parse} function would look

 like this:
 
 @example
 like this:
 
 @example


@@ -4628,7 +4628,7 @@ yypstate_delete (ps);
 @end example
 
 Adding the @code{%define api.pure} declaration does exactly the same thing to
 @end example
 
 Adding the @code{%define api.pure} declaration does exactly the same thing to

-the generated parser with @code{%define api.push_pull "both"} as it did for 
+the generated parser with @code{%define api.push_pull "both"} as it did for

 @code{%define api.push_pull "push"}.
 
 @node Decl Summary
 @code{%define api.push_pull "push"}.
 
 @node Decl Summary


@@ -4887,8 +4887,9 @@ are useless in the generated parser.
 @item Caveats:
 
 @itemize @bullet
 @item Caveats:
 
 @itemize @bullet

-@item Unreachable states may contain conflicts and may reduce rules not
-reduced in any other state.
+
+@item Unreachable states may contain conflicts and may use rules not used in
+any other state.

 Thus, keeping unreachable states may induce warnings that are irrelevant to
 your parser's behavior, and it may eliminate warnings that are relevant.
 Of course, the change in warnings may actually be relevant to a parser table
 Thus, keeping unreachable states may induce warnings that are irrelevant to
 your parser's behavior, and it may eliminate warnings that are relevant.
 Of course, the change in warnings may actually be relevant to a parser table


@@ -5036,10 +5037,10 @@ Rename the external symbols used in the parser so that they start with
 in C parsers
 is @code{yyparse}, @code{yylex}, @code{yyerror}, @code{yynerrs},
 @code{yylval}, @code{yychar}, @code{yydebug}, and
 in C parsers
 is @code{yyparse}, @code{yylex}, @code{yyerror}, @code{yynerrs},
 @code{yylval}, @code{yychar}, @code{yydebug}, and

-(if locations are used) @code{yylloc}.  If you use a push parser, 
-@code{yypush_parse}, @code{yypull_parse}, @code{yypstate}, 
-@code{yypstate_new} and @code{yypstate_delete} will 
-also be renamed.  For example, if you use @samp{%name-prefix "c_"}, the 
+(if locations are used) @code{yylloc}.  If you use a push parser,
+@code{yypush_parse}, @code{yypull_parse}, @code{yypstate},
+@code{yypstate_new} and @code{yypstate_delete} will
+also be renamed.  For example, if you use @samp{%name-prefix "c_"}, the

 names become @code{c_parse}, @code{c_lex}, and so on.
 For C++ parsers, see the @code{%define namespace} documentation in this
 section.
 names become @code{c_parse}, @code{c_lex}, and so on.
 For C++ parsers, see the @code{%define namespace} documentation in this
 section.


@@ -5155,10 +5156,10 @@ names that do not conflict.
 
 The precise list of symbols renamed is @code{yyparse}, @code{yylex},
 @code{yyerror}, @code{yynerrs}, @code{yylval}, @code{yylloc},
 
 The precise list of symbols renamed is @code{yyparse}, @code{yylex},
 @code{yyerror}, @code{yynerrs}, @code{yylval}, @code{yylloc},

-@code{yychar} and @code{yydebug}.  If you use a push parser, 
-@code{yypush_parse}, @code{yypull_parse}, @code{yypstate}, 
+@code{yychar} and @code{yydebug}.  If you use a push parser,
+@code{yypush_parse}, @code{yypull_parse}, @code{yypstate},

 @code{yypstate_new} and @code{yypstate_delete} will also be renamed.
 @code{yypstate_new} and @code{yypstate_delete} will also be renamed.

-For example, if you use @samp{-p c}, the names become @code{cparse}, 
+For example, if you use @samp{-p c}, the names become @code{cparse},

 @code{clex}, and so on.
 
 @strong{All the other variables and macros associated with Bison are not
 @code{clex}, and so on.
 
 @strong{All the other variables and macros associated with Bison are not


@@ -5190,9 +5191,9 @@ in the grammar file, you are likely to run into trouble.
 * Parser Function::   How to call @code{yyparse} and what it returns.
 * Push Parser Function::  How to call @code{yypush_parse} and what it returns.
 * Pull Parser Function::  How to call @code{yypull_parse} and what it returns.
 * Parser Function::   How to call @code{yyparse} and what it returns.
 * Push Parser Function::  How to call @code{yypush_parse} and what it returns.
 * Pull Parser Function::  How to call @code{yypull_parse} and what it returns.

-* Parser Create Function::  How to call @code{yypstate_new} and what it 
+* Parser Create Function::  How to call @code{yypstate_new} and what it

                         returns.
                         returns.

-* Parser Delete Function::  How to call @code{yypstate_delete} and what it 
+* Parser Delete Function::  How to call @code{yypstate_delete} and what it

                         returns.
 * Lexical::           You must supply a function @code{yylex}
                         which reads tokens.
                         returns.
 * Lexical::           You must supply a function @code{yylex}
                         which reads tokens.


@@ -5280,13 +5281,13 @@ exp: @dots{}    @{ @dots{}; *randomness += 1; @dots{} @}
 @section The Push Parser Function @code{yypush_parse}
 @findex yypush_parse
 
 @section The Push Parser Function @code{yypush_parse}
 @findex yypush_parse
 

-You call the function @code{yypush_parse} to parse a single token.  This 
-function is available if either the @code{%define api.push_pull "push"} or 
-@code{%define api.push_pull "both"} declaration is used.  
+You call the function @code{yypush_parse} to parse a single token.  This
+function is available if either the @code{%define api.push_pull "push"} or
+@code{%define api.push_pull "both"} declaration is used.

 @xref{Push Decl, ,A Push Parser}.
 
 @deftypefun int yypush_parse (yypstate *yyps)
 @xref{Push Decl, ,A Push Parser}.
 
 @deftypefun int yypush_parse (yypstate *yyps)

-The value returned by @code{yypush_parse} is the same as for yyparse with the 
+The value returned by @code{yypush_parse} is the same as for yyparse with the

 following exception.  @code{yypush_parse} will return YYPUSH_MORE if more input
 is required to finish parsing the grammar.
 @end deftypefun
 following exception.  @code{yypush_parse} will return YYPUSH_MORE if more input
 is required to finish parsing the grammar.
 @end deftypefun


@@ -5295,9 +5296,9 @@ is required to finish parsing the grammar.
 @section The Pull Parser Function @code{yypull_parse}
 @findex yypull_parse
 
 @section The Pull Parser Function @code{yypull_parse}
 @findex yypull_parse
 

-You call the function @code{yypull_parse} to parse the rest of the input 
-stream.  This function is available if the @code{%define api.push_pull "both"} 
-declaration is used.  
+You call the function @code{yypull_parse} to parse the rest of the input
+stream.  This function is available if the @code{%define api.push_pull "both"}
+declaration is used.

 @xref{Push Decl, ,A Push Parser}.
 
 @deftypefun int yypull_parse (yypstate *yyps)
 @xref{Push Decl, ,A Push Parser}.
 
 @deftypefun int yypull_parse (yypstate *yyps)


@@ -5308,9 +5309,9 @@ The value returned by @code{yypull_parse} is the same as for @code{yyparse}.
 @section The Parser Create Function @code{yystate_new}
 @findex yypstate_new
 
 @section The Parser Create Function @code{yystate_new}
 @findex yypstate_new
 

-You call the function @code{yypstate_new} to create a new parser instance.  
-This function is available if either the @code{%define api.push_pull "push"} or 
-@code{%define api.push_pull "both"} declaration is used.  
+You call the function @code{yypstate_new} to create a new parser instance.
+This function is available if either the @code{%define api.push_pull "push"} or
+@code{%define api.push_pull "both"} declaration is used.

 @xref{Push Decl, ,A Push Parser}.
 
 @deftypefun yypstate *yypstate_new (void)
 @xref{Push Decl, ,A Push Parser}.
 
 @deftypefun yypstate *yypstate_new (void)


@@ -5323,8 +5324,8 @@ or NULL if no memory was available.
 @findex yypstate_delete
 
 You call the function @code{yypstate_delete} to delete a parser instance.
 @findex yypstate_delete
 
 You call the function @code{yypstate_delete} to delete a parser instance.

-function is available if either the @code{%define api.push_pull "push"} or 
-@code{%define api.push_pull "both"} declaration is used.  
+function is available if either the @code{%define api.push_pull "push"} or
+@code{%define api.push_pull "both"} declaration is used.

 @xref{Push Decl, ,A Push Parser}.
 
 @deftypefun void yypstate_delete (yypstate *yyps)
 @xref{Push Decl, ,A Push Parser}.
 
 @deftypefun void yypstate_delete (yypstate *yyps)


@@ -7155,9 +7156,9 @@ useless: STR;
 @command{bison} reports:
 
 @example
 @command{bison} reports:
 
 @example

-calc.y: warning: 1 useless nonterminal and 1 useless rule
-calc.y:11.1-7: warning: useless nonterminal: useless
-calc.y:11.10-12: warning: useless rule: useless: STR
+calc.y: warning: 1 nonterminal and 1 rule useless in grammar
+calc.y:11.1-7: warning: nonterminal useless in grammar: useless
+calc.y:11.10-12: warning: rule useless in grammar: useless: STR

 calc.y: conflicts: 7 shift/reduce
 @end example
 
 calc.y: conflicts: 7 shift/reduce
 @end example
 


@@ -7196,17 +7197,17 @@ State 11 conflicts: 4 shift/reduce
 The next section reports useless tokens, nonterminal and rules.  Useless
 nonterminals and rules are removed in order to produce a smaller parser,
 but useless tokens are preserved, since they might be used by the
 The next section reports useless tokens, nonterminal and rules.  Useless
 nonterminals and rules are removed in order to produce a smaller parser,
 but useless tokens are preserved, since they might be used by the

-scanner (note the difference between ``useless'' and ``not used''
+scanner (note the difference between ``useless'' and ``unused''

 below):
 
 @example
 below):
 
 @example

-Useless nonterminals:
+Nonterminals useless in grammar:

    useless
 
    useless
 

-Terminals which are not used:
+Terminals unused in grammar:

    STR
 
    STR
 

-Useless rules:
+Rules useless in grammar:

 #6     useless: STR;
 @end example
 
 #6     useless: STR;
 @end example
 


@@ -7826,6 +7827,9 @@ Implies @code{state} and augments the description of the automaton with
 the full set of items for each state, instead of its core only.
 @end table
 
 the full set of items for each state, instead of its core only.
 @end table
 

+@item --report-file=@var{file}
+Specify the @var{file} for the verbose description.
+

 @item -v
 @itemx --verbose
 Pretend that @code{%verbose} was specified, i.e., write an extra output
 @item -v
 @itemx --verbose
 Pretend that @code{%verbose} was specified, i.e., write an extra output


@@ -7861,20 +7865,7 @@ the corresponding short option.
 
 @multitable {@option{--defines=@var{defines-file}}} {@option{-b @var{file-prefix}XXX}}
 @headitem Long Option @tab Short Option
 
 @multitable {@option{--defines=@var{defines-file}}} {@option{-b @var{file-prefix}XXX}}
 @headitem Long Option @tab Short Option

-@item @option{--debug}                      @tab @option{-t}
-@item @option{--defines=@var{defines-file}} @tab @option{-d}
-@item @option{--file-prefix=@var{prefix}}   @tab @option{-b @var{file-prefix}}
-@item @option{--graph=@var{graph-file}}     @tab @option{-d}
-@item @option{--help}                       @tab @option{-h}
-@item @option{--name-prefix=@var{prefix}}   @tab @option{-p @var{name-prefix}}
-@item @option{--no-lines}                   @tab @option{-l}
-@item @option{--output=@var{outfile}}       @tab @option{-o @var{outfile}}
-@item @option{--print-localedir}            @tab
-@item @option{--print-datadir}              @tab
-@item @option{--token-table}                @tab @option{-k}
-@item @option{--verbose}                    @tab @option{-v}
-@item @option{--version}                    @tab @option{-V}
-@item @option{--yacc}                       @tab @option{-y}
+@include cross-options.texi

 @end multitable
 
 @node Yacc Library
 @end multitable
 
 @node Yacc Library


@@ -9750,7 +9741,7 @@ Management}.
 
 @deffn {Variable} yynerrs
 Global variable which Bison increments each time it reports a syntax error.
 
 @deffn {Variable} yynerrs
 Global variable which Bison increments each time it reports a syntax error.

-(In a pure parser, it is a local variable within @code{yyparse}. In a 
+(In a pure parser, it is a local variable within @code{yyparse}. In a

 pure push parser, it is a member of yypstate.)
 @xref{Error Reporting, ,The Error Reporting Function @code{yyerror}}.
 @end deffn
 pure push parser, it is a member of yypstate.)
 @xref{Error Reporting, ,The Error Reporting Function @code{yyerror}}.
 @end deffn


@@ -9761,29 +9752,29 @@ parsing.  @xref{Parser Function, ,The Parser Function @code{yyparse}}.
 @end deffn
 
 @deffn {Function} yypstate_delete
 @end deffn
 
 @deffn {Function} yypstate_delete

-The function to delete a parser instance, produced by Bison in push mode; 
+The function to delete a parser instance, produced by Bison in push mode;

 call this function to delete the memory associated with a parser.
 call this function to delete the memory associated with a parser.

-@xref{Parser Delete Function, ,The Parser Delete Function 
+@xref{Parser Delete Function, ,The Parser Delete Function

 @code{yypstate_delete}}.
 @end deffn
 
 @deffn {Function} yypstate_new
 @code{yypstate_delete}}.
 @end deffn
 
 @deffn {Function} yypstate_new

-The function to create a parser instance, produced by Bison in push mode; 
+The function to create a parser instance, produced by Bison in push mode;

 call this function to create a new parser.
 call this function to create a new parser.

-@xref{Parser Create Function, ,The Parser Create Function 
+@xref{Parser Create Function, ,The Parser Create Function

 @code{yypstate_new}}.
 @end deffn
 
 @deffn {Function} yypull_parse
 @code{yypstate_new}}.
 @end deffn
 
 @deffn {Function} yypull_parse

-The parser function produced by Bison in push mode; call this function to 
-parse the rest of the input stream.  
-@xref{Pull Parser Function, ,The Pull Parser Function 
+The parser function produced by Bison in push mode; call this function to
+parse the rest of the input stream.
+@xref{Pull Parser Function, ,The Pull Parser Function

 @code{yypull_parse}}.
 @end deffn
 
 @deffn {Function} yypush_parse
 @code{yypull_parse}}.
 @end deffn
 
 @deffn {Function} yypush_parse

-The parser function produced by Bison in push mode; call this function to 
-parse a single token.  @xref{Push Parser Function, ,The Push Parser Function 
+The parser function produced by Bison in push mode; call this function to
+parse a single token.  @xref{Push Parser Function, ,The Push Parser Function

 @code{yypush_parse}}.
 @end deffn
 
 @code{yypush_parse}}.
 @end deffn