linux-kernel - Re: [PATCH] Documentation: siphash: Fix typo in the name of offsetofend macro

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <87fsj6bhwb.fsf@meer.lwn.net>
Date:   Tue, 12 Jul 2022 07:05:40 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Dov Murik <dovmurik@...ux.ibm.com>, linux-doc@...r.kernel.org
Cc:     Dov Murik <dovmurik@...ux.ibm.com>,
        Eric Biggers <ebiggers@...gle.com>,
        linux-kernel@...r.kernel.org,
        "Jason A. Donenfeld" <Jason@...c4.com>
Subject: Re: [PATCH] Documentation: siphash: Fix typo in the name of
 offsetofend macro

Dov Murik <dovmurik@...ux.ibm.com> writes:

> The siphash documentation misspelled "offsetendof" instead of
> "offsetofend".
>
> Fixes: 2c956a60778cbb ("siphash: add cryptographically secure PRF")

When you send a patch with a Fixes tag it's always a good idea to CC the
author of the patch being fixed.  Adding Jason...let me know if you'd
like me to grab this.

> Signed-off-by: Dov Murik <dovmurik@...ux.ibm.com>
> ---
>  Documentation/security/siphash.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/security/siphash.rst b/Documentation/security/siphash.rst
> index a10380cb78e5..023bd95c74a5 100644
> --- a/Documentation/security/siphash.rst
> +++ b/Documentation/security/siphash.rst
> @@ -85,7 +85,7 @@ Often times the XuY functions will not be large enough, and instead you'll
>  want to pass a pre-filled struct to siphash. When doing this, it's important
>  to always ensure the struct has no padding holes. The easiest way to do this
>  is to simply arrange the members of the struct in descending order of size,
> -and to use offsetendof() instead of sizeof() for getting the size. For
> +and to use offsetofend() instead of sizeof() for getting the size. For
>  performance reasons, if possible, it's probably a good thing to align the
>  struct to the right boundary. Here's an example::
>  
> -- 
> 2.25.1

Thanks,

jon