[PATCH RESEND 0/2] Documentation: siphash: formatting fixes

[PATCH RESEND 0/2] Documentation: siphash: formatting fixes

[Bagas Sanjaya]

Formatting fixes for Documentation/security/siphash.rst. The shortlog
should be self-explanatory. Resend of [1].

[1]: https://lore.kernel.org/linux-doc/20220329042952.10100-1-bagasdotme@gmail.com/

Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Eric Biggers <ebiggers@google.com>
Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: linux-kernel@vger.kernel.org

Bagas Sanjaya (2):
  Documentation: siphash: convert danger note to warning for HalfSipHash
  Documentation: siphash: enclose HalfSipHash usage example in the
    literal block

 Documentation/security/siphash.rst | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)


base-commit: f443e374ae131c168a065ea1748feac6b2e76613
-- 
An old man doll... just what I always wanted! - Clara

[PATCH RESEND 1/2] Documentation: siphash: convert danger note to warning for HalfSipHash

[Bagas Sanjaya]

Render danger paragraph into warning block for emphasization.

Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Eric Biggers <ebiggers@google.com>
Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/security/siphash.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/Documentation/security/siphash.rst b/Documentation/security/siphash.rst
index bd9363025fcbc1..42794a7e052f1e 100644
--- a/Documentation/security/siphash.rst
+++ b/Documentation/security/siphash.rst
@@ -121,12 +121,12 @@ even scarier, uses an easily brute-forcable 64-bit key (with a 32-bit output)
 instead of SipHash's 128-bit key. However, this may appeal to some
 high-performance `jhash` users.
 
-Danger!
-
-Do not ever use HalfSipHash except for as a hashtable key function, and only
-then when you can be absolutely certain that the outputs will never be
-transmitted out of the kernel. This is only remotely useful over `jhash` as a
-means of mitigating hashtable flooding denial of service attacks.
+.. warning::
+   Do not ever use HalfSipHash except for as a hashtable key function, and
+   only then when you can be absolutely certain that the outputs will never
+   be transmitted out of the kernel. This is only remotely useful over
+   `jhash` as a means of mitigating hashtable flooding denial of service
+   attacks.
 
 Generating a HalfSipHash key
 ============================
-- 
An old man doll... just what I always wanted! - Clara

[PATCH RESEND 2/2] Documentation: siphash: enclose HalfSipHash usage example in the literal block

[Bagas Sanjaya]

Render usage example of HalfSipHash function as code block by using
literal block syntax.

Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Eric Biggers <ebiggers@google.com>
Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/security/siphash.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/security/siphash.rst b/Documentation/security/siphash.rst
index 42794a7e052f1e..06d793e680869c 100644
--- a/Documentation/security/siphash.rst
+++ b/Documentation/security/siphash.rst
@@ -132,10 +132,10 @@ Generating a HalfSipHash key
 ============================
 
 Keys should always be generated from a cryptographically secure source of
-random numbers, either using get_random_bytes or get_random_once:
+random numbers, either using get_random_bytes or get_random_once::
 
-hsiphash_key_t key;
-get_random_bytes(&key, sizeof(key));
+        hsiphash_key_t key;
+        get_random_bytes(&key, sizeof(key));
 
 If you're not deriving your key from here, you're doing it wrong.
 
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH RESEND 0/2] Documentation: siphash: formatting fixes

[Jonathan Corbet]

Bagas Sanjaya <bagasdotme@gmail.com> writes:

> Formatting fixes for Documentation/security/siphash.rst. The shortlog
> should be self-explanatory. Resend of [1].
>
> [1]: https://lore.kernel.org/linux-doc/20220329042952.10100-1-bagasdotme@gmail.com/
>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Eric Biggers <ebiggers@google.com>
> Cc: Herbert Xu <herbert@gondor.apana.org.au>
> Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> Cc: linux-kernel@vger.kernel.org
>
> Bagas Sanjaya (2):
>   Documentation: siphash: convert danger note to warning for HalfSipHash
>   Documentation: siphash: enclose HalfSipHash usage example in the
>     literal block
>
>  Documentation/security/siphash.rst | 18 +++++++++---------
>  1 file changed, 9 insertions(+), 9 deletions(-)

Applied, thanks.

jon