linux-kernel - Re: [PATCH] Documentation : kernel-hacking : hacking.rst : fixed spelling mistake

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 for Android: free password hash cracker in your pocket

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

Message-ID: <87jz6ckeux.fsf@trenco.lwn.net>
Date: Mon, 19 May 2025 05:40:54 -0600
From: Jonathan Corbet <corbet@....net>
To: rujra <braker.noob.kernel@...il.com>, skhan@...uxfoundation.org
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] Documentation : kernel-hacking : hacking.rst : fixed
 spelling mistake

rujra <braker.noob.kernel@...il.com> writes:

> fixed spelling mistake
> LOG :
> ----------------------------------------
> Documentation/kernel-hacking/hacking.rst
> ----------------------------------------
> WARNING: Missing or malformed SPDX-License-Identifier tag in line 1
> +.. _kernel_hacking_hack:
>
> CHECK: 'compatability' may be misspelled - perhaps 'compatibility'?
> +     * Sun people can't spell worth damn. "compatability" indeed.
>                                             ^^^^^^^^^^^^^
>
> total: 0 errors, 1 warnings, 1 checks, 830 lines checked
> -----------------------------------------------------------------
> as first patch for documentation.

This information is not particularly useful; a changelog should say what
you have done and why.

> Signed-off-by: Rujra Bhatt <braker.noob.kernel@...il.com>
> ---
>  Documentation/kernel-hacking/hacking.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/kernel-hacking/hacking.rst
> b/Documentation/kernel-hacking/hacking.rst
> index 0042776a9e17..22b880add846 100644
> --- a/Documentation/kernel-hacking/hacking.rst
> +++ b/Documentation/kernel-hacking/hacking.rst
> @@ -794,7 +794,7 @@ Some favorites from browsing the source. Feel free
> to add to this list.
>  ``arch/sparc/kernel/head.S:``::
>
>      /*
> -     * Sun people can't spell worth damn. "compatability" indeed.
> +     * Sun people can't spell worth damn. "compatibility" indeed.
>       * At least we *know* we can't spell, and use a spell-checker.
>       */

The misspelling here is entirely the point of the comment - fixing it is
exactly the wrong thing to do.  (Whether we need all of this material at
all is a different question...)

Thanks,

jon