This is the mail archive of the libstdc++@gcc.gnu.org mailing list for the libstdc++ 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]
Documentation patch for forward_list (and other mostly C++-0X stuff).

From: Ed Smith-Rowland <3dw4rd at verizon dot net>
To: libstdc++ <libstdc++ at gcc dot gnu dot org>
Date: Fri, 17 Oct 2008 18:42:40 -0400
Subject: Documentation patch for forward_list (and other mostly C++-0X stuff).
All,

Here is a patch to the docs to include forward_list.

I also added the other C++-0X headers where needed and made some minor tweaks.

Ed.
Index: doc/xml/manual/backwards_compatibility.xml
===================================================================
--- doc/xml/manual/backwards_compatibility.xml	(revision 141194)
+++ doc/xml/manual/backwards_compatibility.xml	(working copy)
@@ -698,15 +698,16 @@
 
       <para>At this time most of the features of the SGI STL extension have been
          replaced by standardized libraries.
-         In particular, the unordered_map and unordered_set containers of TR1
+         In particular, the unordered_map and unordered_set containers of TR1 and C++-0X
          are suitable replacement for the non-standard hash_map and hash_set
-         containers in the SGI STL. 
+         containers in the SGI STL. Also, the forward_list of C++-0X is a suitable
+         replacement for the non-standard slist container in the SGI STL.
       </para>
 <para> Header files <filename class="headerfile">hash_map</filename> and <filename class="headerfile">hash_set</filename> moved
 to <filename class="headerfile">ext/hash_map</filename> and  <filename class="headerfile">ext/hash_set</filename>,
 respectively. At the same time, all types in these files are enclosed
 in <code>namespace __gnu_cxx</code>. Later versions move deprecate
-these files, and suggest using TR1's  <filename class="headerfile">unordered_map</filename>
+these files, and suggest using the TR1 or better yet the C++-0X <filename class="headerfile">unordered_map</filename>
 and  <filename class="headerfile">unordered_set</filename> instead.
 </para>
 
@@ -1010,7 +1011,7 @@
 Support for C++0x dialect.
 </title>
 
-<para>Check for baseline language coverage in the compiler for the C++0xstandard.
+<para>Check for baseline language coverage in the compiler for the C++0X standard.
 </para>
 
 <programlisting>
@@ -1034,7 +1035,10 @@
 
     typedef check&lt;int&gt; check_type;
     check_type c;
-    check_type&amp;&amp; cr = c;],,
+    check_type&amp;&amp; cr = c;
+
+    double d = 1.0;
+    auto da = d;],,
   ac_cv_cxx_compile_cxx0x_native=yes, ac_cv_cxx_compile_cxx0x_native=no)
   AC_LANG_RESTORE
   ])
@@ -1059,7 +1063,10 @@
 
     typedef check&lt;int&gt; check_type;
     check_type c;
-    check_type&amp;&amp; cr = c;],,
+    check_type&amp;&amp; cr = c;
+
+    double d = 1.0;
+    auto da = d;],,
   ac_cv_cxx_compile_cxx0x_cxx=yes, ac_cv_cxx_compile_cxx0x_cxx=no)
   CXXFLAGS="$ac_save_CXXFLAGS"
   AC_LANG_RESTORE
@@ -1085,7 +1092,10 @@
 
     typedef check&lt;int&gt; check_type;
     check_type c;
-    check_type&amp;&amp; cr = c;],,
+    check_type&amp;&amp; cr = c;
+
+    double d = 1.0;
+    auto da = d;],,
   ac_cv_cxx_compile_cxx0x_gxx=yes, ac_cv_cxx_compile_cxx0x_gxx=no)
   CXXFLAGS="$ac_save_CXXFLAGS"
   AC_LANG_RESTORE
@@ -1100,7 +1110,7 @@
 </programlisting>
 
 
-<para>Check for library coverage of the C++0xstandard.
+<para>Check for library coverage of the C++0X standard.
 </para>
 
 <programlisting>
@@ -1143,9 +1153,12 @@
     #include &lt;algorithm&gt;
     #include &lt;array&gt;
     #include &lt;bitset&gt;
+    #include &lt;chrono&gt;
     #include &lt;complex&gt;
+    #include &lt;condition_variable&gt;
     #include &lt;deque&gt;
     #include &lt;exception&gt;
+    #include &lt;forward_list&gt;
     #include &lt;fstream&gt;
     #include &lt;functional&gt;
     #include &lt;iomanip&gt;
