197403Sobrienfile: libstdc++-v3/README
297403Sobrien
397403SobrienNew users may wish to point their web browsers to the file
497403Sobriendocumentation.html in the 'docs/html' subdirectory.  It contains brief
597403Sobrienbuilding instructions and notes on how to configure the library in
697403Sobrieninteresting ways.
797403Sobrien
897403SobrienInstructions for configuring and building appear in
997403Sobriendocs/html/install.html.
1097403Sobrien
1197403SobrienThis directory contains the files needed to create an ISO Standard C++
1297403SobrienLibrary.
1397403Sobrien
1497403SobrienIt has subdirectories:
1597403Sobrien
1697403Sobrien  docs
1797403Sobrien    Files in HTML and text format that document usage, quirks of the
1897403Sobrien    implementation, and contributor checklists.
1997403Sobrien
2097403Sobrien  include
2197403Sobrien    All header files for the C++ library are within this directory,
2297403Sobrien    modulo specific runtime-related files that are in the libsupc++
2397403Sobrien    directory.
2497403Sobrien
2597403Sobrien    include/std
2697403Sobrien      Files meant to be found by #include <name> directives in
2797403Sobrien      standard-conforming user programs.  
2897403Sobrien
2997403Sobrien    include/c
3097403Sobrien      Headers intended to directly include standard C headers. 
3197403Sobrien      [NB: this can be enabled via --enable-cheaders=c]
3297403Sobrien
3397403Sobrien    include/c_std
3497403Sobrien      Headers intended to include standard C headers, and put select
3597403Sobrien      names into the std:: namespace.
3697403Sobrien      [NB: this is the default, and is the same as --enable-cheaders=c_std]
3797403Sobrien
3897403Sobrien    include/bits
3997403Sobrien      Files included by standard headers and by other files in
4097403Sobrien      the bits directory. 
4197403Sobrien
4297403Sobrien    include/backward
4397403Sobrien      Headers provided for backward compatibility, such as <iostream.h>.
4497403Sobrien      They are not used in this library.
4597403Sobrien
4697403Sobrien    include/ext
4797403Sobrien      Headers that define extensions to the standard library.  No
4897403Sobrien      standard header refers to any of them.
4997403Sobrien
50132720Skan  scripts
51132720Skan    Scripts that are used during the configure, build, make, or test
52132720Skan    process.
53132720Skan
5497403Sobrien  src
5597403Sobrien    Files that are used in constructing the library, but are not
5697403Sobrien    installed.
5797403Sobrien
58132720Skan  testsuites/[backward, demangle, ext, performance, thread, 17_* to 27_*]
5997403Sobrien    Test programs are here, and may be used to begin to exercise the 
6097403Sobrien    library.  Support for "make check" and "make check-install" is
6197403Sobrien    complete, and runs through all the subdirectories here when this
6297403Sobrien    command is issued from the build directory.  Please note that
6397403Sobrien    "make check" requires DejaGNU 1.4 or later to be installed.  Please
6497403Sobrien    note that "make check-script" calls the script mkcheck, which
6597403Sobrien    requires bash, and which may need the paths to bash adjusted to
6697403Sobrien    work properly, as /bin/bash is assumed.
6797403Sobrien
6897403SobrienOther subdirectories contain variant versions of certain files
6997403Sobrienthat are meant to be copied or linked by the configure script.
7097403SobrienCurrently these are:
7197403Sobrien
72132720Skan  config/abi
7397403Sobrien  config/cpu
7497403Sobrien  config/io
7597403Sobrien  config/locale
76132720Skan  config/os
7797403Sobrien
78132720SkanIn addition, two subdirectories are convenience libraries:
7997403Sobrien
8097403Sobrien  libmath
8197403Sobrien    Support routines needed for C++ math. Only needed if the
8297403Sobrien    underlying "C" implementation is non-existent, in particular
8397403Sobrien    required or optimal long double, long long, and C99 functionality.
8497403Sobrien
8597403Sobrien  libsupc++
8697403Sobrien    Contains the runtime library for C++, including exception
8797403Sobrien    handling and memory allocation and deallocation, RTTI, terminate
8897403Sobrien    handlers, etc.
8997403Sobrien
9097403SobrienNote that glibc also has a bits/ subdirectory.  We will either
9197403Sobrienneed to be careful not to collide with names in its bits/
9297403Sobriendirectory; or rename bits to (e.g.) cppbits/.
9397403Sobrien
9497403SobrienIn files throughout the system, lines marked with an "XXX" indicate
9597403Sobriena bug or incompletely-implemented feature.  Lines marked "XXX MT"
9697403Sobrienindicate a place that may require attention for multi-thread safety.
97