[PATCH] sourcebuild.texi: Document new toplevel directories [PR82383]

[PATCH] sourcebuild.texi: Document new toplevel directories [PR82383]

[Eric Gallager]

[-- Attachment #1: Type: text/plain, Size: 405 bytes --]

This patch adds entries for the c++tools, gotools, libbacktrace,
libcc1, libcody, liboffloadmic, and libsanitizer directories into the
list of toplevel source directories in sourcebuild.texi. I also
removed the entry for boehm-gc (which is no longer in-tree), and fixed
the alphabetization for libquadmath while I was at it. Any style nits
I need to fix before committing (with a proper ChangeLog entry)?

[-- Attachment #2: patch-sourcebuild.texi.diff --]
[-- Type: application/octet-stream, Size: 2368 bytes --]

diff --git a/gcc/doc/sourcebuild.texi b/gcc/doc/sourcebuild.texi
index d465b046d6d..286b1ebd947 100644
--- a/gcc/doc/sourcebuild.texi
+++ b/gcc/doc/sourcebuild.texi
@@ -27,9 +27,9 @@ distributions such as that of GNU Binutils.  It also contains several
 subdirectories that contain parts of GCC and its runtime libraries:
 
 @table @file
-@item boehm-gc
-The Boehm conservative garbage collector, optionally used as part of
-the ObjC runtime library when configured with @option{--enable-objc-gc}.
+@item c++tools
+Contains the sources for the g++-mapper-server, a tool used with
+C++ modules.
 
 @item config
 Autoconf macros and Makefile fragments used throughout the tree.
@@ -55,6 +55,9 @@ language front ends, and testsuites.  @xref{gcc Directory, , The
 @item gnattools
 Support tools for GNAT.
 
+@item gotools
+Support tools for Go.
+
 @item include
 Headers for the @code{libiberty} library.
 
@@ -69,6 +72,16 @@ The Ada runtime library.
 The runtime support library for atomic operations (e.g.@: for @code{__sync}
 and @code{__atomic}).
 
+@item libbacktrace
+A library that allows gcc to produce backtraces when it crashes.
+
+@item libcc1
+A library that allows gdb to make use of the compiler.
+
+@item libcody
+A compiler dynamism library to allow communication between compilers and
+build systems, for purposes such as C++ modules.
+
 @item libcpp
 The C preprocessor library.
 
@@ -103,19 +116,30 @@ The runtime support library for transactional memory.
 @item libobjc
 The Objective-C and Objective-C++ runtime library.
 
-@item libquadmath
-The runtime support library for quad-precision math operations.
+@item liboffloadmic
+A library to allow OpenMP to Intel MIC targets.
 
 @item libphobos
 The D standard and runtime library.  The bulk of this library is mirrored
 from the @uref{https://github.com/@/dlang, master D repositories}.
 
+@item libquadmath
+The runtime support library for quad-precision math operations.
+
+@item libsanitizer
+Libraries for various sanitizers.  The bulk of this directory is mirrored
+from the @uref{https://github.com/google/sanitizers, Google sanitizers
+repositories}.
+
 @item libssp
 The Stack protector runtime library.
 
 @item libstdc++-v3
 The C++ runtime library.
 
+@item libvtv
+The vtable verification library.
+
 @item lto-plugin
 Plugin used by the linker if link-time optimizations are enabled.
 

Re: [PATCH] sourcebuild.texi: Document new toplevel directories [PR82383]

[Jeff Law]

On 5/24/2022 11:32 AM, Eric Gallager via Gcc-patches wrote:
> This patch adds entries for the c++tools, gotools, libbacktrace,
> libcc1, libcody, liboffloadmic, and libsanitizer directories into the
> list of toplevel source directories in sourcebuild.texi. I also
> removed the entry for boehm-gc (which is no longer in-tree), and fixed
> the alphabetization for libquadmath while I was at it. Any style nits
> I need to fix before committing (with a proper ChangeLog entry)?
I think this is fine.  If you're looking for a good cleanup, removing 
liboffloadmic  would be useful IMHO.  MIC is dead.

jeff

Re: [PATCH] sourcebuild.texi: Document new toplevel directories [PR82383]

[Eric Gallager]

On Sat, May 28, 2022 at 2:30 PM Jeff Law via Gcc-patches
<gcc-patches@gcc.gnu.org> wrote:
> On 5/24/2022 11:32 AM, Eric Gallager via Gcc-patches wrote:
> > This patch adds entries for the c++tools, gotools, libbacktrace,
> > libcc1, libcody, liboffloadmic, and libsanitizer directories into the
> > list of toplevel source directories in sourcebuild.texi. I also
> > removed the entry for boehm-gc (which is no longer in-tree), and fixed
> > the alphabetization for libquadmath while I was at it. Any style nits
> > I need to fix before committing (with a proper ChangeLog entry)?
> I think this is fine.  If you're looking for a good cleanup, removing
> liboffloadmic  would be useful IMHO.  MIC is dead.
>

OK thanks, committed as r13-817. I'll leave removing the liboffloadmic
directory for someone else to do, as it still has stuff in it.