linux-kernel - Re: [PATCH -next] x86/mm/mtrr: fix doc warnings in generic.c

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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <YMHA1IFHVPHfNC2D@zn.tnic>
Date:   Thu, 10 Jun 2021 09:35:48 +0200
From:   Borislav Petkov <bp@...en8.de>
To:     Baokun Li <libaokun1@...wei.com>
Cc:     tglx@...utronix.de, mingo@...hat.com, x86@...nel.org,
        hpa@...or.com, jroedel@...e.de, trix@...hat.com,
        brijesh.singh@....com, rostedt@...dmis.org,
        ying-tsun.huang@....com, linux-kernel@...r.kernel.org,
        weiyongjun1@...wei.com, yuehaibing@...wei.com,
        yangjihong1@...wei.com, yukuai3@...wei.com
Subject: Re: [PATCH -next] x86/mm/mtrr: fix doc warnings in generic.c

On Sat, Jun 05, 2021 at 02:48:21PM +0800, Baokun Li wrote:
> @@ -104,7 +104,8 @@ static int check_type_overlap(u8 *prev, u8 *curr)
>  
>  /**
>   * mtrr_type_lookup_fixed - look up memory type in MTRR fixed entries
> - *
> + * @start: Start addaress.

addaress?

Spellchecker?

> + * @end: End address.
>   * Return the MTRR fixed memory type of 'start'.
>   *
>   * MTRR fixed entries are divided into the following ways:
> @@ -143,7 +144,11 @@ static u8 mtrr_type_lookup_fixed(u64 start, u64 end)
>  
>  /**
>   * mtrr_type_lookup_variable - look up memory type in MTRR variable entries
> - *
> + * @start: Start addaress.

addaress?

Spellchecker?

> + * @end: End address.
> + * @partial_end: Partial end address.
> + * @repeat: Memory is repeat or not.
> + * @uniform: Memory is uniform or not.

Did you actually read that whole comment to see that maybe "repeat" and
"uniform" are explained a bit further down or are you blindly "fixing"
warnings just so that the tool shuts up?

-- 
Regards/Gruss,
    Boris.

https://people.kernel.org/tglx/notes-about-netiquette