@@ -1159,11 +1172,13 @@
     #include &lt;locale&gt;
     #include &lt;map&gt;
     #include &lt;memory&gt;
+    #include &lt;mutex&gt;
     #include &lt;new&gt;
     #include &lt;numeric&gt;
     #include &lt;ostream&gt;
     #include &lt;queue&gt;
     #include &lt;random&gt;
+    #include &lt;ratio&gt;
     #include &lt;regex&gt;
     #include &lt;set&gt;
     #include &lt;sstream&gt;
@@ -1171,6 +1186,8 @@
     #include &lt;stdexcept&gt;
     #include &lt;streambuf&gt;
     #include &lt;string&gt;
+    #include &lt;system_error&gt;
+    #include &lt;thread&gt;
     #include &lt;tuple&gt;
     #include &lt;typeinfo&gt;
     #include &lt;type_traits&gt;
Index: doc/xml/manual/using.xml
===================================================================
--- doc/xml/manual/using.xml	(revision 141194)
+++ doc/xml/manual/using.xml	(working copy)
@@ -161,15 +161,76 @@
 <colspec colname='c3'></colspec>
 <colspec colname='c4'></colspec>
 <tbody>
-<row><entry><filename class="headerfile">algorithm</filename></entry><entry><filename class="headerfile">iomanip</filename></entry><entry><filename class="headerfile">locale</filename></entry><entry><filename class="headerfile">regex</filename></entry><entry><filename class="headerfile">tuple</filename></entry></row>
-<row><entry><filename class="headerfile">array</filename></entry><entry><filename class="headerfile">ios</filename></entry><entry><filename class="headerfile">map</filename></entry><entry><filename class="headerfile">set</filename></entry><entry><filename class="headerfile">typeinfo</filename></entry></row>
-<row><entry><filename class="headerfile">bitset</filename></entry><entry><filename class="headerfile">iosfwd</filename></entry><entry><filename class="headerfile">memory</filename></entry><entry><filename class="headerfile">sstream</filename></entry><entry><filename class="headerfile">type_traits</filename></entry></row>
-<row><entry><filename class="headerfile">complex</filename></entry><entry><filename class="headerfile">iostream</filename></entry><entry><filename class="headerfile">new</filename></entry><entry><filename class="headerfile">stack</filename></entry><entry><filename class="headerfile">unordered_map</filename></entry></row>
-<row><entry><filename class="headerfile">deque</filename></entry><entry><filename class="headerfile">istream</filename></entry><entry><filename class="headerfile">numeric</filename></entry><entry><filename class="headerfile">stdexcept</filename></entry><entry><filename class="headerfile">unordered_set</filename></entry></row>
-<row><entry><filename class="headerfile">exception</filename></entry><entry><filename class="headerfile">iterator</filename></entry><entry><filename class="headerfile">ostream</filename></entry><entry><filename class="headerfile">streambuf</filename></entry><entry><filename class="headerfile">utility</filename></entry></row>
-<row><entry><filename class="headerfile">fstream</filename></entry><entry><filename class="headerfile">limits</filename></entry><entry><filename class="headerfile">queue</filename></entry><entry><filename class="headerfile">string</filename></entry><entry><filename class="headerfile">valarray</filename></entry></row>
-<row><entry><filename class="headerfile">functional</filename></entry><entry><filename class="headerfile">list</filename></entry><entry><filename class="headerfile">random</filename></entry><entry><filename class="headerfile">system_error</filename></entry><entry><filename class="headerfile">vector</filename></entry></row>
-<row><entry><filename class="headerfile">condition_variable</filename></entry><entry><filename class="headerfile">mutex</filename></entry><entry><filename class="headerfile">thread</filename></entry><entry></entry><entry></entry></row>
+<row>
+     <entry><filename class="headerfile">algorithm</filename></entry>
+     <entry><filename class="headerfile">functional</filename></entry>
+     <entry><filename class="headerfile">locale</filename></entry>
+     <entry><filename class="headerfile">ratio</filename></entry>
+     <entry><filename class="headerfile">thread</filename></entry>
+</row>
+<row>
+     <entry><filename class="headerfile">array</filename></entry>
+     <entry><filename class="headerfile">iomanip</filename></entry>
+     <entry><filename class="headerfile">map</filename></entry>
+     <entry><filename class="headerfile">regex</filename></entry>
+     <entry><filename class="headerfile">tuple</filename></entry>
+</row>
+<row>
+     <entry><filename class="headerfile">bitset</filename></entry>
+     <entry><filename class="headerfile">ios</filename></entry>
+     <entry><filename class="headerfile">memory</filename></entry>
+     <entry><filename class="headerfile">set</filename></entry>
+     <entry><filename class="headerfile">typeinfo</filename></entry>
+</row>
+<row>
+     <entry><filename class="headerfile">chrono</filename></entry>
+     <entry><filename class="headerfile">iosfwd</filename></entry>
+     <entry><filename class="headerfile">mutex</filename></entry>
+     <entry><filename class="headerfile">sstream</filename></entry>
+     <entry><filename class="headerfile">type_traits</filename></entry>
+</row>
+<row>
+     <entry><filename class="headerfile">complex</filename></entry>
+     <entry><filename class="headerfile">iostream</filename></entry>
+     <entry><filename class="headerfile">new</filename></entry>
+     <entry><filename class="headerfile">stack</filename></entry>
+     <entry><filename class="headerfile">unordered_map</filename></entry>
+</row>
+<row>
+     <entry><filename class="headerfile">condition_variable</filename></entry>
+     <entry><filename class="headerfile">istream</filename></entry>
+     <entry><filename class="headerfile">numeric</filename></entry>
+     <entry><filename class="headerfile">stdexcept</filename></entry>
+     <entry><filename class="headerfile">unordered_set</filename></entry>
+</row>
+<row>
+     <entry><filename class="headerfile">deque</filename></entry>
+     <entry><filename class="headerfile">iterator</filename></entry>
+     <entry><filename class="headerfile">ostream</filename></entry>
+     <entry><filename class="headerfile">streambuf</filename></entry>
+     <entry><filename class="headerfile">utility</filename></entry>
+</row>
+<row>
+     <entry><filename class="headerfile">exception</filename></entry>
+     <entry><filename class="headerfile">limits</filename></entry>
+     <entry><filename class="headerfile">queue</filename></entry>
+     <entry><filename class="headerfile">string</filename></entry>
+     <entry><filename class="headerfile">valarray</filename></entry>
+</row>
+<row>
+     <entry><filename class="headerfile">forward_list</filename></entry>
+     <entry><filename class="headerfile">list</filename></entry>
+     <entry><filename class="headerfile">random</filename></entry>
+     <entry><filename class="headerfile">system_error</filename></entry>
+     <entry><filename class="headerfile">vector</filename></entry>
+</row>
+<row>
+     <entry><filename class="headerfile">fstream</filename></entry>
+     <entry><filename class="headerfile"></filename></entry>
+     <entry><filename class="headerfile"></filename></entry>
+     <entry><filename class="headerfile"></filename></entry>
+     <entry><filename class="headerfile"></filename></entry>
+</row>
 </tbody>
 </tgroup>
 </table>
@@ -185,12 +246,48 @@
 <colspec colname='c4'></colspec>
 <colspec colname='c5'></colspec>
 <tbody>
-<row><entry><filename class="headerfile">cassert</filename></entry><entry><filename class="headerfile">cfloat</filename></entry><entry><filename class="headerfile">cmath</filename></entry><entry><filename class="headerfile">cstddef</filename></entry><entry><filename class="headerfile">ctgmath</filename></entry></row>
-<row><entry><filename class="headerfile">ccomplex</filename></entry><entry><filename class="headerfile">cinttypes</filename></entry><entry><filename class="headerfile">csetjmp</filename></entry><entry><filename class="headerfile">cstdint</filename></entry><entry><filename class="headerfile">ctime</filename></entry></row>
-<row><entry><filename class="headerfile">cctype</filename></entry><entry><filename class="headerfile">ciso646</filename></entry><entry><filename class="headerfile">csignal</filename></entry><entry><filename class="headerfile">cstdio</filename></entry><entry><filename class="headerfile">cuchar</filename></entry></row>
-<row><entry><filename class="headerfile">cerrno</filename></entry><entry><filename class="headerfile">climits</filename></entry><entry><filename class="headerfile">cstdarg</filename></entry><entry><filename class="headerfile">cstdlib</filename></entry><entry><filename class="headerfile">cwchar</filename></entry></row>
-<row><entry><filename class="headerfile">cfenv</filename></entry><entry><filename class="headerfile">clocale</filename></entry><entry><filename class="headerfile">cstdbool</filename></entry><entry><filename class="headerfile">cstring</filename></entry><entry><filename class="headerfile">cwctype</filename></entry></row>
-<row><entry><filename class="headerfile">cstdatomic</filename></entry><entry></entry><entry></entry><entry></entry><entry></entry></row>
+<row>
+     <entry><filename class="headerfile">cassert</filename></entry>
+     <entry><filename class="headerfile">cinttypes</filename></entry>
+     <entry><filename class="headerfile">csetjmp</filename></entry>
+     <entry><filename class="headerfile">cstddef</filename></entry>
+     <entry><filename class="headerfile">ctgmath</filename></entry>
+</row>
+<row>
+     <entry><filename class="headerfile">ccomplex</filename></entry>
+     <entry><filename class="headerfile">ciso646</filename></entry>
+     <entry><filename class="headerfile">csignal</filename></entry>
+     <entry><filename class="headerfile">cstdint</filename></entry>
+     <entry><filename class="headerfile">ctime</filename></entry>
+</row>
+<row>
+     <entry><filename class="headerfile">cctype</filename></entry>
+     <entry><filename class="headerfile">climits</filename></entry>
+     <entry><filename class="headerfile">cstdarg</filename></entry>
+     <entry><filename class="headerfile">cstdio</filename></entry>
+     <entry><filename class="headerfile">cuchar</filename></entry>
+</row>
+<row>
+     <entry><filename class="headerfile">cerrno</filename></entry>
+     <entry><filename class="headerfile">clocale</filename></entry>
+     <entry><filename class="headerfile">cstdatomic</filename></entry>
+     <entry><filename class="headerfile">cstdlib</filename></entry>
+     <entry><filename class="headerfile">cwchar</filename></entry>
+</row>
+<row>
+     <entry><filename class="headerfile">cfenv</filename></entry>
+     <entry><filename class="headerfile">cmath</filename></entry>
+     <entry><filename class="headerfile">cstdbool</filename></entry>
+     <entry><filename class="headerfile">cstring</filename></entry>
+     <entry><filename class="headerfile">cwctype</filename></entry>
+</row>
+<row>
+     <entry><filename class="headerfile">cfloat</filename></entry>
+     <entry></entry>
+     <entry></entry>
+     <entry></entry>
+     <entry></entry>
+</row>
 </tbody>
 </tgroup>
 </table>
