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

From: Jonathan Corbet
Date: Tue Jul 12 2022 - 09:05:44 EST


Dov Murik <dovmurik@xxxxxxxxxxxxx> 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@xxxxxxxxxxxxx>
> ---
> 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