source: trunk/src/gcc/libstdc++-v3/docs/html/documentation.html@ 1216

Last change on this file since 1216 was 2, checked in by bird, 23 years ago

Initial revision
  • Property cvs2svn:cvs-rev set to 1.1
  • Property svn:eol-style set to native
  • Property svn:executable set to *
File size: 10.6 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE html
3 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7<head>
8 <meta name="KEYWORDS"
9 content="libstdc++, homepage, home, C++, library, c++, std, g++, ABI, STL" />
10 <title>GNU C++ Standard Library</title>
11<link rel="StyleSheet" href="lib3styles.css" />
12</head>
13<body>
14
15
16<p><strong>All of these documents</strong> (in fact, this entire homepage set)
17 are bundled with the library source, under the <code>docs</code>
18 subdirectory, for releases and snapshots. The sole exception is the
19 automatically-generated source documentation, available separately.
20</p>
21
22<hr />
23<br />
24<h2><a name="1">Introduction</a></h2>
25 <p>This is a short list of text files pertaining to this implementation of
26 ISO 14882. A brief description may follow the name of the file.
27 </p>
28 <ul>
29 <li><a href="17_intro/COPYING">License</a>
30 - GPL v2 license terms</li>
31 <li><a href="abi.txt">ABI Policy and Guidelines</a></li>
32 <li><a href="17_intro/BUGS">BUGS</a></li>
33 <li><a href="17_intro/PROBLEMS">PROBLEMS</a>
34 - target-specific known issues</li>
35 <!-- Linking to "../README" doesn't work; we are at the top level
36 of the web pages. Punt. -->
37 <li>README - directory structure</li>
38 <li><a href="17_intro/RELEASE-NOTES">RELEASE-NOTES</a>
39 - latest version info, recent changes and news</li>
40 <li><a href="17_intro/TODO">TODO</a>
41 - tasks yet undone</li>
42 <li><a href="faq/index.html">FAQ (HTML)</a>,
43 <a href="faq/index.txt">FAQ (text)</a></li>
44 </ul>
45
46<hr />
47<br />
48<h2><a name="2">Configuring, Building, Installing</a></h2>
49<ul>
50 <li><a href="configopts.html">Configure options</a></li>
51 <li><a href="install.html">Getting started: configure, build, install</a>
52 <li><a href="debug.html">Debugging schemes and strategies</a>
53 </li>
54</ul>
55
56
57<hr />
58<br />
59<h2><a name="4">Source-Level Documentation</a></h2>
60<p>The library sources have been specially formatted so that with the
61 proper invocation of another tool (Doxygen), a set of HTML pages
62 are generated from the sources files themselves. The resultant
63 documentation is referred to as Source-Level Documentation, and is
64 useful for examining the signatures of public member functions for
65 the library classes, finding out what is in a particular include
66 file, looking at inheritance diagrams, etc.
67</p>
68<p>The Source-Level documentation can be viewed online:</p>
69<ul>
70 <li><a href="libstdc++-html-USERS-3.1/index.html">for the 3.1 release</a>
71 </li>
72 <li><a href="libstdc++-html-USERS-3.2.1/index.html">for the 3.2.1 release</a>
73 </li>
74 <li><a href="latest-doxygen/index.html">&quot;the latest collection&quot;</a>
75 (for the snapshot or later; see the date on the first page)
76 </li>
77</ul>
78<p>This generated HTML collection, as above, is also available for download in
79 the libstdc++ snapshots directory at
80 <code>&lt;URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/doxygen/&gt;</code>.
81 You will almost certainly need to use one of the <a
82 href="http://gcc.gnu.org/mirrors.html">mirror sites</a> to download
83 the tarball. After unpacking, simply load
84 libstdc++-html-*/index.html into a browser. Feedback (and
85 additional documentation!) is welcome.
86</p>
87<p>
88 In addition, an initial set of man pages are also available in the
89 same place as the HTML collections. Start with Intro(3).
90</p>
91
92
93<hr />
94<br />
95<h2><a name="3">Chapter-Specific Documentation</a></h2>
96<p>Information, extensions, notes and advice on specific implementation
97 capabilites and/or liabilities broken down into chapter names based on the
98 C++ standard.
99</p>
100<!--
101 The list below is automatically generated. To make changes in the text,
102 edit the appropriate HOWTO file and run "make" in this directory. In
103 those files, you may reorder entries as you like, but DO NOT change the
104 "#number"s in anchors, for they are used elsewhere and in bookmarks.
105-->
106<!-- beginlist -->
107 <ul>
108 <li>Library Introduction (Chapter 17)
109 <ul>
110 <li><a href="17_intro/howto.html#2">The Standard C++ header files</a></li>
111 <li><a href="17_intro/howto.html#3">The Standard C++ library and multithreading</a></li>
112 <li><a href="17_intro/howto.html#4"><code>&lt;foo&gt;</code> vs <code>&lt;foo.h&gt;</code></a></li>
113 <li><a href="17_intro/porting-howto.html">Porting HOWTO</a></li>
114 <li><a href="17_intro/howto.html#5">Behavior specific to libstdc++-v3</a></li>
115 <li><a href="17_intro/howto.html#6">Preprocessor macros controlling the library</a></li>
116 </ul>
117 </li>
118
119 <li>Library Support (Chapter 18)
120 <ul>
121 <li><a href="18_support/howto.html#1">Types</a></li>
122 <li><a href="18_support/howto.html#2">Implementation properties</a></li>
123 <li><a href="18_support/howto.html#3">Start and Termination</a></li>
124 <li><a href="18_support/howto.html#4">Dynamic memory management</a></li>
125 <li><a href="18_support/howto.html#5">RTTI, the ABI, and demangling</a></li>
126 </ul>
127 </li>
128
129 <li>Diagnostics (Chapter 19)
130 <ul>
131 <li><a href="19_diagnostics/howto.html#1">Adding data to exceptions</a></li>
132 <li><a href="19_diagnostics/howto.html#2">Exception class hierarchy diagram</a></li>
133 <li><a href="19_diagnostics/howto.html#3">Concept checkers -- <strong>new and improved!</strong></a></li>
134 <li><a href="19_diagnostics/howto.html#4">Verbose <code>terminate</code></a></li>
135 </ul>
136 </li>
137
138 <li>General Utilities (Chapter 20)
139 <ul>
140 <li><a href="20_util/howto.html#1"><code>auto_ptr</code> is not omnipotent</a></li>
141 <li><a href="20_util/howto.html#2"><code>auto_ptr</code> inside container classes</a></li>
142 <li><a href="20_util/howto.html#3">Functors</a></li>
143 <li><a href="20_util/howto.html#4">Pairs</a></li>
144 </ul>
145 </li>
146
147 <li>Strings (Chapter 21)
148 <ul>
149 <li><a href="21_strings/howto.html#1">MFC's CString</a></li>
150 <li><a href="21_strings/howto.html#2">A case-insensitive string class</a></li>
151 <li><a href="21_strings/howto.html#3">Breaking a C++ string into tokens</a></li>
152 <li><a href="21_strings/howto.html#4">Simple transformations</a></li>
153 <li><a href="21_strings/howto.html#5">Making strings of arbitrary character types</a></li>
154 </ul>
155 </li>
156
157 <li>Localization (Chapter 22)
158 <ul>
159 <li><a href="22_locale/howto.html#1">class locale</a></li>
160 <li><a href="22_locale/howto.html#2">class codecvt</a></li>
161 <li><a href="22_locale/howto.html#3">class ctype</a></li>
162 <li><a href="22_locale/howto.html#4">class messages</a></li>
163 <li><a href="22_locale/howto.html#5">Bjarne Stroustrup on Locales</a></li>
164 <li><a href="22_locale/howto.html#6">Nathan Myers on Locales</a></li>
165 <li><a href="22_locale/howto.html#7">Correct Transformations</a></li>
166 </ul>
167 </li>
168
169 <li>Containers (Chapter 23)
170 <ul>
171 <li><a href="23_containers/howto.html#1">Making code unaware of the container/array difference</a></li>
172 <li><a href="23_containers/howto.html#2">Variable-sized bitmasks</a></li>
173 <li><a href="23_containers/howto.html#3">Containers and multithreading</a></li>
174 <li><a href="23_containers/howto.html#4">&quot;Hinting&quot; during insertion</a></li>
175 <li><a href="23_containers/howto.html#5">Bitmasks and string arguments</a></li>
176 <li><a href="23_containers/howto.html#6"><code>std::list::size()</code> is O(n)!</a></li>
177 <li><a href="23_containers/howto.html#7">Space overhead management for vectors</a></li>
178 </ul>
179 </li>
180
181 <li>Iterators (Chapter 24)
182 <ul>
183 <li><a href="24_iterators/howto.html#1">They ain't pointers!</a></li>
184 <li><a href="24_iterators/howto.html#2">It ends <em>where?</em></a></li>
185 </ul>
186 </li>
187
188 <li>Algorithms (Chapter 25)
189 <ul>
190 <li><a href="25_algorithms/howto.html#1">Prerequisites</a></li>
191 <li><a href="25_algorithms/howto.html#2">Special <code>swap</code>s</a></li>
192 </ul>
193 </li>
194
195 <li>Numerics (Chapter 26)
196 <ul>
197 <li><a href="26_numerics/howto.html#1">Complex Number Processing</a></li>
198 <li><a href="26_numerics/howto.html#2">Array Processing</a></li>
199 <li><a href="26_numerics/howto.html#3">Numerical Functions</a></li>
200 <li><a href="26_numerics/howto.html#4">C99</a></li>
201 </ul>
202 </li>
203
204 <li>Input/Output (Chapter 27)
205 <ul>
206 <li><a href="27_io/howto.html#1">Copying a file</a></li>
207 <li><a href="27_io/howto.html#2">The buffering is screwing up my program!</a></li>
208 <li><a href="27_io/howto.html#3">Binary I/O</a></li>
209 <li><a href="27_io/howto.html#5">What is this &lt;sstream&gt;/stringstreams thing?</a></li>
210 <li><a href="27_io/howto.html#6">Deriving a stream buffer</a></li>
211 <li><a href="27_io/howto.html#7">More on binary I/O</a></li>
212 <li><a href="27_io/howto.html#8">Pathetic performance? Ditch C.</a></li>
213 <li><a href="27_io/howto.html#9">Threads and I/O</a></li>
214 <li><a href="27_io/howto.html#10">Which header?</a></li>
215 </ul>
216 </li>
217
218 <li>Extensions to the Standard Library
219 <ul>
220 <li><a href="ext/howto.html#1">Ropes and trees and hashes, oh my!</a></li>
221 <li><a href="ext/howto.html#2">Added members and types</a></li>
222 <li><a href="ext/howto.html#3">Allocators (versions 3.0, 3.1, 3.2)</a></li>
223 <li><a href="ext/howto.html#6">Allocators (version 3.3)</a></li>
224 <li><a href="ext/howto.html#4">Compile-time checks</a></li>
225 <li><a href="ext/howto.html#5">LWG Issues</a></li>
226 </ul>
227 </li>
228
229 </ul>
230<!-- endlist -->
231
232<hr />
233<br />
234<h2><a name="5">Contributor-Specific Information</a></h2>
235<ul>
236 <li><a href="17_intro/contribute.html">Contributor checklist</a></li>
237 <li><a href="17_intro/libstdc++-assign.txt">Copyright assignment form for libstdc++-v3</a></li>
238 <li><a href="17_intro/BADNAMES">BADNAMES</a>
239 - names to avoid because of potential collisions</li>
240 <li><a href="17_intro/C++STYLE">C++STYLE</a>
241 - coding style by example</li>
242 <li><a href="17_intro/CHECKLIST">CHECKLIST</a>
243 - a list of required features and their status.</li>
244 <li><a href="17_intro/DESIGN">DESIGN</a>
245 - overview of the implementation plan</li>
246 <li><a href="17_intro/HEADER_POLICY">HEADER_POLICY</a>
247 - header naming and sub-include structure</li>
248</ul>
249
250<!-- ####################################################### -->
251
252<p>Return <a href="http://gcc.gnu.org/libstdc++/">to the libstdc++ homepage</a>.</p>
253
254<hr />
255<p class="fineprint"><em>
256See <a href="17_intro/license.html">license.html</a> for copying conditions.
257Comments and suggestions are welcome, and may be sent to
258<a href="mailto:[email protected]">the libstdc++ mailing list</a>.
259</em></p>
260
261</body>
262</html>
Note: See TracBrowser for help on using the repository browser.