linux-kernel - Re: [PATCH 01/25] Documentation: amdgpu_device

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: <20200717130653.347d2f20@lwn.net>
Date:   Fri, 17 Jul 2020 13:06:53 -0600
From:   Jonathan Corbet <corbet@....net>
To:     "Daniel W. S. Almeida" <dwlsalmeida@...il.com>
Cc:     mchehab@...nel.org, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH 01/25] Documentation: amdgpu_device_suspend: Fix sphinx
 warning

On Fri, 17 Jul 2020 15:56:00 -0300
"Daniel W. S. Almeida" <dwlsalmeida@...il.com> wrote:

> From: "Daniel W. S. Almeida" <dwlsalmeida@...il.com>
> 
> Fix this warning:
> 
> warning: Excess function parameter 'suspend' description in
> 'amdgpu_device_suspend'
> 
> Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@...il.com>
> ---
>  drivers/gpu/drm/amd/amdgpu/amdgpu_device.c | 1 -
>  1 file changed, 1 deletion(-)
> 
> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c
> index a027a8f7b2819..9e67abe8d0aad 100644
> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c
> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c
> @@ -3377,7 +3377,6 @@ void amdgpu_device_fini(struct amdgpu_device *adev)
>   * amdgpu_device_suspend - initiate device suspend
>   *
>   * @dev: drm dev pointer
> - * @suspend: suspend state
>   * @fbcon : notify the fbdev of suspend

Thanks for working to improve the docs build!  I do have a couple of
requests, though:

 - Use get_maintainer.pl to create a proper list of recipients for your
   patches.  Neither Mauro nor I should be applying patches to the DRM
   subsystem.

 - Please work on your subject lines; "fix warning" is rarely useful.
   What you have done here is to correct a kerneldoc comment, so the
   subject line should say "remove excess parameter in kerneldoc comment"
   or some such.  Also look at commits in the DRM subsystem and try to
   follow their conventions in general.

Those comments apply in similar form to the rest of the patches as well.

Thanks,

jon