libstdc++-v3/README

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