X-Git-Url: http://git.sourceforge.jp/view?a=blobdiff_plain;f=libstdc%2B%2B-v3%2FREADME;h=6844909a1cffd0cf5bc08fb1af5aba4a0f0b91fc;hb=b83393097dcb4f04744bb1b8f360f0e49f2abd4d;hp=eb2ce9b082fb100eab079fc8c246fb7d9f428b4b;hpb=86799b469a18563fb20d813da222f1b608f4eab2;p=pf3gnuchains%2Fgcc-fork.git diff --git a/libstdc++-v3/README b/libstdc++-v3/README index eb2ce9b082f..6844909a1cf 100644 --- a/libstdc++-v3/README +++ b/libstdc++-v3/README @@ -1,99 +1,103 @@ file: libstdc++-v3/README -New users may wish to point their web browsers to the file index.html -in the 'docs' subdirectory. It contains brief building instructions -and notes on how to configure the library in interesting ways. +New users may wish to point their web browsers to the file +documentation.html in the 'docs/html' subdirectory. It contains brief +building instructions and notes on how to configure the library in +interesting ways. +Instructions for configuring and building appear in +docs/html/install.html. -Instructions for configuring and building this snapshot appear -in install.html. - -This directory contains the files needed to create [a still broken -subset of] an ISO Standard C++ Library. +This directory contains the files needed to create an ISO Standard C++ +Library. It has subdirectories: docs - Files in HTML and text format that document usage, quirks of the - implementation, and contributor checklists. - - include/bits - Files included by standard headers and by other files in - the bits directory. Includes a set of files bits/std_xxxx.h - that implement the standard headers . - - include/std - Files meant to be found by #include directives in - standard-conforming user programs. These headers are not - referred to by other headers, because such dependencies - confuse Make (leading it to delete them, all too often). - Installations may substitute symbolic links in place of - these files. - - include/ext - Headers that define extensions to the standard library. No - standard header refers to any of them. - - include/backward - Headers provided for backward compatibility, such as . - They are not used in this library. + Files in HTML and text format that document usage, quirks of the + implementation, and contributor checklists. + + include + All header files for the C++ library are within this directory, + modulo specific runtime-related files that are in the libsupc++ + directory. + + include/std + Files meant to be found by #include directives in + standard-conforming user programs. + + include/c + Headers intended to directly include standard C headers. + [NB: this can be enabled via --enable-cheaders=c] + + include/c_std + Headers intended to include standard C headers, and put select + names into the std:: namespace. + [NB: this is the default, and is the same as --enable-cheaders=c_std] + + include/c_shadow + Headers intended to shadow standard C headers provided by an + underlying OS or C library, and other headers depended on directly + by C++ headers (e.g. unistd.h). These are meant to wrap the names + defined there into the _C_legacy namespace. + [NB: this can be enabled via --enable-cheaders=c_shadow] + + include/bits + Files included by standard headers and by other files in + the bits directory. + + include/backward + Headers provided for backward compatibility, such as . + They are not used in this library. + + include/ext + Headers that define extensions to the standard library. No + standard header refers to any of them. + + scripts + Scripts that are used during the configure, build, make, or test + process. src - Files that are used in constructing the library, but are not - installed. - - testsuites/17_* to 27_* - Test programs are here, and may be used to begin to exercise the - library. Support for "make check" and "make check-install" is - complete, and runs through all the subdirectories here when this - command is issued from the build directory. Please note that - "make check" calls the script mkcheck, which requires bash, and which - may need the paths to bash adjusted to work properly, as /bin/bash is - assumed. - - shadow - Headers intended to shadow standard C headers provided by an - underlying OS or C library, and other headers depended on directly - by C++ headers (e.g. unistd.h). These are meant to wrap the names - defined there into the _C_legacy namespace. - [NB: this can be enabled via --enable-cshadow-headers.] - - cshadow - The contents of this directory are constructed by scripts which - examine the underlying C headers to discover other headers they - depend on. These headers are wrappers for them. - [NB: this is still experimental, and is not currently used.] + Files that are used in constructing the library, but are not + installed. + + testsuites/[backward, demangle, ext, performance, thread, 17_* to 27_*] + Test programs are here, and may be used to begin to exercise the + library. Support for "make check" and "make check-install" is + complete, and runs through all the subdirectories here when this + command is issued from the build directory. Please note that + "make check" requires DejaGNU 1.4 or later to be installed. Please + note that "make check-script" calls the script mkcheck, which + requires bash, and which may need the paths to bash adjusted to + work properly, as /bin/bash is assumed. Other subdirectories contain variant versions of certain files that are meant to be copied or linked by the configure script. Currently these are: - math + config/abi config/cpu + config/io + config/locale config/os -Files needed only to construct the library, but not installed, -are in src/. Files to be copied as part of an installation are -all found in the subdirectories mentioned above. (A configure -script may link files from another directory into one of these.) - -In a normal installation the bits/ directory is copied -under the std/ directory, and arranged to be searched only -when an include directive specifies a filename of "bits/..." -or . When building the library, we use +In addition, two subdirectories are convenience libraries: - -I. -Iinclude/std -Iinclude -Iconfig/os/* -Iconfig/cpu/* + libmath + Support routines needed for C++ math. Only needed if the + underlying "C" implementation is non-existent, in particular + required or optimal long double, long long, and C99 functionality. -to get the same effect. + libsupc++ + Contains the runtime library for C++, including exception + handling and memory allocation and deallocation, RTTI, terminate + handlers, etc. Note that glibc also has a bits/ subdirectory. We will either need to be careful not to collide with names in its bits/ directory; or rename bits to (e.g.) cppbits/. -To install libstdc++ you need GNU make. The makefiles do not work with -any other make. - In files throughout the system, lines marked with an "XXX" indicate a bug or incompletely-implemented feature. Lines marked "XXX MT" indicate a place that may require attention for multi-thread safety. -