diff mbox series

[committed] libstdc++: Document new std::random_device tokens

Message ID 20220114101455.2975204-1-jwakely@redhat.com
State Committed
Commit 7f390f11b445ee36cce5c5f1d5779baee817f0af
Headers show
Series [committed] libstdc++: Document new std::random_device tokens | expand

Commit Message

Jonathan Wakely Jan. 14, 2022, 10:14 a.m. UTC
Pushed to trunk.

libstdc++-v3/ChangeLog:

	* doc/xml/manual/status_cxx2011.xml: Document new tokens
	accepted by std::random_device constructor.
	* doc/html/manual/status.html: Regenerate.
---
 libstdc++-v3/doc/html/manual/status.html      | 13 ++++++++
 .../doc/xml/manual/status_cxx2011.xml         | 30 +++++++++++++++++++
 2 files changed, 43 insertions(+)
diff mbox series

Patch

diff --git a/libstdc++-v3/doc/xml/manual/status_cxx2011.xml b/libstdc++-v3/doc/xml/manual/status_cxx2011.xml
index 88844f8f0cc..1eeb2d1ccd7 100644
--- a/libstdc++-v3/doc/xml/manual/status_cxx2011.xml
+++ b/libstdc++-v3/doc/xml/manual/status_cxx2011.xml
@@ -2720,6 +2720,36 @@  particular release.
           the assembler and CPU support the corresponding instruction.
         </listitem>
       </varlistentry>
+      <varlistentry>
+        <term><literal>"darn"</literal></term>
+        <listitem>
+          Use the Power ISA-3.0 <literal>DARN</literal>
+          ("Deliver A Random Number")
+          instruction to read from an on-chip hardware random number generator.
+          This token is only valid for 64-bit powerpc targets when both
+          the assembler and CPU support the corresponding instruction.
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><literal>"hw"</literal></term>
+        <term><literal>"hardware"</literal></term>
+        <listitem>
+          Use any available CPU
+          instruction to read from an on-chip hardware random number generator.
+          This is equivalent to trying each of the following and using the
+          first that is supported:
+          <literal>"rdseed"</literal>
+          <literal>"rdrand"</literal>
+          <literal>"darn"</literal>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><literal>"arc4random"</literal></term>
+        <term><literal>"getentropy"</literal></term>
+        <listitem>
+          Use the named C library function, if available on the target.
+        </listitem>
+      </varlistentry>
       <varlistentry>
         <term><literal>"/dev/urandom"</literal></term>
         <term><literal>"/dev/random"</literal></term>