Index: doc/xml/manual/status_cxx200x.xml
===================================================================
--- doc/xml/manual/status_cxx200x.xml	(revision 141194)
+++ doc/xml/manual/status_cxx200x.xml	(working copy)
@@ -805,6 +805,70 @@
     </row>
 
     <row>
+      <entry>23.2.3</entry>
+      <entry>Header <code>&lt;forward_list&gt;</code> synopsis</entry>
+      <entry>done</entry>
+      <entry></entry>
+      <entry></entry>
+      <entry></entry>
+    </row>
+    <row>
+      <entry>23.2.3</entry>
+      <entry>Class template forward_list</entry>
+      <entry>done</entry>
+      <entry></entry>
+      <entry></entry>
+      <entry></entry>
+    </row>
+    <row>
+      <entry>23.2.3.1</entry>
+      <entry>done<code>forward_list</code> constructors, copy, and assignment</entry>
+      <entry></entry>
+      <entry></entry>
+      <entry></entry>
+      <entry></entry>
+    </row>
+      <entry>23.2.3.2</entry>
+      <entry><code>forward_list</code> iterators</entry>
+      <entry>done</entry>
+      <entry></entry>
+      <entry></entry>
+      <entry></entry>
+    </row>
+    </row>
+      <entry>23.2.3.3</entry>
+      <entry><code>forward_list</code> element access</entry>
+      <entry>done</entry>
+      <entry></entry>
+      <entry></entry>
+      <entry></entry>
+    </row>
+    </row>
+      <entry>23.2.3.4</entry>
+      <entry><code>forward_list</code> modifiers</entry>
+      <entry>done</entry>
+      <entry></entry>
+      <entry></entry>
+      <entry></entry>
+    </row>
+    </row>
+      <entry>23.2.3.5</entry>
+      <entry><code>forward_list</code> operations</entry>
+      <entry>done</entry>
+      <entry></entry>
+      <entry></entry>
+      <entry></entry>
+    </row>
+    </row>
+      <entry>23.2.3.6</entry>
+      <entry><code>forward_list</code> specialized algorithms</entry>
+      <entry>done</entry>
+      <entry></entry>
+      <entry></entry>
+      <entry></entry>
+    </row>
+
+    <row>
       <entry>23.4</entry>
       <entry>Unordered associative containers</entry>
       <entry>done</entry>
Attachment: CL_docs
Description: Binary data
Index Nav:	[Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav:	[Date Prev] [Date Next]	[Thread Prev] [Thread Next]