This is the mail archive of the
gcc-patches@gcc.gnu.org
mailing list for the GCC project.
Re: Doc Patch: sourcebuild.texi (#3)
- From: "Tom Browder" <tom dot browder at gmail dot com>
- To: "Joseph S. Myers" <joseph at codesourcery dot com>
- Cc: gcc-patches at gcc dot gnu dot org
- Date: Fri, 15 Feb 2008 08:11:44 -0600
- Subject: Re: Doc Patch: sourcebuild.texi (#3)
I have incorporated Joseph's suggestions (see below). Make info and
make dvi work. Please reconsider the attached patch.
-Tom
ChangeLog
==========
2008-02-11 Tom Browder <tom.browder@gmail.com>
* doc/sourcebuild.texi
(Top Level): Add missing or new directories. Delete obsolete,
renamed, or moved directories. Put directories in 'ls -1' order.
(gcc Directory): Ditto.
On Thu, Feb 14, 2008 at 6:48 AM, Joseph S. Myers
<joseph@codesourcery.com> wrote:
...
> > +@item config
> > +Configuration files shared among multiple projects using GCC's source
> > +repository.
>
> Not projects using its repository, GCC and projects using the separate
> "src" repository.
Changed.
> > +@item INSTALL
> > +This directory is obsolete for GCC snapshots and CVS access. For
>
> We moved from CVS years ago; the practice now should be avoiding
> mentioning the particular version control system in use.
Changed.
> > +releases the installation documentation is generated from
> > +gcc/doc/install.texi and copied into this directory. To read the
>
> @file{gcc/doc/install.texi}.
> > +documentation, point your HTML browser to ``index.html.''
>
> I don't think the last sentence is useful. Logical quoting is used; the
> trailing "." is not part of the file name; and file names should be marked
> up with @file.
Done.
Index: sourcebuild.texi
===================================================================
--- sourcebuild.texi (revision 132340)
+++ sourcebuild.texi (working copy)
@@ -33,14 +33,21 @@ subdirectories that contain parts of GCC
The Boehm conservative garbage collector, used as part of the Java
runtime library.
+@item config
+Configuration files shared among GCC and projects using the separate ``src''
+repository.
+
@item contrib
Contributed scripts that may be found useful in conjunction with GCC@.
One of these, @file{contrib/texi2pod.pl}, is used to generate man
pages from Texinfo manuals as part of the GCC build process.
-@item fastjar
-An implementation of the @command{jar} command, used with the Java
-front end.
+@item fixincludes
+The support for fixing system headers to work with GCC@. See
+@file{fixincludes/README} for more information. The headers fixed by this
+mechanism are installed in @file{@var{libsubdir}/include}. Along with
+those headers, @file{README-fixinc} is also installed, as
+@file{@var{libsubdir}/include/README}.
@item gcc
The main sources of GCC itself (except for runtime libraries),
@@ -48,21 +55,42 @@ including optimizers, support for differ
language front ends, and testsuites. @xref{gcc Directory, , The
@file{gcc} Subdirectory}, for details.
+@item gnattools
+Tools for the Ada language.
+
@item include
Headers for the @code{libiberty} library.
+@item INSTALL
+This directory is obsolete for GCC snapshots and repository access.
+For releases the installation documentation is generated from
+@file{gcc/doc/install.texi} and copied into this directory.
+
+@item intl
+GNU @code{libintl}, from GNU @code{gettext}, for systems which do not
+include it in libc.
+
@item libada
The Ada runtime library.
@item libcpp
The C preprocessor library.
-@item libgfortran
-The Fortran runtime library.
+@item libdecnumber
+The @code{libdecnumber} decimal arithmetic library.
@item libffi
The @code{libffi} library, used as part of the Java runtime library.
+@item libgcc
+The @code{libgcc} library, used for GCC internals.
+
+@item libgfortran
+The Fortran runtime library.
+
+@item libgomp
+The @code{libgomp} OpenMP runtime library.
+
@item libiberty
The @code{libiberty} library, used for portability and for some
generally useful data structures and algorithms. @xref{Top, ,
@@ -79,6 +107,9 @@ dereferencing operations.
@item libobjc
The Objective-C and Objective-C++ runtime library.
+@item libssp
+The @code{libssp} stack smash protection runtime library.
+
@item libstdc++-v3
The C++ runtime library.
@@ -142,24 +173,12 @@ Texinfo documentation for GCC, together
man pages and support for converting the installation manual to
HTML@. @xref{Documentation}.
-@item fixinc
-The support for fixing system headers to work with GCC@. See
-@file{fixinc/README} for more information. The headers fixed by this
-mechanism are installed in @file{@var{libsubdir}/include}. Along with
-those headers, @file{README-fixinc} is also installed, as
-@file{@var{libsubdir}/include/README}.
-
@item ginclude
System headers installed by GCC, mainly those required by the C
standard of freestanding implementations. @xref{Headers, , Headers
Installed by GCC}, for details of when these and other headers are
installed.
-@item intl
-GNU @code{libintl}, from GNU @code{gettext}, for systems which do not
-include it in libc. Properly, this directory should be at top level,
-parallel to the @file{gcc} directory.
-
@item po
Message catalogs with translations of messages produced by GCC into
various languages, @file{@var{language}.po}. This directory also