From: Jonathan Wakely <jwakely@redhat.com>
Date: Tue, 11 Jan 2022 21:27:28 +0000 (+0000)
Subject: libstdc++: Document new std::random_device tokens
X-Git-Tag: basepoints/gcc-13~1742
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7f390f11b445ee36cce5c5f1d5779baee817f0af;p=thirdparty%2Fgcc.git

libstdc++: Document new std::random_device tokens

libstdc++-v3/ChangeLog:

	* doc/xml/manual/status_cxx2011.xml: Document new tokens
	accepted by std::random_device constructor.
	* doc/html/manual/status.html: Regenerate.
---

diff --git a/libstdc++-v3/doc/html/manual/status.html b/libstdc++-v3/doc/html/manual/status.html
index ad612310b5db..c449fdec928f 100644
--- a/libstdc++-v3/doc/html/manual/status.html
+++ b/libstdc++-v3/doc/html/manual/status.html
@@ -325,6 +325,19 @@ particular release.
           instruction to read from an on-chip hardware random number generator.
           These tokens are only valid for x86 and x86_64 targets when both
           the assembler and CPU support the corresponding instruction.
+        </dd><dt><span class="term"><code class="literal">"darn"</code></span></dt><dd>
+          Use the Power ISA-3.0 <code class="literal">DARN</code>
+          ("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.
+        </dd><dt><span class="term"><code class="literal">"hw"</code>, </span><span class="term"><code class="literal">"hardware"</code></span></dt><dd>
+          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:
+          <code class="literal">"rdseed"</code><code class="literal">"rdrand"</code><code class="literal">"darn"</code></dd><dt><span class="term"><code class="literal">"arc4random"</code>, </span><span class="term"><code class="literal">"getentropy"</code></span></dt><dd>
+          Use the named C library function, if available on the target.
         </dd><dt><span class="term"><code class="literal">"/dev/urandom"</code>, </span><span class="term"><code class="literal">"/dev/random"</code></span></dt><dd>
           Use the named character special file to read random bytes from.
           These tokens are only valid when the device files are present
diff --git a/libstdc++-v3/doc/xml/manual/status_cxx2011.xml b/libstdc++-v3/doc/xml/manual/status_cxx2011.xml
index 88844f8f0ccf..1eeb2d1ccd78 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>