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

doc: tidy the text files

Browse Source 
* etc/README: Rename/reformat as...
* etc/README.md: this.
And ship it.
This commit is contained in:
Akim Demaille
2020-06-29 07:34:42 +02:00
parent cd6ef1e7d7
commit 688b3404a2
7 changed files with 105 additions and 115 deletions
Download Patch File Download Diff File Expand all files Collapse all files

102
NEWS
View File

@@ -4206,63 +4206,57 @@ Output file does not redefine const for C++.
----- -----
Copyright (C) 1995-2015, 2018-2020 Free Software Foundation, Inc. LocalWords: yacc YYBACKUP glr GCC lalr ArrayIndexOutOfBoundsException nullptr
LocalWords: cplusplus liby rpl fprintf mfcalc Wyacc stmt cond expr mk sym lr
This file is part of Bison, the GNU Parser Generator. LocalWords: IELR ielr Lookahead YYERROR nonassoc LALR's api lookaheads yychar
LocalWords: destructor lookahead YYRHSLOC YYLLOC Rhs ifndef YYFAIL cpp sr rr
This program is free software: you can redistribute it and/or modify LocalWords: preprocessor initializer Wno Wnone Werror FreeBSD prec livelocks
it under the terms of the GNU General Public License as published by LocalWords: Solaris AIX UX RHEL Tru LHS gcc's Wundef YYENABLE NLS YYLTYPE VCG
the Free Software Foundation, either version 3 of the License, or LocalWords: yyerror cpp's Wunused yylval yylloc prepend yyparse yylex yypush
(at your option) any later version. LocalWords: Graphviz xml nonterminals midrule destructor's YYSTYPE typedef ly
LocalWords: CHR chr printf stdout namespace preprocessing enum pre include's
This program is distributed in the hope that it will be useful, LocalWords: YYRECOVERING nonfree destructors YYABORT YYACCEPT params enums de
but WITHOUT ANY WARRANTY; without even the implied warranty of LocalWords: struct yystype DJGPP lex param Haible NUM alloca YYSTACK NUL goto
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the LocalWords: YYMAXDEPTH Unescaped UCNs YYLTYPE's yyltype typedefs inline Yaccs
GNU General Public License for more details. LocalWords: Heriyanto Reenable dprec Hilfinger Eggert MYEOF Folle Menezes EOF
LocalWords: Lackovic define's itemset Groff Gettext malloc NEWS'ed YYDEBUG YY
You should have received a copy of the GNU General Public License LocalWords: namespaces strerror const autoconfiguration Dconst Autoconf's FDL
along with this program. If not, see <http://www.gnu.org/licenses/>. LocalWords: Automake TMPDIR LESSEQ ylwrap endif yydebug YYTOKEN YYLSP ival hh
LocalWords: extern YYTOKENTYPE TOKENTYPE yytokentype tokentype STYPE lval pdf
LocalWords: yacc YYBACKUP glr GCC lalr ArrayIndexOutOfBoundsException nullptr LocalWords: lang yyoutput dvi html ps POSIX lvalp llocp Wother nterm arg init
LocalWords: cplusplus liby rpl fprintf mfcalc Wyacc stmt cond expr mk sym lr LocalWords: TOK calc yyo fval Wconflicts parsers yystackp yyval yynerrs
LocalWords: IELR ielr Lookahead YYERROR nonassoc LALR's api lookaheads yychar LocalWords: Théophile Ranquet Santet fno fnone stype associativity Tolmer
LocalWords: destructor lookahead YYRHSLOC YYLLOC Rhs ifndef YYFAIL cpp sr rr LocalWords: Wprecedence Rassoul Wempty Paolo Bonzini parser's Michiel loc
LocalWords: preprocessor initializer Wno Wnone Werror FreeBSD prec livelocks LocalWords: redeclaration sval fcaret reentrant XSLT xsl Wmaybe yyvsp Tedi
LocalWords: Solaris AIX UX RHEL Tru LHS gcc's Wundef YYENABLE NLS YYLTYPE VCG LocalWords: pragmas noreturn untyped Rozenman unexpanded Wojciech Polak
LocalWords: yyerror cpp's Wunused yylval yylloc prepend yyparse yylex yypush LocalWords: Alexandre MERCHANTABILITY yytype emplace ptr automove lvalues
LocalWords: Graphviz xml nonterminals midrule destructor's YYSTYPE typedef ly LocalWords: nonterminal yy args Pragma dereference yyformat rhs docdir bw
LocalWords: CHR chr printf stdout namespace preprocessing enum pre include's LocalWords: Redeclarations rpcalc Autoconf YFLAGS Makefiles PROG DECL num
LocalWords: YYRECOVERING nonfree destructors YYABORT YYACCEPT params enums de LocalWords: Heimbigner AST src ast Makefile srcdir MinGW xxlex XXSTYPE
LocalWords: struct yystype DJGPP lex param Haible NUM alloca YYSTACK NUL goto LocalWords: XXLTYPE strictfp IDEs ffixit fdiagnostics parseable fixits
LocalWords: YYMAXDEPTH Unescaped UCNs YYLTYPE's yyltype typedefs inline Yaccs LocalWords: Wdeprecated yytext Variadic variadic yyrhs yyphrs RCS README
LocalWords: Heriyanto Reenable dprec Hilfinger Eggert MYEOF Folle Menezes EOF LocalWords: noexcept constexpr ispell american deprecations backend Teoh
LocalWords: Lackovic define's itemset Groff Gettext malloc NEWS'ed YYDEBUG YY LocalWords: YYPRINT Mangold Bonzini's Wdangling exVal baz checkable gcc
LocalWords: namespaces strerror const autoconfiguration Dconst Autoconf's FDL LocalWords: fsanitize Vogelsgesang lis redeclared stdint automata yytname
LocalWords: Automake TMPDIR LESSEQ ylwrap endif yydebug YYTOKEN YYLSP ival hh LocalWords: yysymbol yytnamerr yyreport ctx ARGMAX yysyntax stderr LPAREN
LocalWords: extern YYTOKENTYPE TOKENTYPE yytokentype tokentype STYPE lval pdf LocalWords: symrec yypcontext TOKENMAX yyexpected YYEMPTY yypstate YYEOF
LocalWords: lang yyoutput dvi html ps POSIX lvalp llocp Wother nterm arg init LocalWords: autocompletion bistromathic submessages Cayuela lexcalc hoc
LocalWords: TOK calc yyo fval Wconflicts parsers yystackp yyval yynerrs LocalWords: yytoken YYUNDEF YYerror basename Automake's UTF ifdef ffile
LocalWords: Théophile Ranquet Santet fno fnone stype associativity Tolmer LocalWords: gotos readline
LocalWords: Wprecedence Rassoul Wempty Paolo Bonzini parser's Michiel loc
LocalWords: redeclaration sval fcaret reentrant XSLT xsl Wmaybe yyvsp Tedi
LocalWords: pragmas noreturn untyped Rozenman unexpanded Wojciech Polak
LocalWords: Alexandre MERCHANTABILITY yytype emplace ptr automove lvalues
LocalWords: nonterminal yy args Pragma dereference yyformat rhs docdir bw
LocalWords: Redeclarations rpcalc Autoconf YFLAGS Makefiles PROG DECL num
LocalWords: Heimbigner AST src ast Makefile srcdir MinGW xxlex XXSTYPE
LocalWords: XXLTYPE strictfp IDEs ffixit fdiagnostics parseable fixits
LocalWords: Wdeprecated yytext Variadic variadic yyrhs yyphrs RCS README
LocalWords: noexcept constexpr ispell american deprecations backend Teoh
LocalWords: YYPRINT Mangold Bonzini's Wdangling exVal baz checkable gcc
LocalWords: fsanitize Vogelsgesang lis redeclared stdint automata yytname
LocalWords: yysymbol yytnamerr yyreport ctx ARGMAX yysyntax stderr LPAREN
LocalWords: symrec yypcontext TOKENMAX yyexpected YYEMPTY yypstate YYEOF
LocalWords: autocompletion bistromathic submessages Cayuela lexcalc hoc
LocalWords: yytoken YYUNDEF YYerror basename Automake's UTF ifdef ffile
LocalWords: gotos readline
Local Variables: Local Variables:
ispell-dictionary: "american" ispell-dictionary: "american"
mode: outline mode: outline
fill-column: 76 fill-column: 76
End: End:
Copyright (C) 1995-2015, 2018-2020 Free Software Foundation, Inc.
This file is part of Bison, the GNU Parser Generator.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the "GNU Free
Documentation License" file as part of this distribution.

