All of these documents
(in fact, this entire homepage set)
are bundled with the library source, under the
docs
subdirectory, for releases and snapshots.  The sole exception is the
automatically-generated source documentation, available separately.
Introduction
This is a short list of text files pertaining to this implementation of
ISO 14882.  A brief description may follow the name of the file.
17_intro/COPYING
License
- GPL v2 license terms
abi.html
ABI Policy and Guidelines
17_intro/BUGS
BUGS
17_intro/PROBLEMS
PROBLEMS
- target-specific known issues
README - directory structure
17_intro/RELEASE-NOTES
RELEASE-NOTES
- latest version info, recent changes and news
17_intro/TODO
TODO
- tasks yet undone
faq/index.html
FAQ (HTML)
,
faq/index.txt
FAQ (text)
Configuring, Building, Testing, Installing
configopts.html
Configure options
install.html
Getting started: configure, build, install
test.html
Testing details
debug.html
Debugging schemes and strategies
Source-Level Documentation
The library sources have been specially formatted so that with the
proper invocation of another tool (Doxygen), a set of HTML pages
are generated from the sources files themselves.  The resultant
documentation is referred to as Source-Level Documentation, and is
useful for examining the signatures of public member functions for
the library classes, finding out what is in a particular include
file, looking at inheritance diagrams, etc.
The source-level documentation for the most recent releases can
be viewed online:
libstdc++-html-USERS-3.4/index.html
for the 3.4 release
latest-doxygen/index.html
"the latest collection"
(for the main development tree; see the date on the first page)
This generated HTML collection, as above, is also available for download in
the libstdc++ snapshots directory at
<URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/doxygen/>
.
You will almost certainly need to use one of the
http://gcc.gnu.org/mirrors.html
mirror sites
to download
the tarball.  After unpacking, simply load libstdc++-html-*/index.html
into a browser.
Documentation for older releases is available for download only, not
online viewing.
In addition, an initial set of man pages are also available in the
same place as the HTML collections.  Start with C++Intro(3).
Chapter-Specific Documentation
Information, extensions, notes and advice on specific implementation
capabilites and/or liabilities broken down into chapter names based on the
C++ standard.
Library Introduction (Chapter 17)
17_intro/howto.html#2
The Standard C++ header files
17_intro/howto.html#3
The Standard C++ library and multithreading
17_intro/howto.html#4
<foo>
vs
<foo.h>
17_intro/porting-howto.html
Porting HOWTO
17_intro/howto.html#5
Behavior specific to libstdc++-v3
17_intro/howto.html#6
Preprocessor macros controlling the library
Library Support (Chapter 18)
18_support/howto.html#1
Types
18_support/howto.html#2
Implementation properties
18_support/howto.html#3
Start and Termination
18_support/howto.html#4
Verbose
terminate
18_support/howto.html#5
Dynamic memory management
18_support/howto.html#6
RTTI, the ABI, and demangling
Diagnostics (Chapter 19)
19_diagnostics/howto.html#1
Adding data to exceptions
19_diagnostics/howto.html#2
Exception class hierarchy diagram
19_diagnostics/howto.html#3
Concept checkers --
new and improved!
General Utilities (Chapter 20)
20_util/howto.html#1
auto_ptr
is not omnipotent
20_util/howto.html#2
auto_ptr
inside container classes
20_util/howto.html#3
Functors
20_util/howto.html#4
Pairs
20_util/howto.html#5
Memory allocators
Strings (Chapter 21)
21_strings/howto.html#1
MFC's CString
21_strings/howto.html#2
A case-insensitive string class
21_strings/howto.html#3
Breaking a C++ string into tokens
21_strings/howto.html#4
Simple transformations
21_strings/howto.html#5
Making strings of arbitrary character types
21_strings/howto.html#6
Shrink-to-fit strings
Localization (Chapter 22)
22_locale/howto.html#1
class locale
22_locale/howto.html#2
class codecvt
22_locale/howto.html#3
class ctype
22_locale/howto.html#4
class messages
22_locale/howto.html#5
Bjarne Stroustrup on Locales
22_locale/howto.html#6
Nathan Myers on Locales
22_locale/howto.html#7
Correct Transformations
Containers (Chapter 23)
23_containers/howto.html#1
Making code unaware of the container/array difference
23_containers/howto.html#2
Variable-sized bitmasks
23_containers/howto.html#3
Containers and multithreading
23_containers/howto.html#4
"Hinting" during insertion
23_containers/howto.html#5
Bitmasks and string arguments
23_containers/howto.html#6
std::list::size()
is O(n)!
23_containers/howto.html#7
Space overhead management for vectors
Iterators (Chapter 24)
24_iterators/howto.html#1
They ain't pointers!
24_iterators/howto.html#2
It ends
where?
Algorithms (Chapter 25)
25_algorithms/howto.html#1
Prerequisites
25_algorithms/howto.html#2
Special
swap
s
Numerics (Chapter 26)
26_numerics/howto.html#1
Complex Number Processing
26_numerics/howto.html#2
Array Processing
26_numerics/howto.html#3
Numerical Functions
26_numerics/howto.html#4
C99
Input/Output (Chapter 27)
27_io/howto.html#1
Copying a file
27_io/howto.html#2
The buffering is screwing up my program!
27_io/howto.html#3
Binary I/O
27_io/howto.html#5
What is this <sstream>/stringstreams thing?
27_io/howto.html#6
Deriving a stream buffer
27_io/howto.html#7
More on binary I/O
27_io/howto.html#8
Pathetic performance?  Ditch C.
27_io/howto.html#9
Threads and I/O
27_io/howto.html#10
Which header?
27_io/howto.html#11
Using FILE*s and file descriptors with IOStreams
Extensions to the Standard Library
ext/howto.html#1
Ropes and trees and hashes, oh my!
ext/howto.html#2
Added members and types
ext/mt_allocator.html
__mt_alloc
ext/howto.html#4
Compile-time checks
ext/howto.html#5
LWG Issues
ext/../18_support/howto.html#6
Demangling
Contributor-Specific Information
17_intro/contribute.html
Contributor checklist
http://gcc.gnu.org/cvswrite.html
Getting CVS write access
(look for "Write after approval")
17_intro/BADNAMES
BADNAMES
- names to avoid because of potential collisions
17_intro/C++STYLE
C++STYLE
- coding style by example
In the libstdc++-v3/docs/doxygen directory, see guide.html, a
doxygen markup style guide
17_intro/CHECKLIST
CHECKLIST
- a list of required features and their status.
17_intro/DESIGN
DESIGN
- overview of the implementation plan
17_intro/HEADER_POLICY
HEADER_POLICY
- header naming and sub-include structure
Return
http://gcc.gnu.org/libstdc++/
to the libstdc++ homepage
.
See
17_intro/license.html
license.html
for copying conditions.
Comments and suggestions are welcome, and may be sent to
mailto:libstdc++@gcc.gnu.org
the libstdc++ mailing list
.
