README
1file: libstdc++-v3/README
2
3New users may wish to point their web browsers to the file
4documentation.html in the 'docs/html' subdirectory. It contains brief
5building instructions and notes on how to configure the library in
6interesting ways.
7
8Instructions for configuring and building appear in
9docs/html/install.html.
10
11This directory contains the files needed to create an ISO Standard C++
12Library.
13
14It has subdirectories:
15
16 docs
17 Files in HTML and text format that document usage, quirks of the
18 implementation, and contributor checklists.
19
20 include
21 All header files for the C++ library are within this directory,
22 modulo specific runtime-related files that are in the libsupc++
23 directory.
24
25 include/std
26 Files meant to be found by #include <name> directives in
27 standard-conforming user programs.
28
29 include/c
30 Headers intended to directly include standard C headers.
31 [NB: this can be enabled via --enable-cheaders=c]
32
33 include/c_std
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]
37
38 include/bits
39 Files included by standard headers and by other files in
40 the bits directory.
41
42 include/backward
43 Headers provided for backward compatibility, such as <iostream.h>.
44 They are not used in this library.
45
46 include/ext
47 Headers that define extensions to the standard library. No
48 standard header refers to any of them.
49
50 scripts
51 Scripts that are used during the configure, build, make, or test
52 process.
53
54 src
55 Files that are used in constructing the library, but are not
56 installed.
57
58 testsuites/[backward, demangle, ext, performance, thread, 17_* to 27_*]
59 Test programs are here, and may be used to begin to exercise the
60 library. Support for "make check" and "make check-install" is
61 complete, and runs through all the subdirectories here when this
62 command is issued from the build directory. Please note that
63 "make check" requires DejaGNU 1.4 or later to be installed. Please
64 note that "make check-script" calls the script mkcheck, which
65 requires bash, and which may need the paths to bash adjusted to
66 work properly, as /bin/bash is assumed.
67
68Other subdirectories contain variant versions of certain files
69that are meant to be copied or linked by the configure script.
70Currently these are:
71
72 config/abi
73 config/cpu
74 config/io
75 config/locale
76 config/os
77
78In addition, two subdirectories are convenience libraries:
79
80 libmath
81 Support routines needed for C++ math. Only needed if the
82 underlying "C" implementation is non-existent, in particular
83 required or optimal long double, long long, and C99 functionality.
84
85 libsupc++
86 Contains the runtime library for C++, including exception
87 handling and memory allocation and deallocation, RTTI, terminate
88 handlers, etc.
89
90Note that glibc also has a bits/ subdirectory. We will either
91need to be careful not to collide with names in its bits/
92directory; or rename bits to (e.g.) cppbits/.
93
94In files throughout the system, lines marked with an "XXX" indicate
95a bug or incompletely-implemented feature. Lines marked "XXX MT"
96indicate a place that may require attention for multi-thread safety.
97