20
README
View File

@@ -101,6 +101,16 @@ that the range specifies every single year in that closed interval.
<!-- <!--
LocalWords: parsers ngettext Texinfo pdf html YYYY ZZZZ ispell american md
LocalWords: MERCHANTABILITY GLR LALR IELR submodule init README src bw
LocalWords: Relocatability symlinks symlink
Local Variables:
mode: markdown
fill-column: 76
ispell-dictionary: "american"
End:
Copyright (C) 1992, 1998-1999, 2003-2005, 2008-2015, 2018-2020 Free Copyright (C) 1992, 1998-1999, 2003-2005, 2008-2015, 2018-2020 Free
Software Foundation, Inc. Software Foundation, Inc.
@@ -113,14 +123,4 @@ Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the "GNU Free Texts. A copy of the license is included in the "GNU Free
Documentation License" file as part of this distribution. Documentation License" file as part of this distribution.
Local Variables:
mode: markdown
fill-column: 76
ispell-dictionary: "american"
End:
LocalWords: parsers ngettext Texinfo pdf html YYYY ZZZZ ispell american md
LocalWords: MERCHANTABILITY GLR LALR IELR submodule init README src bw
LocalWords: Relocatability symlinks symlink
--> -->

3
README-hacking.md
View File

@@ -243,6 +243,9 @@ processes tabs in its input.
Prefer `res` as the name of the local variable that will be "return"ed by Prefer `res` as the name of the local variable that will be "return"ed by
the function. the function.
In writing arithmetic comparisons, use "<" and "<=" rather than ">" and ">="
(http://www.gelato.unsw.edu.au/archives/git/0505/4507.html).
### Bison ### Bison
Follow the GNU Coding Standards. Follow the GNU Coding Standards.

18
TODO
View File

@@ -617,15 +617,9 @@ Foundation, Inc.
This file is part of Bison, the GNU Compiler Compiler. This file is part of Bison, the GNU Compiler Compiler.
This program is free software: you can redistribute it and/or modify Permission is granted to copy, distribute and/or modify this document
it under the terms of the GNU General Public License as published by under the terms of the GNU Free Documentation License, Version 1.3 or
the Free Software Foundation, either version 3 of the License, or any later version published by the Free Software Foundation; with no
(at your option) any later version. Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the "GNU Free
This program is distributed in the hope that it will be useful, Documentation License" file as part of this distribution.
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.

38
etc/README
View File

@@ -1,38 +0,0 @@
* bench.pl
A primitive Perl script to run benches. Currently its only bench is
the usual calculator: it has a lightweight processing part (but not
null), so it is really emphasizing the cost of the whole parsing
(including scanning and I/O).
Set the envvars BISON and CC to the programs and flags you want to
use. They default to bison and gcc. To run a non-installed bison
from a tarball built in _build, I suggest the following.
BISON=_build/tests/bison CC='gcc -O2' ./bench.pl
(The _build/tests/bison wrapper makes sure that _build/src/bison will
use the tarballs' skeletons, not those already installed as a
straightforward use of _build/src/bison would.)
--
Copyright (C) 2006, 2009-2015, 2018-2020 Free Software Foundation, Inc.
This file is part of Bison, the GNU Compiler Compiler.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Local Variables:
mode: outline
End:

36
etc/README.md Normal file
View File

@@ -0,0 +1,36 @@
# bench.pl
A primitive Perl script to run benches. Currently its only bench is the
usual calculator: it has a lightweight processing part (but not null), so it
is really emphasizing the cost of the whole parsing (including scanning and
I/O).
Set the envvars `BISON` and `CC` to the programs and flags you want to use.
They default to `bison` and `gcc`. To run a non-installed bison from a
tarball built in _build, I suggest the following.
BISON=_build/tests/bison CC='gcc -O2' ./bench.pl
(The `_build/tests/bison` wrapper makes sure that `_build/src/bison` will
use the tarballs' skeletons, not those already installed as a
straightforward use of `_build/src/bison` would.)
<!--
Local Variables:
mode: markdown
fill-column: 76
ispell-dictionary: "american"
End:
Copyright (C) 2006, 2009-2015, 2018-2020 Free Software Foundation, Inc.
This file is part of Bison, the GNU Compiler Compiler.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the "GNU Free
Documentation License" file as part of this distribution.
-->

3
etc/local.mk
View File

@@ -14,4 +14,5 @@
## You should have received a copy of the GNU General Public License ## You should have received a copy of the GNU General Public License
## along with this program. If not, see <http://www.gnu.org/licenses/>. ## along with this program. If not, see <http://www.gnu.org/licenses/>.
nodist_noinst_SCRIPTS = etc/bench.pl dist_noinst_DATA = %D%/README.md
nodist_noinst_SCRIPTS = %D%/bench.pl