[PATCH] Update documentation of implementation-defined library features
Jonathan Wakely
jwakely@redhat.com
Thu May 30 10:14:00 GMT 2019
* 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.
Committed to trunk.
-------------- next part --------------
commit 041ae901cccdb321d584a644724480bd076ddcf5
Author: Jonathan Wakely <jwakely@redhat.com>
Date: Thu May 30 11:13:00 2019 +0100
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.
diff --git a/libstdc++-v3/doc/xml/manual/status_cxx2011.xml b/libstdc++-v3/doc/xml/manual/status_cxx2011.xml
index 9c25b8fd81f..6f3551ff65d 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 a11e93cda90..9aba079c251 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>
More information about the Libstdc++
mailing list