2022-07-12 11:10:10

by Dov Murik

[permalink] [raw]
Subject: [PATCH] Documentation: siphash: Fix typo in the name of offsetofend macro

The siphash documentation misspelled "offsetendof" instead of
"offsetofend".

Fixes: 2c956a60778cbb ("siphash: add cryptographically secure PRF")
Signed-off-by: Dov Murik <[email protected]>
---
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


2022-07-12 13:12:08

by Jonathan Corbet

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

Dov Murik <[email protected]> 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 <[email protected]>
> ---
> 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

2022-07-12 13:34:01

by Jason A. Donenfeld

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

Hi Jon,

On Tue, Jul 12, 2022 at 07:05:40AM -0600, Jonathan Corbet wrote:
> Dov Murik <[email protected]> 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.

Thanks for CC'ing me. Sure, feel free to take this:

Acked-by: Jason A. Donenfeld <[email protected]>

Jason

2022-07-13 20:53:17

by Jonathan Corbet

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

"Jason A. Donenfeld" <[email protected]> writes:

> Hi Jon,
>
> On Tue, Jul 12, 2022 at 07:05:40AM -0600, Jonathan Corbet wrote:
>> Dov Murik <[email protected]> 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.
>
> Thanks for CC'ing me. Sure, feel free to take this:
>
> Acked-by: Jason A. Donenfeld <[email protected]>

Applied, thanks.

jon

2022-07-14 09:03:02

by Dov Murik

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



On 13/07/2022 23:01, Jonathan Corbet wrote:
> "Jason A. Donenfeld" <[email protected]> writes:
>
>> Hi Jon,
>>
>> On Tue, Jul 12, 2022 at 07:05:40AM -0600, Jonathan Corbet wrote:
>>> Dov Murik <[email protected]> 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.
>>
>> Thanks for CC'ing me. Sure, feel free to take this:
>>
>> Acked-by: Jason A. Donenfeld <[email protected]>
>
> Applied, thanks.

Thank you Jon.

I'll try to remember your tip about CC the author of the Fixes tag.

-Dov


>
> jon