X-Git-Url: https://git.saurik.com/bison.git/blobdiff_plain/2cef3017cdb3eb28a37814725d0539b87d9cdd79..70afaf26037e919f6abf3904e43845d116899df3:/README diff --git a/README b/README index 75dcf6b5..2bf62bf2 100644 --- a/README +++ b/README @@ -1,50 +1,59 @@ -This directory contains the Bison parser generator. +This package contains the GNU Bison parser generator. -See the file INSTALL for generic compilation and installation instructions. -See the file doc/FAQ for frequently asked questions. +* Installation +** Build +See the file INSTALL for generic compilation and installation +instructions. -Bison requires GNU m4 1.4 or later. Vanilla GNU m4 1.4 has some -serious bugs, so we recommend using m4 1.4 as patched by the standard -GNU/Linux distributions. If you're building GNU m4 1.4 from scratch -we suggest using this version: +Bison requires GNU m4 1.4.6 or later. See: -http://www.lrde.epita.fr/~akim/download/m4-1.4.tar.gz + ftp://ftp.gnu.org/gnu/m4/m4-1.4.6.tar.gz -Older versions of Sun Forte Developer 6 update 2 have a compiler bug -that cause "make check" to fail with a "Encounter BINCL entry" -diagnostic. To fix the bug, update to the latest set of Solaris and -Forte patches recommended by Sun. +** Internationalization +Bison supports two catalogues: one for Bison itself (i.e., for the +maintainer-side parser generation), and one for the generated parsers +(i.e., for the user-side parser execution). The requirements between +both differ: bison needs ngettext, the generated parsers do not. To +simplify the build system, neither are installed if ngettext is not +supported, even if generated parsers could have been localized. See +http://lists.gnu.org/archive/html/bug-bison/2009-08/msg00006.html for +more details. -VMS and MS-DOS builds are probably broken right now. If you are able -to build Bison on either platform and you need to make changes to do -so, please submit those changes as a bug report. On VMS, you will -probably have to create Makefile from Makefile.in by hand. Remember -to do `SET COMMAND BISON' to install the data in `BISON.CLD'. +* Questions +See the section FAQ in the documentation (doc/bison.info) for +frequently asked questions. The documentation is also available in +PDF and HTML, provided you have a recent version of Texinfo installed: +run "make pdf" or "make html". -Send bug reports to . Please include the version -number from `bison --version', and a complete, self-contained test -case in each bug report. +If you have questions about using Bison and the documentation does +not answer them, please send mail to . -If you have questions about using Bison which the documentation does -not answer, send mail to . +* Bug reports +Please send bug reports to . Please include the +version number from `bison --version', and a complete, self-contained +test case in each bug report. + + +Local Variables: +mode: outline +End: ----- -Copyright (C) 1992, 1998, 1999, 2003, 2004 Free Software Foundation, Inc. +Copyright (C) 1992, 1998, 1999, 2003, 2004, 2005, 2008-2009 Free +Software Foundation, Inc. This file is part of Bison, the GNU Compiler Compiler. -Bison is free software; you can redistribute it and/or modify +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 2, or (at your option) -any later version. +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. -Bison is distributed in the hope that it will be useful, +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 autoconf; see the file COPYING. If not, write to -the Free Software Foundation, Inc., 59 Temple Place - Suite 330, -Boston, MA 02111-1307, USA. +along with this program. If not, see .