Skip to content

R
riscv-gcc-1
Commit 00181da3 by Phil Edwards
Options

documentation.html: Update for 3.0.96. 

2002-02-01  Phil Edwards  <pme@gcc.gnu.org>

	* docs/html/documentation.html:  Update for 3.0.96.
	* docs/html/faq/index.html:  Update for 3.0.96.
	* docs/html/faq/index.txt:  Regenerated.
	* docs/doxygen/TODO:  Update notes.
	* docs/html/17_intro/howto.html:  Initial impl-specific listing.

From-SVN: r49422
parent b24d861d
Showing with 120 additions and 24 deletions
libstdc++-v3/ChangeLog
2002-02-01 Phil Edwards <pme@gcc.gnu.org>
* docs/html/documentation.html: Update for 3.0.96.
* docs/html/faq/index.html: Update for 3.0.96.
* docs/html/faq/index.txt: Regenerated.
* docs/doxygen/TODO: Update notes.
* docs/html/17_intro/howto.html: Initial impl-specific listing.
2002-01-31 Benjamin Kosnik <bkoz@redhat.com> 2002-01-31 Benjamin Kosnik <bkoz@redhat.com>
* config/locale/codecvt_specializations_ieee_1003.1-200x.h: * config/locale/codecvt_specializations_ieee_1003.1-200x.h:
......
libstdc++-v3/docs/doxygen/TODO
...@@ -23,18 +23,19 @@ c25 stl_algo.h (lots of stuff) ...@@ -23,18 +23,19 @@ c25 stl_algo.h (lots of stuff)
c26 <complex>, <valarray>, stl_numeric.h[26.4], Note A c26 <complex>, <valarray>, stl_numeric.h[26.4], Note A
c27 Untouched c27 Untouched
backward/ Not scanned by doxygen. Should it be? backward/* Not scanned by doxygen. Should it be? Doubtful.
ext/ Some of the SGI algorithm/functional extensions. ext/* Some of the SGI algorithm/functional extensions.
All of rope/hashing/slist need docs. All of rope/hashing/slist need docs.
__gnu_cxx Tricky. __gnu_cxx Tricky. Right now ext/* are in this namespace.
[1.3.5] "implementation-defined behavior: behavior ... that depends [1.3.5] "implementation-defined behavior: behavior ... that depends
on the implementation *and that each implementation shall on the implementation *and that each implementation shall
document*." [my emphasis] Not all implementation choices document*." [my emphasis] Not all implementation choices
have been thus described; doxygen is not necessarily the have been thus described; doxygen is not necessarily the
appropriate place for such descriptions, either. appropriate place for such descriptions, either. I suggest
adding this list to the Chapter 17 HOWTO.
----------------------------------------------------------- -----------------------------------------------------------
...@@ -46,8 +47,11 @@ do not have the C code (to which the doxygen comments would be attached), ...@@ -46,8 +47,11 @@ do not have the C code (to which the doxygen comments would be attached),
this would need to be done in entirely separate files, a la doxygroups.cc. this would need to be done in entirely separate files, a la doxygroups.cc.
B) Huge chunks of containers and strings are described in common "Tables" B) Huge chunks of containers and strings are described in common "Tables"
in the standard. How to reproduce this information? in the standard. How to reproduce this information? I suspect we should
simply write some HTML tables (say, one <table> per Table per file), and
use doxygen hooks like @pre and @see to reference the tables. Then the
individual classes would do like the standard does, and only document
members for which additional info is available.
STYLE: STYLE:
......
libstdc++-v3/docs/html/17_intro/howto.html
...@@ -28,6 +28,7 @@ ...@@ -28,6 +28,7 @@
<li><a href="#3">The Standard C++ library and multithreading</a> <li><a href="#3">The Standard C++ library and multithreading</a>
<li><a href="#4"><code>&lt;foo&gt;</code> vs <code>&lt;foo.h&gt;</code></a> <li><a href="#4"><code>&lt;foo&gt;</code> vs <code>&lt;foo.h&gt;</code></a>
<li><a href="porting-howto.html">Porting HOWTO</a> <li><a href="porting-howto.html">Porting HOWTO</a>
<li><a href="#5">Behavior specific to libstdc++-v3</a>
</ul> </ul>
<hr> <hr>
...@@ -162,6 +163,69 @@ ...@@ -162,6 +163,69 @@
<a href="../faq/index.html">to the FAQ</a>. <a href="../faq/index.html">to the FAQ</a>.
</p> </p>
<hr>
<h2><a name="5">Behavior specific to libstdc++-v3</a></h2>
<p>The ISO standard defines the following:
<blockquote><dl>
<dt><code>[1.3.5] implementation-defined behavior</code>
<dd>behavior, for a well-formed program construct and correct data, that
depends on the implementation <strong>and that each implementation
shall document</strong>.
</dl></blockquote>
We do so here, for the C++ library only. Behavior of the compiler,
linker, runtime loader, and other elements of &quot;the
implementation&quot; are documented elsewhere.
</p>
<p>For each entry, we give the section number of the standard, when
applicable. This list is known to be incomplet and inkorrekt.
</p>
<p><strong>[17.4.4.5]</strong> Non-reentrant functions are probably best
discussed in the various sections on multithreading (see above).
</p>
<!-- [17.4.4.8]/3 says any function that doesn't have an exception-spec
can throw whatever we want; see also its footnote. Let's list those
in the sections where the function itself occurs.
-->
<p><strong>[18.1]/4</strong> The type of <code>NULL</code> is described
<a href="../18_support/howto.html#1">here</a>.
</p>
<p><strong>[18.3]/8</strong> Even though it's listed in the library
sections, libstdc++-v3 has zero control over what the cleanup code hands
back to the runtime loader. Talk to the compiler people. :-)
</p>
<p><strong>[18.4.2.1]/5</strong> (bad_alloc),<br>
<strong>[18.5.2]/5</strong> (bad_cast),<br>
<strong>[18.5.3]/5</strong> (bad_typeid),<br>
<strong>[18.6.1]/8</strong> (exception),<br>
<strong>[18.6.2.1]/5</strong> (bad_exception): The <code>what()</code>
member function of class <code>std::exception</code>, and these other
classes publicly derived from it, simply returns the name of the
class. But they are the <em>mangled</em> names.
<!-- demangler bug fixed yet? -->
(The classes in <code>&lt;stdexcept&gt;</code> have constructors which
require a string argument to use in <code>what()</code> calls, so the
question does not arise in most user-defined exceptions.)
</p>
<p><strong></strong>
</p>
<p><strong></strong>
</p>
<p><strong></strong>
</p>
<p><strong></strong>
</p>
<p><strong></strong>
</p>
<p><strong></strong>
</p>
<p><strong></strong>
</p>
<p><strong></strong>
</p>
<p>Return <a href="#top">to top of page</a> or
<a href="../faq/index.html">to the FAQ</a>.
</p>
<!-- ####################################################### --> <!-- ####################################################### -->
......
libstdc++-v3/docs/html/documentation.html
...@@ -20,24 +20,27 @@ ...@@ -20,24 +20,27 @@
using the Doxygen tool. These are useful for examining the signatures using the Doxygen tool. These are useful for examining the signatures
of public member functions for the library classes, etc. of public member functions for the library classes, etc.
</p> </p>
<p>One collection is for the GCC 3.0 release,
<code>libstdc++-doxygen-3.0.tar.gz</code> (3.8MB),
<a href="libstdc++-doxygen-3.0/index.html">viewable online</a>.
The latest collection is for the libstdc++ 3.0.95 snapshot release,
<a href="libstdc++-doxygen-USERS-3.0.95/index.html">viewable online</a>.
Other collections for 3.0.95 exist on the FTP sites, but are not
viewable online.
</p>
<p>The collections are available in the libstdc++ snapshots directory at <p>The collections are available in the libstdc++ snapshots directory at
<code>&lt;URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/doxygen/&gt;</code>. <code>&lt;URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/doxygen/&gt;</code>.
You will almost certainly need to use one of the You will almost certainly need to use one of the
<a href="http://gcc.gnu.org/mirrors.html">mirror sites</a> to download <a href="http://gcc.gnu.org/mirrors.html">mirror sites</a> to download
the tarball. After unpacking, simply load the tarball. After unpacking, simply load libstdc++-html-*/index.html
libstdc++-doxygen-*/index.html
into a browser. Feedback (and additional documentation!) is welcome. into a browser. Feedback (and additional documentation!) is welcome.
</p> </p>
<p>With 3.0.95, an initial set of man pages are also available in the same <p>The available user-level collections are also viewable online:
directory as the doxygen collections. Start with <code>Intro(3)</code>. <ul>
<li><a href="libstdc++-doxygen-3.0/index.html">docs for the 3.0 release</a>
<li><a href="libstdc++-html-USERS-3.0.96/index.html">docs for the most
recent libstdc++ snapshot (3.0.96)</a>
<li><a href="latest-doxygen/index.html">&quot;the latest collection&quot;</a>
(snapshot collection or later; see the date on the first page)
</ul>
Other collections (man pages, maintainer docs) are only available on the
FTP sites.
</p>
<p>Beginning with 3.0.95, an initial set of man pages are also available in
the same place as the HTML collections. Start with <code>Intro(3)</code>.
</p> </p>
<hr> <hr>
......
libstdc++-v3/docs/html/faq/index.html
...@@ -15,8 +15,12 @@ ...@@ -15,8 +15,12 @@
<h1 class="centered">libstdc++ Frequently Asked Questions</h1> <h1 class="centered">libstdc++ Frequently Asked Questions</h1>
<p>The latest version of this document is always available at <p>The latest version of this document is always available at
<a href="http://gcc.gnu.org/onlinedocs/libstdc++/faq/"> <a href="http://gcc.gnu.org/onlinedocs/libstdc++/faq/">
http://gcc.gnu.org/onlinedocs/libstdc++/faq/</a>.</p> http://gcc.gnu.org/onlinedocs/libstdc++/faq/</a>. The main documentation
page is at
<a href="http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html">
http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html</a>.
</p>
<p>To the <a href="http://gcc.gnu.org/libstdc++/">libstdc++-v3 homepage</a>. <p>To the <a href="http://gcc.gnu.org/libstdc++/">libstdc++-v3 homepage</a>.
...@@ -105,7 +109,7 @@ http://gcc.gnu.org/onlinedocs/libstdc++/faq/</a>.</p> ...@@ -105,7 +109,7 @@ http://gcc.gnu.org/onlinedocs/libstdc++/faq/</a>.</p>
library reaches stable plateaus, it is captured in a snapshot library reaches stable plateaus, it is captured in a snapshot
and released. The current release is and released. The current release is
<a href="http://gcc.gnu.org/libstdc++/download.html">the <a href="http://gcc.gnu.org/libstdc++/download.html">the
twelfth snapshot</a>. For those who want to see exactly how thirteenth snapshot</a>. For those who want to see exactly how
far the project has come, or just want the latest far the project has come, or just want the latest
bleeding-edge code, the up-to-date source is available over bleeding-edge code, the up-to-date source is available over
anonymous CVS, and can even be browsed over the Web (see below). anonymous CVS, and can even be browsed over the Web (see below).
...@@ -161,7 +165,7 @@ http://gcc.gnu.org/onlinedocs/libstdc++/faq/</a>.</p> ...@@ -161,7 +165,7 @@ http://gcc.gnu.org/onlinedocs/libstdc++/faq/</a>.</p>
<hr> <hr>
<h2><a name="1_4">1.4 How do I get libstdc++?</a></h2> <h2><a name="1_4">1.4 How do I get libstdc++?</a></h2>
<p>The twelfth (and latest) snapshot of libstdc++-v3 is <p>The thirteenth (and latest) snapshot of libstdc++-v3 is
<a href="http://gcc.gnu.org/libstdc++/download.html">available via <a href="http://gcc.gnu.org/libstdc++/download.html">available via
ftp</a>. ftp</a>.
</p> </p>
...@@ -460,13 +464,26 @@ which is no longer available, thanks deja...--> ...@@ -460,13 +464,26 @@ which is no longer available, thanks deja...-->
<h2><a name="4_1">4.1 What works already?</a></h2> <h2><a name="4_1">4.1 What works already?</a></h2>
<p>This is a verbatim clip from the &quot;Status&quot; section <p>This is a verbatim clip from the &quot;Status&quot; section
of the RELEASE-NOTES for the latest snapshot. of the RELEASE-NOTES for the latest snapshot. For a list of
fixed bugs, see that file.
</p> </p>
<!-- Yeah, I meant that "verbatim clip" thing literally... :-) --> <!-- Yeah, I meant that "verbatim clip" thing literally... :-) -->
<pre> <pre>
New: New in 3.0.96:
---
- more doxygen documentation.
- extensions moved out of namespace std
- HPUX long long support
- more string optimizations
- support for NetBSD cross compiles
- concept_check merge from boost
- header simplification
- named locale bug shakeout
- thread testsuite
New in 3.0.95:
--- ---
- add S390, m68k, x86-64 support. - add S390, m68k, x86-64 support.
- doxygen documentation has been extended, including man pages. - doxygen documentation has been extended, including man pages.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment