This is the mail archive of the gcc-patches@gcc.gnu.org mailing list for the GCC project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

[libstdc++] Tweak up docs for snapshot



I've uploaded a new collection of doxygen'd pages.  Here are the updates
to the docs in the repository.  They also contain various typo fixes and
other updates for the snapshot.



2001-12-19  Phil Edwards  <pme@gcc.gnu.org>

	* docs/html/configopts.html:  Describe recent options.
	* docs/html/documentation.html:  Point to new doxygen tarballs.
	* docs/html/install.html:  Brief updates.
	* docs/html/17_intro/RELEASE-NOTES:  Remove weird control character.
	* docs/html/ext/howto.html:  Fix typos, describe filebuf::fd().
	* docs/html/faq/index.html:  Update for 3.0.95.
	* docs/html/faq/index.txt:  Regenerate.


Index: docs/html/documentation.html
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/docs/html/documentation.html,v
retrieving revision 1.11
diff -u -3 -p -r1.11 documentation.html
--- documentation.html	2001/10/25 21:17:34	1.11
+++ documentation.html	2001/12/19 21:31:55
@@ -20,19 +20,25 @@
    using the Doxygen tool.  These are useful for examining the signatures
    of public member functions for the library classes, etc.
 </p>
-<p>
-   The latest collection is for the GCC 3.0 release,
+<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 collection is also available in the libstdc++ snapshots directory at
-   <code>&lt;URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/&gt;</code>.  You will
-   almost certainly need to use one of the
+   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
+   <code>&lt;URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/doxygen/&gt;</code>.
+   You will almost certainly need to use one of the
    <a href="http://gcc.gnu.org/mirrors.html";>mirror sites</a> to download
    the tarball.  After unpacking, simply load
-   libstdc++-doxygen-3.0/index.html <!-- also update this date -->
-   in a browser.  Feedback (and additional documentation!) is welcome.
+   libstdc++-doxygen-*/index.html
+   into a browser.  Feedback (and additional documentation!) is welcome.
+</p>
+<p>With 3.0.95, an initial set of man pages are also available in the same
+   directory as the doxygen collections.  Start with <code>Intro(3)</code>.
 </p>
-<!-- another paragraph here for post-release collections -->
 
 <hr>
 <h2><a name="2">Configuring, Building, Installing</a></h2>
Index: docs/html/install.html
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/docs/html/install.html,v
retrieving revision 1.11
diff -u -3 -p -r1.11 install.html
--- install.html	2001/10/11 18:41:42	1.11
+++ install.html	2001/12/19 21:31:55
@@ -39,11 +39,13 @@
 <h2><a name="prereqs">Tools you will need beforehand</a></h2>
    <p>You will need a recent version of g++ to compile the snapshot of
       libstdc++, such as one of the GCC 3.x snapshots (insert standard
-      caveat about using snapshots rather than formal releases).  You
-      will need the full source
-      distribution to whatever compiler release you are using.  The
-      GCC snapshots can be had from one of the sites on their
-      <a href="http://gcc.gnu.org/mirrors.html";>mirror list</a>.
+      caveat about using snapshots rather than formal releases).  You will
+      need the full source distribution to whatever compiler release you are
+      using.  The GCC snapshots can be had from one of the sites on their
+      <a href="http://gcc.gnu.org/mirrors.html";>mirror list</a>.  If you are
+      using a 2.x compiler, see
+      <a href="http://gcc.gnu.org/libstdc++/status.html";>the status page</a>
+      first.
    </p>
 
    <p>In addition, if you plan to modify the makefiles or regenerate the
@@ -57,9 +59,6 @@
       worries as long as the versions are correct).
    </p>
 
-   <p>GNU Make is the only 'make' that will parse the makefiles correctly.
-   </p>
-
    <p>To test your build, you will need either DejaGNU 1.4 (to run
       <code>'make check'</code> like
       <a href="http://gcc.gnu.org/install/test.html";>the rest of GCC</a>),
@@ -120,8 +119,9 @@
       </ol>
    </p>
 
-   <p>Check out or download the gcc sources: the resulting source directory
-      (<code>gcc</code> or <code>gcc-3.0</code>, for example) is <em>gccsrcdir</em>.
+   <p>Check out or download the GCC sources: the resulting source directory
+      (<code>gcc</code> or <code>gcc-3.0.3</code>, for example) is
+      <em>gccsrcdir</em>.
       Once in <em>gccsrcdir</em>, you'll need to rename or delete the
       libstdc++-v3 directory which comes with that snapshot:
       <pre>
@@ -145,7 +145,7 @@
 <h2><a name="config">Configuring</a></h2>
    <p>If you have never done this before, you should read the basic
       <a href="http://gcc.gnu.org/install/";>GCC Installation
-      Instructions</a> first.
+      Instructions</a> first.  Read <em>all of them</em>.  Twice.
    </p>
    <p>When building libstdc++-v3 you'll have to configure
       the entire <em>gccsrcdir</em> directory.  The full list of libstdc++-v3
Index: docs/html/17_intro/RELEASE-NOTES
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/docs/html/17_intro/RELEASE-NOTES,v
retrieving revision 1.3
diff -u -3 -p -r1.3 RELEASE-NOTES
Binary files /sourceware/cvs-tmp/cvsgPbPSH and RELEASE-NOTES differ
Index: docs/html/ext/howto.html
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/docs/html/ext/howto.html,v
retrieving revision 1.17
diff -u -3 -p -r1.17 howto.html
--- howto.html	2001/12/13 23:11:49	1.17
+++ howto.html	2001/12/19 21:31:55
@@ -118,7 +118,7 @@
      <li>The extensions added by SGI are so numerous that they have
          <a href="sgiexts.html">their own page</a>.  Since the SGI STL is no
          longer actively maintained, we will try and keep this code working
-         ourselves.
+         ourselves.</li>
      <li><code>filebuf</code>s have another ctor with this signature:<br>
 <code>basic_filebuf(__c_file_type*, ios_base::openmode, int_type);</code>
          <br>This comes in very handy in a number of places, such as
@@ -131,10 +131,18 @@
           <li><code>ios_base::openmode  M   </code>
               // same as all the other uses of openmode
           <li><code>int_type            B   </code>
-              // buffer size, defaults to BUFSIZ
+              // buffer size, defaults to BUFSIZ if not specified
          </ul>
          For those wanting to use file descriptors instead of FILE*'s, I
          invite you to contemplate the mysteries of C's <code>fdopen()</code>.
+         </li>
+     <li>In library snapshot 3.0.95 and later, <code>filebuf</code>s bring
+         back an old extension:  the <code>fd()</code> member function.  The
+         integer returned from this function can be used for whatever file
+         descriptors can be used for on your platform.  Naturally, the
+         library cannot track what you do on your own with a file descriptor,
+         so if you perform any I/O directly, don't expect the library to be
+         aware of it.
     </ul>
    </p>
    <p>Return <a href="#top">to top of page</a> or
@@ -188,8 +196,8 @@
       program:  when your program's std::vector&lt;int&gt; gets cut in half
       and frees a bunch of its storage, that memory can be reused by the
       private std::list&lt;WonkyWidget&gt; brought in from a KDE library
-      that you linked against.  And we don't have to call operator's new and
-      delete to pass the memory on, ether, which is a speed bonus.
+      that you linked against.  And we don't have to call operators new and
+      delete to pass the memory on, either, which is a speed bonus.
       <strong>BUT</strong>...
    </p>
    <p>What about threads?  No problem:  in a threadsafe environment, the
Index: docs/html/faq/index.html
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/docs/html/faq/index.html,v
retrieving revision 1.28
diff -u -3 -p -r1.28 index.html
--- index.html	2001/11/24 03:28:26	1.28
+++ index.html	2001/12/19 21:31:56
@@ -7,7 +7,7 @@
 <link rel="StyleSheet" href="../lib3styles.css">
 <!-- 
   ** Locations of "the most recent snapshot is the Nth" text are 
-  ** answers 1_1, 1_4, 4_1, 5_6.
+  ** answers 1_1, 1_4, 4_1.
 -->
 </head>
 <body>
@@ -105,7 +105,7 @@ http://gcc.gnu.org/onlinedocs/libstdc++/
          library reaches stable plateaus, it is captured in a snapshot
          and released.  The current release is
          <a href="http://gcc.gnu.org/libstdc++/download.html";>the
-         eleventh snapshot</a>.  For those who want to see exactly how
+         twelfth snapshot</a>.  For those who want to see exactly how
          far the project has come, or just want the latest
          bleeding-edge code, the up-to-date source is available over
          anonymous CVS, and can even be browsed over the Web (see below). 
@@ -161,9 +161,9 @@ http://gcc.gnu.org/onlinedocs/libstdc++/
 
 <hr>
    <h2><a name="1_4">1.4 How do I get libstdc++?</a></h2>
-      <p>The eleventh (and latest) snapshot of libstdc++-v3 is
+      <p>The twelfth (and latest) snapshot of libstdc++-v3 is
          <a href="http://gcc.gnu.org/libstdc++/download.html";>available via
-         ftp</a>.  The filename is libstdc++-2.92.tar.gz.
+         ftp</a>.
       </p>
       <p>The <a href="http://gcc.gnu.org/libstdc++/";>homepage</a>
          has instructions for retrieving the latest CVS sources, and for
@@ -468,27 +468,25 @@ which is no longer available, thanks dej
 <pre>
 New:
 ---
-- preliminary doxygen documentation has been added. Running &quot;make
-  doxygen&quot; in the libstdc++-v3 build directory will generate HTML
-  documentation that can be used to cross-reference names and files in
-  the library.
-- a dejagnu based testing framework has been added
-- a new implementation of the concept checking code has been ported
-  from the boost libraries.
-- support for -fno-exceptions has been added
-- stdexcept was re-written
-- using deprecated or antiquated headers now gives a warning
-- the stdio interface to iostreams has been tweaked, and now works
-  with synchronized c/c++ io
-- new libsupc++ routines implementing the IA-64 C++ ABI.
-- HPUX configuration files
-- support for AIX added
-- a lot of bugs were fixed.
-- preliminary named locales implemented
-- portability improvements made to generation of &lt;limits&gt;
-- speedups to improve configuration time.
-- DJGPP support added.
-- support for dlopening shared libstdc++
+- add S390, m68k, x86-64 support.
+- doxygen documentation has been extended, including man pages.
+- verbose terminate handling has been added.
+- some libsupc++ tweaks
+- warnings for deprecated headers now active.
+- dejagnu testsuite preliminary documentation.
+- dejagnu testsuite default.
+- dejagnu testsuite cross compiler, multilib safe.
+- long long iostreams on by default, rework of ISO C99 support.
+- iterator re-write and testsuites.
+- container testsuites.
+- allocator revamp and testsuites.
+- more concept-checking work.
+- basic_string optimization and MT fixes.
+- new limits implementation.
+- update -fno-exceptions code, verify it works.
+- full named locale support fpr all facets, choice of gnu,
+  ieee_1003.1-200x (POSIX 2), or generic models. Full support depends
+  on target OS and underlying "C" library support.
 </pre>
 
 
@@ -501,8 +499,9 @@ New:
          the GCC mailing lists.
       </p>
       <ul>
-         <li>As of 2.91, these bugs have all been fixed.  We look forward
-             to new ones, well, not exactly...
+         <li>As of 3.0.95, those bugs have all been fixed.  We look forward
+             to new ones, well, not exactly...  Existing bugs are listed in
+             the BUGS file, and the GCC GNATS database.
       </ul>
 
 <hr>


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]