doc: document experimental features better.

* doc/bison.texinfo (Introduction): Say that IELR(1) and canonical
LR(1) are experimental.  Mention Java.  Normally experimental
features probably shouldn't be mentioned in the introduction.
However, if Bison's limitations to LALR(1), C, and C++ are so
important that they should be mentioned here, then it's important
to point out that Bison is beginning to escape those limitations.
Moreover, these particular experimental features have very little
chance of being removed.
* src/getargs.c (usage): Say that IELR(1) and canonical LR(1) are
experimental.
(cherry picked from commit d89e48b3c9)
This commit is contained in:
Joel E. Denny
2011-02-06 08:52:09 -05:00
parent 82f3355eaf
commit af28d414f3
3 changed files with 33 additions and 16 deletions

View File

@@ -1,3 +1,17 @@
2011-02-06 Joel E. Denny <joeldenny@joeldenny.org>
doc: document experimental features better.
* doc/bison.texinfo (Introduction): Say that IELR(1) and canonical
LR(1) are experimental. Mention Java. Normally experimental
features probably shouldn't be mentioned in the introduction.
However, if Bison's limitations to LALR(1), C, and C++ are so
important that they should be mentioned here, then it's important
to point out that Bison is beginning to escape those limitations.
Moreover, these particular experimental features have very little
chance of being removed.
* src/getargs.c (usage): Say that IELR(1) and canonical LR(1) are
experimental.
2011-01-29 Joel E. Denny <joeldenny@joeldenny.org> 2011-01-29 Joel E. Denny <joeldenny@joeldenny.org>
Do not allow identifiers that start with a dash. Do not allow identifiers that start with a dash.

View File

@@ -353,23 +353,25 @@ Copying This Manual
@cindex introduction @cindex introduction
@dfn{Bison} is a general-purpose parser generator that converts an @dfn{Bison} is a general-purpose parser generator that converts an
annotated context-free grammar into a deterministic LR or annotated context-free grammar into a deterministic LR or generalized
generalized LR (GLR) parser employing LR (GLR) parser employing LALR(1) parser tables. As an experimental
LALR(1), IELR(1), or canonical LR(1) feature, Bison can also generate IELR(1) or canonical LR(1) parser
parser tables. tables. Once you are proficient with Bison, you can use it to develop
Once you are proficient with Bison, you can use it to develop a wide a wide range of language parsers, from those used in simple desk
range of language parsers, from those used in simple desk calculators to calculators to complex programming languages.
complex programming languages.
Bison is upward compatible with Yacc: all properly-written Yacc grammars Bison is upward compatible with Yacc: all properly-written Yacc
ought to work with Bison with no change. Anyone familiar with Yacc grammars ought to work with Bison with no change. Anyone familiar
should be able to use Bison with little trouble. You need to be fluent in with Yacc should be able to use Bison with little trouble. You need
C or C++ programming in order to use Bison or to understand this manual. to be fluent in C or C++ programming in order to use Bison or to
understand this manual. Java is also supported as an experimental
feature.
We begin with tutorial chapters that explain the basic concepts of using We begin with tutorial chapters that explain the basic concepts of
Bison and show three explained examples, each building on the last. If you using Bison and show three explained examples, each building on the
don't know Bison or Yacc, start by reading these chapters. Reference last. If you don't know Bison or Yacc, start by reading these
chapters follow which describe specific aspects of Bison in detail. chapters. Reference chapters follow, which describe specific aspects
of Bison in detail.
Bison was written primarily by Robert Corbett; Richard Stallman made it Bison was written primarily by Robert Corbett; Richard Stallman made it
Yacc-compatible. Wilfred Hansen of Carnegie Mellon University added Yacc-compatible. Wilfred Hansen of Carnegie Mellon University added

View File

@@ -263,7 +263,8 @@ usage (int status)
printf (_("Usage: %s [OPTION]... FILE\n"), program_name); printf (_("Usage: %s [OPTION]... FILE\n"), program_name);
fputs (_("\ fputs (_("\
Generate a deterministic LR or generalized LR (GLR) parser employing\n\ Generate a deterministic LR or generalized LR (GLR) parser employing\n\
LALR(1), IELR(1), or canonical LR(1) parser tables.\n\ LALR(1), IELR(1), or canonical LR(1) parser tables. IELR(1) and\n\
canonical LR(1) support is experimental.\n\
\n\ \n\
"), stdout); "), stdout);