Merge remote-tracking branch 'origin/maint'

[bison.git] / djgpp / README.in

diff --git a/djgpp/README.in b/djgpp/README.in
index df657655ce52a843d7f3bbc6d78705cc1e878107..60fd952ac69abe3e1c4f18cc459bc7dc5ca27c81 100644 (file)
--- a/djgpp/README.in
+++ b/djgpp/README.in
@@ -1,11 +1,11 @@
 This is a port of GNU Bison @VERSION@ to MSDOS/DJGPP.
 
 This is a port of GNU Bison @VERSION@ to MSDOS/DJGPP.
 

-Copyright (C) 2005 Free Software Foundation, Inc.
+Copyright (C) 2005-2012 Free Software Foundation, Inc.

 
 

-This program 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
 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.

 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of


@@ -13,8 +13,7 @@ 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
 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, write to the Free Software Foundation,
-Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

 
 
 1.:     DJGPP specific changes.
 
 
 1.:     DJGPP specific changes.


@@ -22,11 +21,11 @@ Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
        The DJGPP port of Bison offers LFN and SFN support depending on which
        OS it is running. If LFN support is available or not is determinated at
 
        The DJGPP port of Bison offers LFN and SFN support depending on which
        OS it is running. If LFN support is available or not is determinated at

-       run time.  If LFN support is available (DOS session under Win9X), the
-       standard posix file name extensions will be used.  These are: y.tab.c,
-       y.tab.c++, y.tab.h, y.output, etc.  If only SFN support is available
-       (plain DOS), then the standard MSDOS short file names will be used.
-       These are: y_tab.c, y_tab.h, y.out, etc.
+       run time.  If LFN support is available (DOS session under Win9X, Win2K,
+       WinXP, etc.) the standard posix file name extensions will be used.
+       These are: y.tab.c, y.tab.c++, y.tab.h, y.output, etc.  If only SFN
+       support is available (plain DOS), then the standard MSDOS short file
+       names will be used. These are: y_tab.c, y_tab.h, y.out, etc.

        It should be noticed that this bison version needs the m4 program as
        back end to generate the parser file (y.tab.c etc.) from the skeleton
        files.  This implies that m4 must always be installed to get bison
        It should be noticed that this bison version needs the m4 program as
        back end to generate the parser file (y.tab.c etc.) from the skeleton
        files.  This implies that m4 must always be installed to get bison


@@ -34,7 +33,7 @@ Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
        /dev/env/DJDIR/share/bison and shall not be removed.
        It should also be noticed that the skeleton files bison.simple and
        bison.hairy are no longer supported.  This applies also to the environ-
        /dev/env/DJDIR/share/bison and shall not be removed.
        It should also be noticed that the skeleton files bison.simple and
        bison.hairy are no longer supported.  This applies also to the environ-

-       ment variables BISON_HAIRY and BISON_SIMPLE. Those variables are *no*
+       ment variables BISON_HAIRY and BISON_SIMPLE.  Those variables are *no*

        longer honored at all.
        The kind of skeleton file bison.hairy is no longer supported at all.
        The skeleton file bison.simple is now called yacc.c and is an m4 script.
        longer honored at all.
        The kind of skeleton file bison.hairy is no longer supported at all.
        The skeleton file bison.simple is now called yacc.c and is an m4 script.


@@ -46,8 +45,13 @@ Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
        This is done by forking and using pipes for the IPC.  MSDOS does not
        support this functionality so this has been reproduced in the usual
        way by redirecting stdin and stdout of bison and m4 to temporary files
        This is done by forking and using pipes for the IPC.  MSDOS does not
        support this functionality so this has been reproduced in the usual
        way by redirecting stdin and stdout of bison and m4 to temporary files

-       and processing these files in sequence.  All the changes to the sources
-       are documented in the djgpp/diffs file.
+       and processing these files in sequence.
+       It should be noticed that due to the great amount of file names that do
+       not cleanly map to 8.3 file names, you will need an OS with LFN support
+       to configure and compile the sources. On Win98 this implies that the
+       generation of numeric tails for 8.3 file name aliases must be enabled
+       or the compilation will fail.
+

 
        Please **read** the docs.
 
 
        Please **read** the docs.
 


@@ -80,7 +84,7 @@ Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
        some more work to unpack, if LFN support is not available.  If LFN is
        available then you can extract the source files from the archive with
        any unzip program and proceed to the paragraph 3.3, below.  Any file
        some more work to unpack, if LFN support is not available.  If LFN is
        available then you can extract the source files from the archive with
        any unzip program and proceed to the paragraph 3.3, below.  Any file

-       name issue will be handled by the the DJGPP configuration files.
+       name issue will be handled by the DJGPP configuration files.

        To unpack the source distribution on SFN systems, first, you MUST use
        the `djunpack' batch file to unzip the package.  That is because some
        file names in the official distributions need to be changed to avoid
        To unpack the source distribution on SFN systems, first, you MUST use
        the `djunpack' batch file to unzip the package.  That is because some
        file names in the official distributions need to be changed to avoid


