]>
Commit | Line | Data |
---|---|---|
89e37ad7 | 1 | file: libstdc++-v3/README |
b2dad0e3 | 2 | |
bfcafa4f PE |
3 | New users may wish to point their web browsers to the file documentation.html |
4 | in the 'docs/html' subdirectory. It contains brief building instructions and | |
5 | notes on how to configure the library in interesting ways. | |
b2dad0e3 BK |
6 | |
7 | ||
8 | Instructions for configuring and building this snapshot appear | |
bfcafa4f | 9 | in docs/html/install.html. |
b2dad0e3 BK |
10 | |
11 | This directory contains the files needed to create [a still broken | |
12 | subset of] an ISO Standard C++ Library. | |
13 | ||
14 | It has subdirectories: | |
15 | ||
89e37ad7 BK |
16 | docs |
17 | Files in HTML and text format that document usage, quirks of the | |
18 | implementation, and contributor checklists. | |
19 | ||
20 | include/bits | |
b2dad0e3 BK |
21 | Files included by standard headers and by other files in |
22 | the bits directory. Includes a set of files bits/std_xxxx.h | |
23 | that implement the standard headers <xxxx>. | |
24 | ||
89e37ad7 | 25 | include/std |
b2dad0e3 | 26 | Files meant to be found by #include <name> directives in |
69bcf124 | 27 | standard-conforming user programs. |
b2dad0e3 | 28 | |
89e37ad7 | 29 | include/ext |
b2dad0e3 BK |
30 | Headers that define extensions to the standard library. No |
31 | standard header refers to any of them. | |
32 | ||
89e37ad7 | 33 | include/backward |
b2dad0e3 BK |
34 | Headers provided for backward compatibility, such as <iostream.h>. |
35 | They are not used in this library. | |
36 | ||
8d66b99a BK |
37 | include/c |
38 | Headers intended to directly include standard C headers. | |
39 | [NB: this can be enabled via --enable-cheaders=c] | |
40 | ||
41 | include/c_std | |
42 | Headers intended to include standard C headers, and put select | |
43 | names into the std:: namespace. | |
44 | [NB: this is the default, and is the same as --enable-cheaders=c_std] | |
45 | ||
69bcf124 BK |
46 | include/c_shadow |
47 | Headers intended to shadow standard C headers provided by an | |
48 | underlying OS or C library, and other headers depended on directly | |
49 | by C++ headers (e.g. unistd.h). These are meant to wrap the names | |
50 | defined there into the _C_legacy namespace. | |
51 | [NB: this can be enabled via --enable-cheaders=c_shadow] | |
52 | ||
b2dad0e3 BK |
53 | src |
54 | Files that are used in constructing the library, but are not | |
55 | installed. | |
56 | ||
57 | testsuites/17_* to 27_* | |
58 | Test programs are here, and may be used to begin to exercise the | |
59 | library. Support for "make check" and "make check-install" is | |
60 | complete, and runs through all the subdirectories here when this | |
52b55e7d PE |
61 | command is issued from the build directory. Please note that |
62 | "make check" requires DejaGNU 1.4 or later to be installed. Please | |
63 | note that "make check-script" calls the script mkcheck, which | |
64 | requires bash, and which may need the paths to bash adjusted to | |
65 | work properly, as /bin/bash is assumed. | |
b2dad0e3 | 66 | |
b2dad0e3 BK |
67 | Other subdirectories contain variant versions of certain files |
68 | that are meant to be copied or linked by the configure script. | |
69 | Currently these are: | |
70 | ||
89e37ad7 BK |
71 | config/cpu |
72 | config/os | |
69bcf124 BK |
73 | config/io |
74 | config/locale | |
b2dad0e3 BK |
75 | |
76 | Files needed only to construct the library, but not installed, | |
77 | are in src/. Files to be copied as part of an installation are | |
78 | all found in the subdirectories mentioned above. (A configure | |
79 | script may link files from another directory into one of these.) | |
80 | ||
b2dad0e3 BK |
81 | Note that glibc also has a bits/ subdirectory. We will either |
82 | need to be careful not to collide with names in its bits/ | |
83 | directory; or rename bits to (e.g.) cppbits/. | |
84 | ||
b2dad0e3 BK |
85 | In files throughout the system, lines marked with an "XXX" indicate |
86 | a bug or incompletely-implemented feature. Lines marked "XXX MT" | |
87 | indicate a place that may require attention for multi-thread safety. |