Re: [PATCH 10/10] drm/amdgpu: re-format file header comments

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Tue, Dec 7, 2021 at 10:17 PM Isabella Basso <isabbasso@xxxxxxxxxx> wrote:
>
> Fix the warning below by switching header comments to be more aligned
> with AMD's docstrings:
>
>  warning: Cannot understand  * \file amdgpu_ioc32.c
>  on line 2 - I thought it was a doc line
>
> Signed-off-by: Isabella Basso <isabbasso@xxxxxxxxxx>
> ---
>  drivers/gpu/drm/amd/amdgpu/amdgpu_ioc32.c | 16 +++++++++-------
>  1 file changed, 9 insertions(+), 7 deletions(-)
>
> diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_ioc32.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_ioc32.c
> index 5cf142e849bb..cde5294056cb 100644
> --- a/drivers/gpu/drm/amd/amdgpu/amdgpu_ioc32.c
> +++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_ioc32.c
> @@ -1,10 +1,4 @@
> -/**

Might be better to just remove the second * above and convert this to
a regular comment.  I'm not sure the DOC section really provides much
value.

Alex

> - * \file amdgpu_ioc32.c
> - *
> - * 32-bit ioctl compatibility routines for the AMDGPU DRM.
> - *
> - * \author Paul Mackerras <paulus@xxxxxxxxx>
> - *
> +/*
>   * Copyright (C) Paul Mackerras 2005
>   * All Rights Reserved.
>   *
> @@ -26,6 +20,14 @@
>   * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
>   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
>   * IN THE SOFTWARE.
> + *
> + * Author: Paul Mackerras <paulus@xxxxxxxxx>
> + */
> +
> +/**
> + * DOC: amdgpu_ioc32
> + *
> + * 32-bit ioctl compatibility routines for the AMDGPU DRM.
>   */
>  #include <linux/compat.h>
>
> --
> 2.34.1
>



[Index of Archives]     [Linux USB Devel]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]

  Powered by Linux