1 file: libstdc++-v3/README
3 New users may wish to point their web browsers to the file
4 documentation.html in the 'docs/html' subdirectory. It contains brief
5 building instructions and notes on how to configure the library in
8 Instructions for configuring and building appear in
9 docs/html/install.html.
11 This directory contains the files needed to create an ISO Standard C++
14 It has subdirectories:
17 Files in HTML and text format that document usage, quirks of the
18 implementation, and contributor checklists.
21 All header files for the C++ library are within this directory,
22 modulo specific runtime-related files that are in the libsupc++
26 Files meant to be found by #include <name> directives in
27 standard-conforming user programs.
30 Headers intended to directly include standard C headers.
31 [NB: this can be enabled via --enable-cheaders=c]
34 Headers intended to include standard C headers, and put select
35 names into the std:: namespace.
36 [NB: this is the default, and is the same as --enable-cheaders=c_std]
39 Headers intended to shadow standard C headers provided by an
40 underlying OS or C library, and other headers depended on directly
41 by C++ headers (e.g. unistd.h). These are meant to wrap the names
42 defined there into the _C_legacy namespace.
43 [NB: this can be enabled via --enable-cheaders=c_shadow]
46 Files included by standard headers and by other files in
50 Headers provided for backward compatibility, such as <iostream.h>.
51 They are not used in this library.
54 Headers that define extensions to the standard library. No
55 standard header refers to any of them.
58 Scripts that are used during the configure, build, make, or test
62 Files that are used in constructing the library, but are not
65 testsuites/[backward, demangle, ext, performance, thread, 17_* to 27_*]
66 Test programs are here, and may be used to begin to exercise the
67 library. Support for "make check" and "make check-install" is
68 complete, and runs through all the subdirectories here when this
69 command is issued from the build directory. Please note that
70 "make check" requires DejaGNU 1.4 or later to be installed. Please
71 note that "make check-script" calls the script mkcheck, which
72 requires bash, and which may need the paths to bash adjusted to
73 work properly, as /bin/bash is assumed.
75 Other subdirectories contain variant versions of certain files
76 that are meant to be copied or linked by the configure script.
85 In addition, two subdirectories are convenience libraries:
88 Support routines needed for C++ math. Only needed if the
89 underlying "C" implementation is non-existent, in particular
90 required or optimal long double, long long, and C99 functionality.
93 Contains the runtime library for C++, including exception
94 handling and memory allocation and deallocation, RTTI, terminate
97 Note that glibc also has a bits/ subdirectory. We will either
98 need to be careful not to collide with names in its bits/
99 directory; or rename bits to (e.g.) cppbits/.
101 In files throughout the system, lines marked with an "XXX" indicate
102 a bug or incompletely-implemented feature. Lines marked "XXX MT"
103 indicate a place that may require attention for multi-thread safety.