From: Jonathan Wakely Date: Fri, 16 Jun 2017 12:55:17 +0000 (+0100) Subject: Backport libstdc++ doc improvements from mainline X-Git-Tag: releases/gcc-5.5.0~207 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9a2f8681e270adc14d9a0ed30780fdcea1e33c0e;p=thirdparty%2Fgcc.git 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/html/*: Regenerate. From-SVN: r249254 --- diff --git a/libstdc++-v3/ChangeLog b/libstdc++-v3/ChangeLog index 61047cca1f24..81cd79a69c11 100644 --- a/libstdc++-v3/ChangeLog +++ b/libstdc++-v3/ChangeLog @@ -1,5 +1,12 @@ 2017-06-16 Jonathan Wakely + * 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. diff --git a/libstdc++-v3/doc/html/faq.html b/libstdc++-v3/doc/html/faq.html index cac00d292b88..d68355349039 100644 --- a/libstdc++-v3/doc/html/faq.html +++ b/libstdc++-v3/doc/html/faq.html @@ -862,7 +862,7 @@ 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 - C++ + C++ ABI for Itanium) 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 diff --git a/libstdc++-v3/doc/html/manual/memory.html b/libstdc++-v3/doc/html/manual/memory.html index cf58f632b78d..951b8a009a56 100644 --- a/libstdc++-v3/doc/html/manual/memory.html +++ b/libstdc++-v3/doc/html/manual/memory.html @@ -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 sequence - and associative + Test source for sequence + and associative containers.

  • 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 - here. + here.

  • A threaded producer/consumer model.

    Test source for - sequence + sequence and - associative + associative containers.

    • The current default choice for diff --git a/libstdc++-v3/doc/html/manual/mt_allocator_impl.html b/libstdc++-v3/doc/html/manual/mt_allocator_impl.html index 7b3379aa1d4a..15ac1e754e02 100644 --- a/libstdc++-v3/doc/html/manual/mt_allocator_impl.html +++ b/libstdc++-v3/doc/html/manual/mt_allocator_impl.html @@ -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 - + example.

    Prev Up Next
    Design Issues Home Single Thread Example
    \ No newline at end of file diff --git a/libstdc++-v3/doc/html/manual/source_code_style.html b/libstdc++-v3/doc/html/manual/source_code_style.html index 790276f3f5cb..e17530c1763a 100644 --- a/libstdc++-v3/doc/html/manual/source_code_style.html +++ b/libstdc++-v3/doc/html/manual/source_code_style.html @@ -478,7 +478,7 @@       Examples: _S_max_elements  _S_default_value

          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 BADNAMES 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
    diff --git a/libstdc++-v3/doc/html/manual/source_organization.html b/libstdc++-v3/doc/html/manual/source_organization.html index a5dc9689fdde..46987e093c6b 100644 --- a/libstdc++-v3/doc/html/manual/source_organization.html +++ b/libstdc++-v3/doc/html/manual/source_organization.html @@ -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 permutations + DejaGnu 1.5.3 or later.

    Other subdirectories contain variant versions of certain files that are meant to be copied or linked by the configure script. diff --git a/libstdc++-v3/doc/xml/manual/allocator.xml b/libstdc++-v3/doc/xml/manual/allocator.xml index 3aaad338adef..395b4e3b4ba3 100644 --- a/libstdc++-v3/doc/xml/manual/allocator.xml +++ b/libstdc++-v3/doc/xml/manual/allocator.xml @@ -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 sequence - and associative + Test source for sequence + and associative containers. @@ -201,7 +201,7 @@ on a per-thread basis, as well as measuring thread contention for memory resources. Test source - here. + here. @@ -211,9 +211,9 @@ Test source for - sequence + sequence and - associative + associative containers. diff --git a/libstdc++-v3/doc/xml/manual/appendix_contributing.xml b/libstdc++-v3/doc/xml/manual/appendix_contributing.xml index aca3d99e4c5a..195a70c59007 100644 --- a/libstdc++-v3/doc/xml/manual/appendix_contributing.xml +++ b/libstdc++-v3/doc/xml/manual/appendix_contributing.xml @@ -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 permutations + DejaGnu 1.5.3 or later. @@ -881,7 +883,7 @@ indicate a place that may require attention for multi-thread safety. Examples: _S_max_elements _S_default_value 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 BADNAMES 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 diff --git a/libstdc++-v3/doc/xml/manual/mt_allocator.xml b/libstdc++-v3/doc/xml/manual/mt_allocator.xml index 12fe2ee3b64a..e2a7d0900c6e 100644 --- a/libstdc++-v3/doc/xml/manual/mt_allocator.xml +++ b/libstdc++-v3/doc/xml/manual/mt_allocator.xml @@ -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 - + example.