[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 3/3] doc: tidy the text files
|
From: |
Akim Demaille |
|
Subject: |
[PATCH 3/3] doc: tidy the text files |
|
Date: |
Mon, 29 Jun 2020 19:10:36 +0200 |
* etc/README: Rename/reformat as...
* etc/README.md: this.
And ship it.
---
NEWS | 102 ++++++++++++++++++++++------------------------
README | 20 ++++-----
README-hacking.md | 3 ++
TODO | 18 +++-----
etc/README | 38 -----------------
etc/README.md | 36 ++++++++++++++++
etc/local.mk | 3 +-
7 files changed, 105 insertions(+), 115 deletions(-)
delete mode 100644 etc/README
create mode 100644 etc/README.md
diff --git a/NEWS b/NEWS
index 60587f7f..a715694c 100644
--- a/NEWS
+++ b/NEWS
@@ -4206,63 +4206,57 @@ Output file does not redefine const for C++.
-----
-Copyright (C) 1995-2015, 2018-2020 Free Software Foundation, Inc.
-
-This file is part of Bison, the GNU Parser Generator.
-
-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/>.
-
- LocalWords: yacc YYBACKUP glr GCC lalr ArrayIndexOutOfBoundsException nullptr
- LocalWords: cplusplus liby rpl fprintf mfcalc Wyacc stmt cond expr mk sym lr
- LocalWords: IELR ielr Lookahead YYERROR nonassoc LALR's api lookaheads yychar
- LocalWords: destructor lookahead YYRHSLOC YYLLOC Rhs ifndef YYFAIL cpp sr rr
- LocalWords: preprocessor initializer Wno Wnone Werror FreeBSD prec livelocks
- LocalWords: Solaris AIX UX RHEL Tru LHS gcc's Wundef YYENABLE NLS YYLTYPE VCG
- LocalWords: yyerror cpp's Wunused yylval yylloc prepend yyparse yylex yypush
- LocalWords: Graphviz xml nonterminals midrule destructor's YYSTYPE typedef ly
- LocalWords: CHR chr printf stdout namespace preprocessing enum pre include's
- LocalWords: YYRECOVERING nonfree destructors YYABORT YYACCEPT params enums de
- LocalWords: struct yystype DJGPP lex param Haible NUM alloca YYSTACK NUL goto
- LocalWords: YYMAXDEPTH Unescaped UCNs YYLTYPE's yyltype typedefs inline Yaccs
- LocalWords: Heriyanto Reenable dprec Hilfinger Eggert MYEOF Folle Menezes EOF
- LocalWords: Lackovic define's itemset Groff Gettext malloc NEWS'ed YYDEBUG YY
- LocalWords: namespaces strerror const autoconfiguration Dconst Autoconf's FDL
- LocalWords: Automake TMPDIR LESSEQ ylwrap endif yydebug YYTOKEN YYLSP ival hh
- LocalWords: extern YYTOKENTYPE TOKENTYPE yytokentype tokentype STYPE lval pdf
- LocalWords: lang yyoutput dvi html ps POSIX lvalp llocp Wother nterm arg init
- LocalWords: TOK calc yyo fval Wconflicts parsers yystackp yyval yynerrs
- LocalWords: Théophile Ranquet Santet fno fnone stype associativity Tolmer
- 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
+LocalWords: yacc YYBACKUP glr GCC lalr ArrayIndexOutOfBoundsException nullptr
+LocalWords: cplusplus liby rpl fprintf mfcalc Wyacc stmt cond expr mk sym lr
+LocalWords: IELR ielr Lookahead YYERROR nonassoc LALR's api lookaheads yychar
+LocalWords: destructor lookahead YYRHSLOC YYLLOC Rhs ifndef YYFAIL cpp sr rr
+LocalWords: preprocessor initializer Wno Wnone Werror FreeBSD prec livelocks
+LocalWords: Solaris AIX UX RHEL Tru LHS gcc's Wundef YYENABLE NLS YYLTYPE VCG
+LocalWords: yyerror cpp's Wunused yylval yylloc prepend yyparse yylex yypush
+LocalWords: Graphviz xml nonterminals midrule destructor's YYSTYPE typedef ly
+LocalWords: CHR chr printf stdout namespace preprocessing enum pre include's
+LocalWords: YYRECOVERING nonfree destructors YYABORT YYACCEPT params enums de
+LocalWords: struct yystype DJGPP lex param Haible NUM alloca YYSTACK NUL goto
+LocalWords: YYMAXDEPTH Unescaped UCNs YYLTYPE's yyltype typedefs inline Yaccs
+LocalWords: Heriyanto Reenable dprec Hilfinger Eggert MYEOF Folle Menezes EOF
+LocalWords: Lackovic define's itemset Groff Gettext malloc NEWS'ed YYDEBUG YY
+LocalWords: namespaces strerror const autoconfiguration Dconst Autoconf's FDL
+LocalWords: Automake TMPDIR LESSEQ ylwrap endif yydebug YYTOKEN YYLSP ival hh
+LocalWords: extern YYTOKENTYPE TOKENTYPE yytokentype tokentype STYPE lval pdf
+LocalWords: lang yyoutput dvi html ps POSIX lvalp llocp Wother nterm arg init
+LocalWords: TOK calc yyo fval Wconflicts parsers yystackp yyval yynerrs
+LocalWords: Théophile Ranquet Santet fno fnone stype associativity Tolmer
+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:
ispell-dictionary: "american"
mode: outline
fill-column: 76
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.
diff --git a/README b/README
index 705cbd7d..489caa70 100644
--- a/README
+++ b/README
@@ -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
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
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
-
-->
diff --git a/README-hacking.md b/README-hacking.md
index 12b1b264..533b5e35 100644
--- a/README-hacking.md
+++ b/README-hacking.md
@@ -243,6 +243,9 @@ processes tabs in its input.
Prefer `res` as the name of the local variable that will be "return"ed by
the function.
+In writing arithmetic comparisons, use "<" and "<=" rather than ">" and ">="
+(http://www.gelato.unsw.edu.au/archives/git/0505/4507.html).
+
### Bison
Follow the GNU Coding Standards.
diff --git a/TODO b/TODO
index f8799078..31734891 100644
--- a/TODO
+++ b/TODO
@@ -617,15 +617,9 @@ 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/>.
+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.
diff --git a/etc/README b/etc/README
deleted file mode 100644
index d3122855..00000000
--- a/etc/README
+++ /dev/null
@@ -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:
diff --git a/etc/README.md b/etc/README.md
new file mode 100644
index 00000000..c7c67b4a
--- /dev/null
+++ b/etc/README.md
@@ -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.
+
+-->
diff --git a/etc/local.mk b/etc/local.mk
index 53985069..d03db45f 100644
--- a/etc/local.mk
+++ b/etc/local.mk
@@ -14,4 +14,5 @@
## You should have received a copy of the GNU General Public License
## 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
--
2.27.0