Backport libstdc++ doc improvements from mainline
* 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/xml/manual/test.xml: Correct instructions on running tests. * doc/html/*: Regenerate. From-SVN: r249250
This commit is contained in:
parent
b1a54fbcff
commit
38a5f81782
|
@ -1,5 +1,13 @@
|
|||
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/xml/manual/test.xml: Correct instructions on running tests.
|
||||
* doc/html/*: Regenerate.
|
||||
|
||||
PR libstdc++/81092
|
||||
* acinclude.m4: Bump libtool_VERSION.
|
||||
* config/abi/post/i386-linux-gnu/baseline_symbols.txt: Update.
|
||||
|
|
|
@ -119,8 +119,8 @@
|
|||
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.
|
||||
|
@ -129,14 +129,14 @@
|
|||
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
|
||||
|
|
|
@ -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>
|
|
@ -478,7 +478,7 @@
|
|||
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 />
|
||||
|
|
|
@ -70,7 +70,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.
|
||||
|
|
|
@ -327,13 +327,13 @@ cat 27_io/objects/char/3_xin.in | a.out</pre></dd><dt><span class="term"><code c
|
|||
For example, to run the tests with
|
||||
<code class="option">-O1 -D_GLIBCXX_ASSERTIONS</code>
|
||||
you could use:
|
||||
</p><pre class="programlisting"> make RUNTESTFLAGS=--target_board=unix/-O1/-D_GLIBCXX_ASSERTIONS</pre><p>
|
||||
</p><pre class="programlisting"> make check RUNTESTFLAGS=--target_board=unix/-O1/-D_GLIBCXX_ASSERTIONS</pre><p>
|
||||
</p><p>
|
||||
The <code class="option">--target_board</code> option can also be used to run the
|
||||
tests multiple times in different variations. For example, to run the
|
||||
entire testsuite three times using <code class="option">-O3</code> but with
|
||||
different <code class="option">-std</code> options:
|
||||
</p><pre class="programlisting"> make 'RUNTESTFLAGS=--target_board=unix/-O3\"{-std=gnu++98,-std=gnu++11,-std=gnu++14}\"'</pre><p>
|
||||
</p><pre class="programlisting"> make check 'RUNTESTFLAGS=--target_board=unix/-O3\"{-std=gnu++98,-std=gnu++11,-std=gnu++14}\"'</pre><p>
|
||||
N.B. that set of variations could also be written as
|
||||
<code class="literal">unix/-O3\"{-std=gnu++98,-std=gnu++11,}\"</code> so that
|
||||
the third variation would use the default for <code class="option">-std</code>
|
||||
|
|
|
@ -185,8 +185,8 @@
|
|||
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>
|
||||
|
||||
|
@ -201,7 +201,7 @@
|
|||
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>
|
||||
|
||||
|
@ -211,9 +211,9 @@
|
|||
</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>
|
||||
|
|
|
@ -358,7 +358,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>
|
||||
|
@ -898,7 +900,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
|
||||
|
|
|
@ -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>
|
||||
|
||||
|
|
|
@ -569,7 +569,7 @@ cat 27_io/objects/char/3_xin.in | a.out</programlisting>
|
|||
For example, to run the tests with
|
||||
<option>-O1 -D_GLIBCXX_ASSERTIONS</option>
|
||||
you could use:
|
||||
<programlisting> make RUNTESTFLAGS=--target_board=unix/-O1/-D_GLIBCXX_ASSERTIONS</programlisting>
|
||||
<programlisting> make check RUNTESTFLAGS=--target_board=unix/-O1/-D_GLIBCXX_ASSERTIONS</programlisting>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
|
@ -577,7 +577,7 @@ cat 27_io/objects/char/3_xin.in | a.out</programlisting>
|
|||
tests multiple times in different variations. For example, to run the
|
||||
entire testsuite three times using <option>-O3</option> but with
|
||||
different <option>-std</option> options:
|
||||
<programlisting> make 'RUNTESTFLAGS=--target_board=unix/-O3\"{-std=gnu++98,-std=gnu++11,-std=gnu++14}\"'</programlisting>
|
||||
<programlisting> make check 'RUNTESTFLAGS=--target_board=unix/-O3\"{-std=gnu++98,-std=gnu++11,-std=gnu++14}\"'</programlisting>
|
||||
N.B. that set of variations could also be written as
|
||||
<literal>unix/-O3\"{-std=gnu++98,-std=gnu++11,}\"</literal> so that
|
||||
the third variation would use the default for <option>-std</option>
|
||||
|
|
Loading…
Reference in New Issue