public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Dov Murik <dovmurik@linux.ibm.com>, linux-doc@vger.kernel.org
Cc: Dov Murik <dovmurik@linux.ibm.com>,
	Eric Biggers <ebiggers@google.com>,
	linux-kernel@vger.kernel.org,
	"Jason A. Donenfeld" <Jason@zx2c4.com>
Subject: Re: [PATCH] Documentation: siphash: Fix typo in the name of offsetofend macro
Date: Tue, 12 Jul 2022 07:05:40 -0600	[thread overview]
Message-ID: <87fsj6bhwb.fsf@meer.lwn.net> (raw)
In-Reply-To: <20220712104455.1408150-1-dovmurik@linux.ibm.com>

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

  reply	other threads:[~2022-07-12 13:05 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-12 10:44 [PATCH] Documentation: siphash: Fix typo in the name of offsetofend macro Dov Murik
2022-07-12 13:05 ` Jonathan Corbet [this message]
2022-07-12 13:30   ` Jason A. Donenfeld
2022-07-13 20:01     ` Jonathan Corbet
2022-07-14  8:29       ` Dov Murik

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87fsj6bhwb.fsf@meer.lwn.net \
    --to=corbet@lwn.net \
    --cc=Jason@zx2c4.com \
    --cc=dovmurik@linux.ibm.com \
    --cc=ebiggers@google.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox