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

[Jonathan Corbet]

rujra <braker.noob.kernel@xxxxxxxxx> 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@xxxxxxxxx>
> ---
>  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