Future/bison
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/bison.git synced 2026-03-23 11:13:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix formatting and content of bison.texinfo menus

Browse Source 
* doc/bison.texinfo: Synchronize ``Detail Node Listing''.
Align menus.  Adjust word wrapping.  Use node names for menu names.
(Examples): Don't abbreviate node names.
(LocalWords): Remove abbreviations.
(Copying): Make description a sentence.
(Java Action Features): Remove period to match the rest of menu.
This commit is contained in:
Di-an Jan
2008-11-17 11:07:29 +01:00
committed by Paolo Bonzini
parent b5775a81c1
commit f56274a8f9
2 changed files with 183 additions and 172 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
ChangeLog
View File

@@ -1,3 +1,12 @@
2008-11-17 Di-an Jan <dianj@freeshell.org>
* doc/bison.texinfo: Synchronize ``Detail Node Listing''.
Align menus. Adjust word wrapping. Use node names for menu names.
(Examples): Don't abbreviate node names.
(LocalWords): Remove abbreviations.
(Copying): Make description a sentence.
(Java Action Features): Remove period to match the rest of menu.
2008-11-11 Paolo Bonzini <bonzini@gnu.org> 2008-11-11 Paolo Bonzini <bonzini@gnu.org>
* bootstrap.conf: Replace m4/warning.m4 with warnings module. * bootstrap.conf: Replace m4/warning.m4 with warnings module.

94
doc/bison.texinfo
View File