@@ -91,12 +95,12 @@ Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
        with the necessary mappings.  So you need first to retrieve that batch
        file, and then invoke it to unpack the distribution.  Here's how:
 
        with the necessary mappings.  So you need first to retrieve that batch
        file, and then invoke it to unpack the distribution.  Here's how:
 

-         djtar -x -p -o bison-2.1/djgpp/djunpack.bat bison-2.1.tar.gz > djunpack.bat
-         djunpack bison-2.1.tar.gz
+         djtar -x -p -o bison-@VERSION@/djgpp/djunpack.bat bison-@VERSION@.tar.gz > djunpack.bat
+         djunpack bison-@VERSION@.tar.gz

 
        (The name of the distribution archive and the leading directory of the
        path to `djunpack.bat' in the distribution will be different for
 
        (The name of the distribution archive and the leading directory of the
        path to `djunpack.bat' in the distribution will be different for

-       versions of Bison other than 2.1.)
+       versions of Bison other than @VERSION@.)

 
        If the argument to `djunpack.bat' include leading directories, it MUST
        be given with the DOS-style backslashes; Unix-style forward slashes
 
        If the argument to `djunpack.bat' include leading directories, it MUST
        be given with the DOS-style backslashes; Unix-style forward slashes


@@ -106,29 +110,26 @@ Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
        `djtar' doesn't support bzip2 decompression, you need to unpack it as
        follows:
 
        `djtar' doesn't support bzip2 decompression, you need to unpack it as
        follows:
 

-         bnzip2 bison-2.1.tar.bz2
-         djtar -x -p -o bison-2.1/djgpp/djunpack.bat bison-2.1.tar > djunpack.bat
-         djunpack bison-2.1.tar
+         bnzip2 bison-@VERSION@.tar.bz2
+         djtar -x -p -o bison-@VERSION@/djgpp/djunpack.bat bison-@VERSION@.tar > djunpack.bat
+         djunpack bison-@VERSION@.tar

 
 3.3.:   To build the binaries you will need the following binary packages:
          djdev203.zip (or a later but NOT a prior version)
          bsh204b.zip  (or a later but NOT a prior version)
 
 3.3.:   To build the binaries you will need the following binary packages:
          djdev203.zip (or a later but NOT a prior version)
          bsh204b.zip  (or a later but NOT a prior version)

-         gcc400b.zip, gpp400b.zip, bnu215b.zip, mak3791b.zip,
-         fil40b.zip, shl20jb.zip, txt20b.zip,
-         txi48b.zip, grep24b.zip, sed414b.zip,
-         m4-144b.zip.
+          gccNNNb.zip, gppNNN.zip, bnuNNNb.zip, makNNNb.zip, filNNNb.zip,
+          perlNNNb.zip, shlNNNb.zip, txtNNNb.zip, txiNNNb.zip, grepNNNb.zip,
+          sedNNNb.zip and m4NNN.zip

 
        If you want to run the check you will need also:
 
        If you want to run the check you will need also:

-         dif281b.zip
+         difNNNb.zip

 
 

-       All this packages can be found in the v2gnu directory of any
+       NNN represents the latest version number of the binary packages. All
+       this packages can be found in the /v2gnu directory of any

        ftp.delorie.com mirror.
        ftp.delorie.com mirror.

-       You will need bsh203b.zip or later and *NOT* a prior version or
+       You will need bsh204b.zip or later and *NOT* a prior version or

        the build will fail.  The same applies to djdev203.zip.  Please note
        the build will fail.  The same applies to djdev203.zip.  Please note

-       that Bison requires m4-144b.zip or later to work properly.  All the
-       other packages are the ones I have used to build the binaries
-       from this source.  Previuos versions of this packages may do the
-       job as well but I have not tested this.
+       that Bison requires m4-144b.zip or later to work properly.

 
 3.4.:   If for some reason you want to reconfigure the package cd into the top
        srcdir (bison-@TREE_VERSION@) and run the following commands:
 
 3.4.:   If for some reason you want to reconfigure the package cd into the top
        srcdir (bison-@TREE_VERSION@) and run the following commands:


@@ -167,9 +168,10 @@ Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
        command:
          make check
 
        command:
          make check
 

-       No test should fail.
-       Please note that the testsuite only works with LFN available.  On plain
-       DOS, most of the tests will fail due to invalid DOS names.
+       No test should fail but the tests #131 (Doxygen Public Documentation)
+       and #132 (Doxygen Private Documentation) will be skipped.  Please note
+       that the testsuite only works with LFN available.  On plain DOS, most
+       of the tests will fail due to invalid DOS names.

 
 3.7.:   To install the binaries, header, library, catalogs, and info docs
        run the following command from the top srcdir:
 
 3.7.:   To install the binaries, header, library, catalogs, and info docs
        run the following command from the top srcdir:


@@ -177,7 +179,7 @@ Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
        This will install the products into your DJGPP installation tree given
        by the default prefix "/dev/env/DJDIR".  If you prefer to install them
 
        This will install the products into your DJGPP installation tree given
        by the default prefix "/dev/env/DJDIR".  If you prefer to install them

-       into some other directory you will have to set prefix to the appropiate
+       into some other directory you will have to set prefix to the appropriate

        value:
          make install prefix=z:/some/other/place
 
        value:
          make install prefix=z:/some/other/place