diff options
author | Jonathan Wakely <jwakely@redhat.com> | 2019-05-30 11:14:06 +0100 |
---|---|---|
committer | Jonathan Wakely <redi@gcc.gnu.org> | 2019-05-30 11:14:06 +0100 |
commit | 37ad0fc9425515ab827275428a107911f512b29f (patch) | |
tree | af4e4a795db8fa3646a9acda661944a969a758c4 | |
parent | 02fac2442eaa64ef390fc1e496b0ab5c9b434a96 (diff) | |
download | gcc-37ad0fc9425515ab827275428a107911f512b29f.zip gcc-37ad0fc9425515ab827275428a107911f512b29f.tar.gz gcc-37ad0fc9425515ab827275428a107911f512b29f.tar.bz2 |
Update documentation of implementation-defined library features
* doc/xml/manual/status_cxx2011.xml: Use <variablelist> for
documentation of implementation-defined types for [thread.req.native].
* doc/xml/manual/status_cxx2017.xml: Update documentation of
implementation-defined strings for [variant.bad.access]. Fix typo in
documentation of implementation-defined support for [fs.conform.9945].
* doc/html/*: Regenerate.
From-SVN: r271773
-rw-r--r-- | libstdc++-v3/ChangeLog | 9 | ||||
-rw-r--r-- | libstdc++-v3/doc/html/manual/status.html | 29 | ||||
-rw-r--r-- | libstdc++-v3/doc/xml/manual/status_cxx2011.xml | 45 | ||||
-rw-r--r-- | libstdc++-v3/doc/xml/manual/status_cxx2017.xml | 8 |
4 files changed, 60 insertions, 31 deletions
diff --git a/libstdc++-v3/ChangeLog b/libstdc++-v3/ChangeLog index 4543aea..0618f8d 100644 --- a/libstdc++-v3/ChangeLog +++ b/libstdc++-v3/ChangeLog @@ -1,3 +1,12 @@ +2019-05-30 Jonathan Wakely <jwakely@redhat.com> + + * doc/xml/manual/status_cxx2011.xml: Use <variablelist> for + documentation of implementation-defined types for [thread.req.native]. + * doc/xml/manual/status_cxx2017.xml: Update documentation of + implementation-defined strings for [variant.bad.access]. Fix typo in + documentation of implementation-defined support for [fs.conform.9945]. + * doc/html/*: Regenerate. + 2019-05-29 Jonathan Wakely <jwakely@redhat.com> PR libstdc++/85494 diff --git a/libstdc++-v3/doc/html/manual/status.html b/libstdc++-v3/doc/html/manual/status.html index 398a9490..51b9860 100644 --- a/libstdc++-v3/doc/html/manual/status.html +++ b/libstdc++-v3/doc/html/manual/status.html @@ -374,26 +374,25 @@ particular release. is subject to change at any time. Any use of <code class="classname">native_handle</code> is inherently non-portable and not guaranteed to work between major releases of GCC. - </p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="classname">thread</code>: The native handle type is - a typedef for <code class="code">__gthread_t</code> i.e. <code class="code">pthread_t</code> - when GCC is configured with the <code class="literal">posix</code> thread - model. The value of the native handle is undefined for a thread + </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="classname">thread</code></span></dt><dd> + The native handle type is a typedef for <code class="code">__gthread_t</code> + i.e. <code class="code">pthread_t</code> when GCC is configured with the + <code class="literal">posix</code> thread model. + The value of the native handle is undefined for a thread which is not joinable. - </p></li><li class="listitem"><p><code class="classname">mutex</code> and - <code class="classname">timed_mutex</code>: + </dd><dt><span class="term"><code class="classname">mutex</code>, </span><span class="term"><code class="classname">timed_mutex</code></span></dt><dd> The native handle type is <code class="code">__gthread_mutex_t*</code> i.e. <code class="code">pthread_mutex_t*</code> for the <code class="literal">posix</code> thread model. - </p></li><li class="listitem"><p><code class="classname">recursive_mutex</code> and - <code class="classname">recursive_timed_mutex</code>: + </dd><dt><span class="term"><code class="classname">recursive_mutex</code>, </span><span class="term"><code class="classname">recursive_timed_mutex</code></span></dt><dd> The native handle type is <code class="code">__gthread_recursive_mutex_t*</code> i.e. <code class="code">pthread_mutex_t*</code> for the <code class="literal">posix</code> thread model. - </p></li><li class="listitem"><p><code class="classname">condition_variable</code>: The native - handle type is <code class="code">__gthread_cond_t*</code> i.e. + </dd><dt><span class="term"><code class="classname">condition_variable</code></span></dt><dd> + The native handle type is <code class="code">__gthread_cond_t*</code> i.e. <code class="code">pthread_cond_t*</code> for the <code class="literal">posix</code> thread model. - </p></li></ul></div><p> + </dd></dl></div><p> </p><p> <span class="emphasis"><em>30.6.1 [futures.overview]/2</em></span> <code class="code">launch</code> is a scoped enumeration type with @@ -945,7 +944,11 @@ and test for <code class="code">__STDCPP_MATH_SPEC_FUNCS__ >= 201003L</code>. <code class="classname">variant</code> supports over-aligned types. </p><p> <span class="emphasis"><em>23.7.10 [variant.bad.access]</em></span> - <code class="code">what()</code> returns <code class="literal">"Unexpected index"</code>. + <code class="code">what()</code> returns one of the strings + <code class="literal">"std::get: variant is valueless"</code>, + <code class="literal">"std::get: wrong index for variant"</code>, + <code class="literal">"std::visit: variant is valueless"</code>, + or <code class="literal">"std::visit<R>: variant is valueless"</code>. </p><p> <span class="emphasis"><em>23.12.5.2 [memory.resource.pool.options]</em></span> Let S equal <code class="code">numeric_limits<size_t>::digits</code>. @@ -998,7 +1001,7 @@ and test for <code class="code">__STDCPP_MATH_SPEC_FUNCS__ >= 201003L</code>. </p><p> <span class="emphasis"><em>30.10.2.1 [fs.conform.9945]</em></span> The behavior of the filesystem library implementation will depend on - the target operating system. Some features will not be not supported + the target operating system. Some features will not be supported on some targets. </p><p> <span class="emphasis"><em>30.10.5 [fs.filesystem.syn]</em></span> diff --git a/libstdc++-v3/doc/xml/manual/status_cxx2011.xml b/libstdc++-v3/doc/xml/manual/status_cxx2011.xml index 9c25b8f..6f3551f 100644 --- a/libstdc++-v3/doc/xml/manual/status_cxx2011.xml +++ b/libstdc++-v3/doc/xml/manual/status_cxx2011.xml @@ -2793,31 +2793,44 @@ particular release. is subject to change at any time. Any use of <classname>native_handle</classname> is inherently non-portable and not guaranteed to work between major releases of GCC. - <itemizedlist> - <listitem><para><classname>thread</classname>: The native handle type is - a typedef for <code>__gthread_t</code> i.e. <code>pthread_t</code> - when GCC is configured with the <literal>posix</literal> thread - model. The value of the native handle is undefined for a thread + <variablelist> + <varlistentry> + <term><classname>thread</classname></term> + <listitem> + The native handle type is a typedef for <code>__gthread_t</code> + i.e. <code>pthread_t</code> when GCC is configured with the + <literal>posix</literal> thread model. + The value of the native handle is undefined for a thread which is not joinable. - </para></listitem> - <listitem><para><classname>mutex</classname> and - <classname>timed_mutex</classname>: + </listitem> + </varlistentry> + <varlistentry> + <term><classname>mutex</classname></term> + <term><classname>timed_mutex</classname></term> + <listitem> The native handle type is <code>__gthread_mutex_t*</code> i.e. <code>pthread_mutex_t*</code> for the <literal>posix</literal> thread model. - </para></listitem> - <listitem><para><classname>recursive_mutex</classname> and - <classname>recursive_timed_mutex</classname>: + </listitem> + </varlistentry> + <varlistentry> + <term><classname>recursive_mutex</classname></term> + <term><classname>recursive_timed_mutex</classname></term> + <listitem> The native handle type is <code>__gthread_recursive_mutex_t*</code> i.e. <code>pthread_mutex_t*</code> for the <literal>posix</literal> thread model. - </para></listitem> - <listitem><para><classname>condition_variable</classname>: The native - handle type is <code>__gthread_cond_t*</code> i.e. + </listitem> + </varlistentry> + <varlistentry> + <term><classname>condition_variable</classname></term> + <listitem> + The native handle type is <code>__gthread_cond_t*</code> i.e. <code>pthread_cond_t*</code> for the <literal>posix</literal> thread model. - </para></listitem> - </itemizedlist> + </listitem> + </varlistentry> + </variablelist> </para> <para> diff --git a/libstdc++-v3/doc/xml/manual/status_cxx2017.xml b/libstdc++-v3/doc/xml/manual/status_cxx2017.xml index a11e93c..9aba079 100644 --- a/libstdc++-v3/doc/xml/manual/status_cxx2017.xml +++ b/libstdc++-v3/doc/xml/manual/status_cxx2017.xml @@ -1043,7 +1043,11 @@ and test for <code>__STDCPP_MATH_SPEC_FUNCS__ >= 201003L</code>. <para> <emphasis>23.7.10 [variant.bad.access]</emphasis> - <code>what()</code> returns <literal>"Unexpected index"</literal>. + <code>what()</code> returns one of the strings + <literal>"std::get: variant is valueless"</literal>, + <literal>"std::get: wrong index for variant"</literal>, + <literal>"std::visit: variant is valueless"</literal>, + or <literal>"std::visit<R>: variant is valueless"</literal>. </para> <para> @@ -1117,7 +1121,7 @@ and test for <code>__STDCPP_MATH_SPEC_FUNCS__ >= 201003L</code>. <para> <emphasis>30.10.2.1 [fs.conform.9945]</emphasis> The behavior of the filesystem library implementation will depend on - the target operating system. Some features will not be not supported + the target operating system. Some features will not be supported on some targets. </para> |