]> git.ipfire.org Git - thirdparty/gcc.git/commitdiff
Backport libstdc++ doc improvements from mainline
authorJonathan Wakely <jwakely@redhat.com>
Fri, 16 Jun 2017 12:55:17 +0000 (13:55 +0100)
committerJonathan Wakely <redi@gcc.gnu.org>
Fri, 16 Jun 2017 12:55:17 +0000 (13:55 +0100)
* doc/xml/manual/appendix_contributing.xml: Link to the list of bad
names, and link to the test docs and note higher DejaGnu version
requirement.
* doc/xml/manual/allocator.xml: Fix ViewCVS URLs.
* doc/xml/manual/mt_allocator.xml: Likewise.
* doc/html/*: Regenerate.

From-SVN: r249254

libstdc++-v3/ChangeLog
libstdc++-v3/doc/html/faq.html
libstdc++-v3/doc/html/manual/memory.html
libstdc++-v3/doc/html/manual/mt_allocator_impl.html
libstdc++-v3/doc/html/manual/source_code_style.html
libstdc++-v3/doc/html/manual/source_organization.html
libstdc++-v3/doc/xml/manual/allocator.xml
libstdc++-v3/doc/xml/manual/appendix_contributing.xml
libstdc++-v3/doc/xml/manual/mt_allocator.xml

index 61047cca1f24bfeaf4a727ab530d0aefbb39965e..81cd79a69c11b39d327692d508bbbf00dc97755e 100644 (file)
@@ -1,5 +1,12 @@
 2017-06-16  Jonathan Wakely  <jwakely@redhat.com>
 
+       * doc/xml/manual/appendix_contributing.xml: Link to the list of bad
+       names, and link to the test docs and note higher DejaGnu version
+       requirement.
+       * doc/xml/manual/allocator.xml: Fix ViewCVS URLs.
+       * doc/xml/manual/mt_allocator.xml: Likewise.
+       * doc/html/*: Regenerate.
+
        * include/bits/locale_conv.h (wbuffer_convert::_M_put): Add missing
        return statement.
 
index cac00d292b886fbf5de6eb45aadf1ff5ac197142..d68355349039e0496e491996b739d14ff1cb1e5a 100644 (file)
     details than for C, and most CPU designers (for good reasons elaborated
     below) have not stepped up to publish C++ ABIs.  Such an ABI has been
     defined for the Itanium architecture (see
-    <a class="link" href="http://www.codesourcery.com/cxx-abi/" target="_top">C++
+    <a class="link" href="http://mentorembedded.github.io/cxx-abi/" target="_top">C++
     ABI for Itanium</a>) and that is used by G++ and other compilers
     as the de facto standard ABI on many common architectures (including x86).
     G++ can also use the ARM architecture's EABI, for embedded
index cf58f632b78dd71c1c6894854153afdfe9d730d8..951b8a009a566fe958137df1c282110f183f389e 100644 (file)
        Over multiple iterations, various STL container
      objects have elements inserted to some maximum amount. A variety
      of allocators are tested.
-     Test source for <a class="link" href="http://gcc.gnu.org/viewcvs/trunk/libstdc%2B%2B-v3/testsuite/performance/23_containers/insert/sequence.cc?view=markup" target="_top">sequence</a>
-     and <a class="link" href="http://gcc.gnu.org/viewcvs/trunk/libstdc%2B%2B-v3/testsuite/performance/23_containers/insert/associative.cc?view=markup" target="_top">associative</a>
+     Test source for <a class="link" href="http://gcc.gnu.org/viewcvs/gcc/trunk/libstdc%2B%2B-v3/testsuite/performance/23_containers/insert/sequence.cc?view=markup" target="_top">sequence</a>
+     and <a class="link" href="http://gcc.gnu.org/viewcvs/gcc/trunk/libstdc%2B%2B-v3/testsuite/performance/23_containers/insert/associative.cc?view=markup" target="_top">associative</a>
      containers.
        </p></li><li class="listitem"><p>
        Insertion and erasure in a multi-threaded environment.
      on a per-thread basis, as well as measuring thread contention
      for memory resources.
      Test source
-    <a class="link" href="http://gcc.gnu.org/viewcvs/trunk/libstdc%2B%2B-v3/testsuite/performance/23_containers/insert_erase/associative.cc?view=markup" target="_top">here</a>.
+    <a class="link" href="http://gcc.gnu.org/viewcvs/gcc/trunk/libstdc%2B%2B-v3/testsuite/performance/23_containers/insert_erase/associative.cc?view=markup" target="_top">here</a>.
        </p></li><li class="listitem"><p>
         A threaded producer/consumer model.
        </p><p>
        Test source for
-     <a class="link" href="http://gcc.gnu.org/viewcvs/trunk/libstdc++-v3/testsuite/performance/23_containers/producer_consumer/sequence.cc?view=markup" target="_top">sequence</a>
+     <a class="link" href="http://gcc.gnu.org/viewcvs/gcc/trunk/libstdc++-v3/testsuite/performance/23_containers/producer_consumer/sequence.cc?view=markup" target="_top">sequence</a>
      and
-     <a class="link" href="http://gcc.gnu.org/viewcvs/trunk/libstdc++-v3/testsuite/performance/23_containers/producer_consumer/associative.cc?view=markup" target="_top">associative</a>
+     <a class="link" href="http://gcc.gnu.org/viewcvs/gcc/trunk/libstdc++-v3/testsuite/performance/23_containers/producer_consumer/associative.cc?view=markup" target="_top">associative</a>
      containers.
      </p></li></ol></div><p>
      The current default choice for
index 7b3379aa1d4a222e82ebcdb2a0c7b5073a43f972..15ac1e754e0235093425c89354f6067cc3b10567 100644 (file)
@@ -155,6 +155,6 @@ containers, this works, as an instance of the allocator is constructed
 as part of a container's constructor. However, this assumption is
 implementation-specific, and subject to change. For an example of a
 pool that frees memory, see the following
-    <a class="link" href="http://gcc.gnu.org/viewcvs/trunk/libstdc++-v3/testsuite/ext/mt_allocator/deallocate_local-6.cc?view=markup" target="_top">
+    <a class="link" href="http://gcc.gnu.org/viewcvs/gcc/trunk/libstdc++-v3/testsuite/ext/mt_allocator/deallocate_local-6.cc?view=markup" target="_top">
     example.</a>
 </p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="mt_allocator_design.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="mt_allocator.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="mt_allocator_ex_single.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Design Issues </td><td width="20%" align="center"><a accesskey="h" href="../index.html">Home</a></td><td width="40%" align="right" valign="top"> Single Thread Example</td></tr></table></div></body></html>
\ No newline at end of file
index 790276f3f5cb84d99f5a3d191ad3139a29c2c465..e17530c1763a5f4bc09de61cc0fd898e4583b365 100644 (file)
       Examples: <code class="code">_S_max_elements  _S_default_value</code><br />
 <br />
       Don't use names in the same scope that differ only in the prefix,<br />
-      e.g. _S_top and _M_top. See BADNAMES for a list of forbidden names.<br />
+      e.g. _S_top and _M_top. See <a class="link" href="source_code_style.html#coding_style.bad_identifiers" title="Bad Identifiers">BADNAMES</a> for a list of forbidden names.<br />
       (The most tempting of these seem to be and "_T" and "__sz".)<br />
 <br />
       Names must never have "__" internally; it would confuse name<br />
index a5dc9689fdde7cfe5af905795cb85d76fc275289..46987e093c6bf09ec4130d862f0475987d691e3d 100644 (file)
@@ -63,7 +63,9 @@ It has subdirectories:
     library.  Support for "make check" and "make check-install" is
     complete, and runs through all the subdirectories here when this
     command is issued from the build directory.  Please note that
-    "make check" requires DejaGNU 1.4 or later to be installed.
+    "make check" requires DejaGnu 1.4 or later to be installed,
+    or for extra <a class="link" href="test.html#test.run.permutations" title="Permutations">permutations</a>
+    DejaGnu 1.5.3 or later.
     </dd></dl></div><p>
 Other subdirectories contain variant versions of certain files
 that are meant to be copied or linked by the configure script.
index 3aaad338adef4f4ea755f1ecbdeeb7ec5876ff16..395b4e3b4ba3d154fdfea627b49e158e2ffaa443 100644 (file)
        Over multiple iterations, various STL container
      objects have elements inserted to some maximum amount. A variety
      of allocators are tested.
-     Test source for <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/viewcvs/trunk/libstdc%2B%2B-v3/testsuite/performance/23_containers/insert/sequence.cc?view=markup">sequence</link>
-     and <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/viewcvs/trunk/libstdc%2B%2B-v3/testsuite/performance/23_containers/insert/associative.cc?view=markup">associative</link>
+     Test source for <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/viewcvs/gcc/trunk/libstdc%2B%2B-v3/testsuite/performance/23_containers/insert/sequence.cc?view=markup">sequence</link>
+     and <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/viewcvs/gcc/trunk/libstdc%2B%2B-v3/testsuite/performance/23_containers/insert/associative.cc?view=markup">associative</link>
      containers.
        </para>
 
      on a per-thread basis, as well as measuring thread contention
      for memory resources.
      Test source
-    <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/viewcvs/trunk/libstdc%2B%2B-v3/testsuite/performance/23_containers/insert_erase/associative.cc?view=markup">here</link>.
+    <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/viewcvs/gcc/trunk/libstdc%2B%2B-v3/testsuite/performance/23_containers/insert_erase/associative.cc?view=markup">here</link>.
        </para>
      </listitem>
 
        </para>
        <para>
        Test source for
-     <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/viewcvs/trunk/libstdc++-v3/testsuite/performance/23_containers/producer_consumer/sequence.cc?view=markup">sequence</link>
+     <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/viewcvs/gcc/trunk/libstdc++-v3/testsuite/performance/23_containers/producer_consumer/sequence.cc?view=markup">sequence</link>
      and
-     <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/viewcvs/trunk/libstdc++-v3/testsuite/performance/23_containers/producer_consumer/associative.cc?view=markup">associative</link>
+     <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/viewcvs/gcc/trunk/libstdc++-v3/testsuite/performance/23_containers/producer_consumer/associative.cc?view=markup">associative</link>
      containers.
      </para>
      </listitem>
index aca3d99e4c5ae48c232052a11d39af70868a7118..195a70c59007dc11d425dad044e22d24f7300aed 100644 (file)
@@ -343,7 +343,9 @@ It has subdirectories:
     library.  Support for "make check" and "make check-install" is
     complete, and runs through all the subdirectories here when this
     command is issued from the build directory.  Please note that
-    "make check" requires DejaGNU 1.4 or later to be installed.
+    "make check" requires DejaGnu 1.4 or later to be installed,
+    or for extra <link linkend="test.run.permutations">permutations</link>
+    DejaGnu 1.5.3 or later.
     </listitem>
   </varlistentry>
 </variablelist>
@@ -881,7 +883,7 @@ indicate a place that may require attention for multi-thread safety.
       Examples: <code>_S_max_elements  _S_default_value</code>
 
       Don't use names in the same scope that differ only in the prefix,
-      e.g. _S_top and _M_top. See BADNAMES for a list of forbidden names.
+      e.g. _S_top and _M_top. See <link linkend="coding_style.bad_identifiers">BADNAMES</link> for a list of forbidden names.
       (The most tempting of these seem to be and "_T" and "__sz".)
 
       Names must never have "__" internally; it would confuse name
index 12fe2ee3b64a442fd5acbb64b3afd26badd3dafb..e2a7d0900c6e2046b2d86e092a2e3042610aca82 100644 (file)
@@ -307,7 +307,7 @@ containers, this works, as an instance of the allocator is constructed
 as part of a container's constructor. However, this assumption is
 implementation-specific, and subject to change. For an example of a
 pool that frees memory, see the following
-    <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/viewcvs/trunk/libstdc++-v3/testsuite/ext/mt_allocator/deallocate_local-6.cc?view=markup">
+    <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://gcc.gnu.org/viewcvs/gcc/trunk/libstdc++-v3/testsuite/ext/mt_allocator/deallocate_local-6.cc?view=markup">
     example.</link>
 </para>