linux-kernel - Re: [PATCH v4] x86/resctrl: Fix kernel-doc in pseudo

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <1bdf84eb-b7d9-a2eb-88db-9ca55aa38d08@intel.com>
Date:   Fri, 18 Jun 2021 11:55:14 -0700
From:   Reinette Chatre <reinette.chatre@...el.com>
To:     "Fabio M. De Francesco" <fmdefrancesco@...il.com>,
        Fenghua Yu <fenghua.yu@...el.com>,
        Thomas Gleixner <tglx@...utronix.de>,
        Ingo Molnar <mingo@...hat.com>, Borislav Petkov <bp@...en8.de>,
        x86@...nel.org, "H. Peter Anvin" <hpa@...or.com>,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v4] x86/resctrl: Fix kernel-doc in pseudo_lock.c

Hi Fabio,

On 6/16/2021 11:15 AM, Fabio M. De Francesco wrote:
> Add undocumented parameters detected by scripts/kernel-doc.
> 
> Signed-off-by: Fabio M. De Francesco <fmdefrancesco@...il.com>

Before this patch:
$ scripts/kernel-doc -none arch/x86/kernel/cpu/resctrl/pseudo_lock.c
arch/x86/kernel/cpu/resctrl/pseudo_lock.c:169: warning: cannot 
understand function prototype: 'struct pseudo_lock_pm_req '
arch/x86/kernel/cpu/resctrl/pseudo_lock.c:201: warning: Function 
parameter or member 'plr' not described in 'pseudo_lock_cstates_constrain'
arch/x86/kernel/cpu/resctrl/pseudo_lock.c:529: warning: Function 
parameter or member 'rdtgrp' not described in 'rdtgroup_monitor_in_progress'
arch/x86/kernel/cpu/resctrl/pseudo_lock.c:529: warning: Excess function 
parameter 'r' description in 'rdtgroup_monitor_in_progress'
arch/x86/kernel/cpu/resctrl/pseudo_lock.c:1152: warning: Function 
parameter or member 'rdtgrp' not described in 'pseudo_lock_measure_cycles'
arch/x86/kernel/cpu/resctrl/pseudo_lock.c:1152: warning: Function 
parameter or member 'sel' not described in 'pseudo_lock_measure_cycles'
$

After this patch:
$ scripts/kernel-doc -none arch/x86/kernel/cpu/resctrl/pseudo_lock.c
$

Thank you very much.

Reviewed-by: Reinette Chatre <reinette.chatre@...el.com>

Reinette