Replacing README

Joseph S. Myers jsm28@cam.ac.uk
Tue Jun 12 17:32:00 GMT 2001


As previously discussed, the toplevel README - pretending that a GCC
distribution might be a distribution of something else - is confusing and
unnecessary.  gcc/README also contains more than it needs.  The following
version is a cut down version of gcc/README that I think should replace
the toplevel README (with gcc/README then being removed), along with a
diff from the current gcc/REAMDE.  OK to commit to mainline and branch?

This directory contains the GNU Compiler Collection (GCC) version 3.0.

The GNU Compiler Collection is free software.  See the file COPYING
for copying permission.  The manuals, and some of the runtime
libraries, are under different terms; see the individual source files
for details.

The directory INSTALL contains copies of the installation information
as HTML and plain text.  The source of this information is
gcc/doc/install.texi.  The installation information includes details
of what is included in the GCC sources and what files GCC installs.

See the file gcc/doc/gcc.texi (together with other files that it
includes) for usage and porting information.  An online readable
version of the manual is in the files gcc/doc/gcc.info*.

See http://gcc.gnu.org/bugs.html for how to report bugs usefully.

--- gcc/README	Fri Jun  1 21:58:36 2001
+++ README	Wed Jun 13 00:26:55 2001
@@ -1,26 +1,17 @@
 This directory contains the GNU Compiler Collection (GCC) version 3.0.
-It includes all of the support for compiling C, C++, Objective C, Fortran,
-Java, and Chill.
 
-The GNU Compiler Collection is free software.  See the file COPYING for
-copying permission.
+The GNU Compiler Collection is free software.  See the file COPYING
+for copying permission.  The manuals, and some of the runtime
+libraries, are under different terms; see the individual source files
+for details.
 
-See the file doc/gcc.texi (together with other files that it includes)
-for installation and porting information.  The directory ../INSTALL
-contains copies of the installation information as HTML and plain text.
+The directory INSTALL contains copies of the installation information
+as HTML and plain text.  The source of this information is
+gcc/doc/install.texi.  The installation information includes details
+of what is included in the GCC sources and what files GCC installs.
 
-Installing this package will create various files in subdirectories of
-/usr/local/lib, which are passes used by the compiler and a library
-named libgcc.a.  It will also create /usr/local/bin/gcc, which is
-the user-level command to do a compilation.
+See the file gcc/doc/gcc.texi (together with other files that it
+includes) for usage and porting information.  An online readable
+version of the manual is in the files gcc/doc/gcc.info*.
 
-See the Bugs chapter of the GCC Manual for how to report bugs
-usefully.  An online readable version of the manual is in the files
-gcc.info*.
-
-The files pself.c and pself1.c are not part of GCC.
-They are programs that print themselves on standard output.
-They were written by Dario Dariol and Giovanni Cozzi, and are
-included for your hacking pleasure.  Likewise pself2.c
-(Who is the author of that?) and pself3.c (by Vlad Taeerov and Rashit
-Fakhreyev).
+See http://gcc.gnu.org/bugs.html for how to report bugs usefully.

-- 
Joseph S. Myers
jsm28@cam.ac.uk



More information about the Gcc-patches mailing list