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
   8 Instructions for configuring and building this snapshot appear
   9 in docs/html/install.html.
  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
  16   docs
  17      Files in HTML and text format that document usage, quirks of the
  18      implementation, and contributor checklists.
  19
  20   include/bits
  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
  25   include/std
  26      Files meant to be found by #include <name> directives in
  27      standard-conforming user programs.  These headers are not
  28      referred to by other headers, because such dependencies
  29      confuse Make (leading it to delete them, all too often).
  30      Installations may substitute symbolic links in place of
  31      these files.
  32
  33   include/ext
  34      Headers that define extensions to the standard library.  No
  35      standard header refers to any of them.
  36
  37   include/backward
  38      Headers provided for backward compatibility, such as <iostream.h>.
  39      They are not used in this library.
  40
  41   src
  42      Files that are used in constructing the library, but are not
  43      installed.
  44
  45   testsuites/17_* to 27_*
  46      Test programs are here, and may be used to begin to exercise the
  47      library.  Support for "make check" and "make check-install" is
  48      complete, and runs through all the subdirectories here when this
  49      command is issued from the build directory. Please note that
  50      "make check" calls the script mkcheck, which requires bash, and which
  51      may need the paths to bash adjusted to work properly, as /bin/bash is
  52      assumed.
  53
  54   shadow
  55      Headers intended to shadow standard C headers provided by an
  56      underlying OS or C library, and other headers depended on directly
  57      by C++ headers (e.g. unistd.h).  These are meant to wrap the names
  58      defined there into the _C_legacy namespace.
  59      [NB: this can be enabled via --enable-cshadow-headers.]
  60
  61   cshadow
  62      The contents of this directory are constructed by scripts which
  63      examine the underlying C headers to discover other headers they
  64      depend on.  These headers are wrappers for them.
  65      [NB: this is still experimental, and is not currently used.]
  66
  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
  71   config/cpu
  72   config/os
  73
  74 Files needed only to construct the library, but not installed,
  75 are in src/.  Files to be copied as part of an installation are
  76 all found in the subdirectories mentioned above.  (A configure
  77 script may link files from another directory into one of these.)
  78
  79 In a normal installation the bits/ directory is copied
  80 under the std/ directory, and arranged to be searched only
  81 when an include directive specifies a filename of "bits/..."
  82 or <bits/...>.  When building the library, we use
  83
  84   -I. -Iinclude/std -Iinclude -Iconfig/os/* -Iconfig/cpu/*
  85
  86 to get the same effect.
  87
  88 Note that glibc also has a bits/ subdirectory.  We will either
  89 need to be careful not to collide with names in its bits/
  90 directory; or rename bits to (e.g.) cppbits/.
  91
  92 To install libstdc++ you need GNU make.  The makefiles do not work with
  93 any other make.
  94
  95 In files throughout the system, lines marked with an "XXX" indicate
  96 a bug or incompletely-implemented feature.  Lines marked "XXX MT"
  97 indicate a place that may require attention for multi-thread safety.
  98