linux-kernel - Re: [PATCH] KVM: arm64: nvhe: eliminate kernel-doc warnings

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]

Date:   Fri,  6 May 2022 11:16:14 +0100
From:   Marc Zyngier <maz@...nel.org>
To:     linux-kernel@...r.kernel.org, Randy Dunlap <rdunlap@...radead.org>
Cc:     kvmarm@...ts.cs.columbia.edu,
        Alexandru Elisei <alexandru.elisei@....com>,
        Suzuki K Poulose <suzuki.poulose@....com>,
        James Morse <james.morse@....com>,
        kernel test robot <lkp@...el.com>,
        linux-arm-kernel@...ts.infradead.org,
        David Brazdil <dbrazdil@...gle.com>,
        Fuad Tabba <tabba@...gle.com>
Subject: Re: [PATCH] KVM: arm64: nvhe: eliminate kernel-doc warnings

On Fri, 29 Apr 2022 22:01:23 -0700, Randy Dunlap wrote:
> Don't use begin-kernel-doc notation (/**) for comments that are not in
> kernel-doc format.
> 
> This prevents these kernel-doc warnings:
> 
> arch/arm64/kvm/hyp/nvhe/switch.c:126: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Disable host events, enable guest events
> arch/arm64/kvm/hyp/nvhe/switch.c:146: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Disable guest events, enable host events
> arch/arm64/kvm/hyp/nvhe/switch.c:164: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Handler for protected VM restricted exceptions.
> arch/arm64/kvm/hyp/nvhe/switch.c:176: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Handler for protected VM MSR, MRS or System instruction execution in AArch64.
> arch/arm64/kvm/hyp/nvhe/switch.c:196: warning: Function parameter or member 'vcpu' not described in 'kvm_handle_pvm_fpsimd'
> arch/arm64/kvm/hyp/nvhe/switch.c:196: warning: Function parameter or member 'exit_code' not described in 'kvm_handle_pvm_fpsimd'
> arch/arm64/kvm/hyp/nvhe/switch.c:196: warning: expecting prototype for Handler for protected floating(). Prototype was for kvm_handle_pvm_fpsimd() instead

Applied to next, thanks!

[1/1] KVM: arm64: nvhe: eliminate kernel-doc warnings
      commit: bd61395ae8393f28f4b084702acd6f5f02b1f7c0

Cheers,

	M.
-- 
Without deviation from the norm, progress is not possible.