@@ -90,7 +90,7 @@ Cover art by Etienne Suvasa.
* Introduction:: * Introduction::
* Conditions:: * Conditions::
* Copying:: The @acronym{GNU} General Public License says * Copying:: The @acronym{GNU} General Public License says
how you can copy and share Bison how you can copy and share Bison.
Tutorial sections: Tutorial sections:
* Concepts:: Basic concepts for understanding Bison. * Concepts:: Basic concepts for understanding Bison.
@@ -152,13 +152,13 @@ Examples
Reverse Polish Notation Calculator Reverse Polish Notation Calculator
* Decls: Rpcalc Decls. Prologue (declarations) for rpcalc. * Rpcalc Declarations:: Prologue (declarations) for rpcalc.
* Rules: Rpcalc Rules. Grammar Rules for rpcalc, with explanation. * Rpcalc Rules:: Grammar Rules for rpcalc, with explanation.
* Lexer: Rpcalc Lexer. The lexical analyzer. * Rpcalc Lexer:: The lexical analyzer.
* Main: Rpcalc Main. The controlling function. * Rpcalc Main:: The controlling function.
* Error: Rpcalc Error. The error reporting function. * Rpcalc Error:: The error reporting function.
* Gen: Rpcalc Gen. Running Bison on the grammar file. * Rpcalc Generate:: Running Bison on the grammar file.
* Comp: Rpcalc Compile. Run the C compiler on the output code. * Rpcalc Compile:: Run the C compiler on the output code.
Grammar Rules for @code{rpcalc} Grammar Rules for @code{rpcalc}
@@ -168,15 +168,15 @@ Grammar Rules for @code{rpcalc}
Location Tracking Calculator: @code{ltcalc} Location Tracking Calculator: @code{ltcalc}
* Decls: Ltcalc Decls. Bison and C declarations for ltcalc. * Ltcalc Declarations:: Bison and C declarations for ltcalc.
* Rules: Ltcalc Rules. Grammar rules for ltcalc, with explanations. * Ltcalc Rules:: Grammar rules for ltcalc, with explanations.
* Lexer: Ltcalc Lexer. The lexical analyzer. * Ltcalc Lexer:: The lexical analyzer.
Multi-Function Calculator: @code{mfcalc} Multi-Function Calculator: @code{mfcalc}
* Decl: Mfcalc Decl. Bison declarations for multi-function calculator. * Mfcalc Declarations:: Bison declarations for multi-function calculator.
* Rules: Mfcalc Rules. Grammar rules for the calculator. * Mfcalc Rules:: Grammar rules for the calculator.
* Symtab: Mfcalc Symtab. Symbol table management subroutines. * Mfcalc Symbol Table:: Symbol table management subroutines.
Bison Grammar Files Bison Grammar Files
@@ -231,6 +231,10 @@ Bison Declarations
Parser C-Language Interface Parser C-Language Interface
* Parser Function:: How to call @code{yyparse} 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 returns.
* Parser Delete Function:: How to call @code{yypstate_delete} and what it returns.
* Lexical:: You must supply a function @code{yylex} * Lexical:: You must supply a function @code{yylex}
which reads tokens. which reads tokens.
* Error Reporting:: You must supply a function @code{yyerror}. * Error Reporting:: You must supply a function @code{yyerror}.
@@ -246,8 +250,8 @@ The Lexical Analyzer Function @code{yylex}
* Token Locations:: How @code{yylex} must return the text location * Token Locations:: How @code{yylex} must return the text location
(line number, etc.) of the token, if the (line number, etc.) of the token, if the
actions want that. actions want that.
* Pure Calling:: How the calling convention differs * Pure Calling:: How the calling convention differs in a pure parser
in a pure parser (@pxref{Pure Decl, ,A Pure (Reentrant) Parser}). (@pxref{Pure Decl, ,A Pure (Reentrant) Parser}).
The Bison Parser Algorithm The Bison Parser Algorithm
@@ -316,7 +320,7 @@ Java Parsers
* Java Location Values:: The position and location classes * Java Location Values:: The position and location classes
* Java Parser Interface:: Instantiating and running the parser * Java Parser Interface:: Instantiating and running the parser
* Java Scanner Interface:: Specifying the scanner for the parser * Java Scanner Interface:: Specifying the scanner for the parser
* Java Action Features:: Special features for use in actions. * Java Action Features:: Special features for use in actions
* Java Differences:: Differences between C/C++ and Java Grammars * Java Differences:: Differences between C/C++ and Java Grammars
* Java Declarations Summary:: List of Bison declarations used with Java * Java Declarations Summary:: List of Bison declarations used with Java
@@ -331,7 +335,7 @@ Frequently Asked Questions
* I can't build Bison:: Troubleshooting * I can't build Bison:: Troubleshooting
* Where can I find help?:: Troubleshouting * Where can I find help?:: Troubleshouting
* Bug Reports:: Troublereporting * Bug Reports:: Troublereporting
* Other Languages:: Parsers in Java and others * More Languages:: Parsers in C++, Java, and so on
* Beta Testing:: Experimenting development versions * Beta Testing:: Experimenting development versions
* Mailing Lists:: Meeting other Bison users * Mailing Lists:: Meeting other Bison users
@@ -1403,16 +1407,16 @@ The source code for this calculator is named @file{rpcalc.y}. The
@samp{.y} extension is a convention used for Bison input files. @samp{.y} extension is a convention used for Bison input files.
@menu @menu
* Decls: Rpcalc Decls. Prologue (declarations) for rpcalc. * Rpcalc Declarations:: Prologue (declarations) for rpcalc.
* Rules: Rpcalc Rules. Grammar Rules for rpcalc, with explanation. * Rpcalc Rules:: Grammar Rules for rpcalc, with explanation.
* Lexer: Rpcalc Lexer. The lexical analyzer. * Rpcalc Lexer:: The lexical analyzer.
* Main: Rpcalc Main. The controlling function. * Rpcalc Main:: The controlling function.
* Error: Rpcalc Error. The error reporting function. * Rpcalc Error:: The error reporting function.
* Gen: Rpcalc Gen. Running Bison on the grammar file. * Rpcalc Generate:: Running Bison on the grammar file.
* Comp: Rpcalc Compile. Run the C compiler on the output code. * Rpcalc Compile:: Run the C compiler on the output code.
@end menu @end menu
@node Rpcalc Decls @node Rpcalc Declarations
@subsection Declarations for @code{rpcalc} @subsection Declarations for @code{rpcalc}
Here are the C and Bison declarations for the reverse polish notation Here are the C and Bison declarations for the reverse polish notation
@@ -1662,7 +1666,7 @@ therefore, @code{NUM} becomes a macro for @code{yylex} to use.
The semantic value of the token (if it has one) is stored into the The semantic value of the token (if it has one) is stored into the
global variable @code{yylval}, which is where the Bison parser will look global variable @code{yylval}, which is where the Bison parser will look
for it. (The C data type of @code{yylval} is @code{YYSTYPE}, which was for it. (The C data type of @code{yylval} is @code{YYSTYPE}, which was
defined at the beginning of the grammar; @pxref{Rpcalc Decls, defined at the beginning of the grammar; @pxref{Rpcalc Declarations,
,Declarations for @code{rpcalc}}.) ,Declarations for @code{rpcalc}}.)
A token type code of zero is returned if the end-of-input is encountered. A token type code of zero is returned if the end-of-input is encountered.
@@ -1758,7 +1762,7 @@ have not written any error rules in this example, so any invalid input will
cause the calculator program to exit. This is not clean behavior for a cause the calculator program to exit. This is not clean behavior for a
real calculator, but it is adequate for the first example. real calculator, but it is adequate for the first example.
@node Rpcalc Gen @node Rpcalc Generate
@subsection Running Bison to Make the Parser @subsection Running Bison to Make the Parser
@cindex running Bison (introduction) @cindex running Bison (introduction)
@@ -1977,12 +1981,12 @@ most of the work needed to use locations will be done in the lexical
analyzer. analyzer.
@menu @menu
* Decls: Ltcalc Decls. Bison and C declarations for ltcalc. * Ltcalc Declarations:: Bison and C declarations for ltcalc.
* Rules: Ltcalc Rules. Grammar rules for ltcalc, with explanations. * Ltcalc Rules:: Grammar rules for ltcalc, with explanations.
* Lexer: Ltcalc Lexer. The lexical analyzer. * Ltcalc Lexer:: The lexical analyzer.
@end menu @end menu
@node Ltcalc Decls @node Ltcalc Declarations
@subsection Declarations for @code{ltcalc} @subsection Declarations for @code{ltcalc}
The C and Bison declarations for the location tracking calculator are The C and Bison declarations for the location tracking calculator are
@@ -2218,12 +2222,12 @@ $
Note that multiple assignment and nested function calls are permitted. Note that multiple assignment and nested function calls are permitted.
@menu @menu
* Decl: Mfcalc Decl. Bison declarations for multi-function calculator. * Mfcalc Declarations:: Bison declarations for multi-function calculator.
* Rules: Mfcalc Rules. Grammar rules for the calculator. * Mfcalc Rules:: Grammar rules for the calculator.
* Symtab: Mfcalc Symtab. Symbol table management subroutines. * Mfcalc Symbol Table:: Symbol table management subroutines.
@end menu @end menu
@node Mfcalc Decl @node Mfcalc Declarations
@subsection Declarations for @code{mfcalc} @subsection Declarations for @code{mfcalc}
Here are the C and Bison declarations for the multi-function calculator. Here are the C and Bison declarations for the multi-function calculator.
@@ -2319,7 +2323,7 @@ exp: NUM @{ $$ = $1; @}
%% %%
@end smallexample @end smallexample
@node Mfcalc Symtab @node Mfcalc Symbol Table
@subsection The @code{mfcalc} Symbol Table @subsection The @code{mfcalc} Symbol Table
@cindex symbol table example @cindex symbol table example
@@ -5224,10 +5228,8 @@ in the grammar file, you are likely to run into trouble.
* Parser Function:: How to call @code{yyparse} 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. * 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. * 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 returns.
* Parser Delete Function:: How to call @code{yypstate_delete} and what it
returns.
* Lexical:: You must supply a function @code{yylex} * Lexical:: You must supply a function @code{yylex}
which reads tokens. which reads tokens.
* Error Reporting:: You must supply a function @code{yyerror}. * Error Reporting:: You must supply a function @code{yyerror}.
@@ -5405,8 +5407,8 @@ that need it. @xref{Invocation, ,Invoking Bison}.
* Token Locations:: How @code{yylex} must return the text location * Token Locations:: How @code{yylex} must return the text location
(line number, etc.) of the token, if the (line number, etc.) of the token, if the
actions want that. actions want that.
* Pure Calling:: How the calling convention differs * Pure Calling:: How the calling convention differs in a pure parser
in a pure parser (@pxref{Pure Decl, ,A Pure (Reentrant) Parser}). (@pxref{Pure Decl, ,A Pure (Reentrant) Parser}).
@end menu @end menu
@node Calling Convention @node Calling Convention
@@ -7653,7 +7655,7 @@ standard I/O stream, the numeric code for the token type, and the token
value (from @code{yylval}). value (from @code{yylval}).
Here is an example of @code{YYPRINT} suitable for the multi-function Here is an example of @code{YYPRINT} suitable for the multi-function
calculator (@pxref{Mfcalc Decl, ,Declarations for @code{mfcalc}}): calculator (@pxref{Mfcalc Declarations, ,Declarations for @code{mfcalc}}):
@smallexample @smallexample
%@{ %@{
@@ -8733,7 +8735,7 @@ main (int argc, char *argv[])
* Java Location Values:: The position and location classes * Java Location Values:: The position and location classes
* Java Parser Interface:: Instantiating and running the parser * Java Parser Interface:: Instantiating and running the parser
* Java Scanner Interface:: Specifying the scanner for the parser * Java Scanner Interface:: Specifying the scanner for the parser
* Java Action Features:: Special features for use in actions. * Java Action Features:: Special features for use in actions
* Java Differences:: Differences between C/C++ and Java Grammars * Java Differences:: Differences between C/C++ and Java Grammars
* Java Declarations Summary:: List of Bison declarations used with Java * Java Declarations Summary:: List of Bison declarations used with Java
@end menu @end menu
@@ -10357,7 +10359,7 @@ grammatically indivisible. The piece of text it represents is a token.
@c LocalWords: akim fn cp syncodeindex vr tp synindex dircategory direntry @c LocalWords: akim fn cp syncodeindex vr tp synindex dircategory direntry
@c LocalWords: ifset vskip pt filll insertcopying sp ISBN Etienne Suvasa @c LocalWords: ifset vskip pt filll insertcopying sp ISBN Etienne Suvasa
@c LocalWords: ifnottex yyparse detailmenu GLR RPN Calc var Decls Rpcalc @c LocalWords: ifnottex yyparse detailmenu GLR RPN Calc var Decls Rpcalc
@c LocalWords: rpcalc Lexer Gen Comp Expr ltcalc mfcalc Decl Symtab yylex @c LocalWords: rpcalc Lexer Expr ltcalc mfcalc yylex
@c LocalWords: yyerror pxref LR yylval cindex dfn LALR samp gpl BNF xref @c LocalWords: yyerror pxref LR yylval cindex dfn LALR samp gpl BNF xref
@c LocalWords: const int paren ifnotinfo AC noindent emph expr stmt findex @c LocalWords: const int paren ifnotinfo AC noindent emph expr stmt findex
@c LocalWords: glr YYSTYPE TYPENAME prog dprec printf decl init stmtMerge @c LocalWords: glr YYSTYPE TYPENAME prog dprec printf decl init stmtMerge