AMD-GFX Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: "André Almeida" <andrealmeid@igalia.com>
To: Alex Deucher <alexander.deucher@amd.com>
Cc: kernel test robot <lkp@intel.com>, amd-gfx@lists.freedesktop.org
Subject: Re: [PATCH 1/2] drm/amd/display: fix comment format
Date: Tue, 12 Jul 2022 11:40:59 -0300	[thread overview]
Message-ID: <541e256f-0ca0-d2fa-18ef-b31cdb48e5b2@igalia.com> (raw)
In-Reply-To: <20220712143159.2700970-1-alexander.deucher@amd.com>

Hi Alex,

Às 11:31 de 12/07/22, Alex Deucher escreveu:
> This is not a compliant kerneldoc comment, so make it just
> a regular comment.
> 
> Reported-by: kernel test robot <lkp@intel.com>
> Signed-off-by: Alex Deucher <alexander.deucher@amd.com>
> ---
>  drivers/gpu/drm/amd/display/dc/dcn314/dcn314_optc.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/gpu/drm/amd/display/dc/dcn314/dcn314_optc.c b/drivers/gpu/drm/amd/display/dc/dcn314/dcn314_optc.c
> index c4a5f8198209..436c3545a983 100644
> --- a/drivers/gpu/drm/amd/display/dc/dcn314/dcn314_optc.c
> +++ b/drivers/gpu/drm/amd/display/dc/dcn314/dcn314_optc.c
> @@ -42,7 +42,7 @@
>  #define FN(reg_name, field_name) \
>  	optc1->tg_shift->field_name, optc1->tg_mask->field_name
>  
> -/**
> +/*
>   * Enable CRTC
>   * Enable CRTC - call ASIC Control Object to enable Timing generator.
>   */

This comment is placed in a random part of the file, the proper fix it
would be to place it above the function that it's describing:

static bool optc314_enable_crtc(struct timing_generator *optc)

There it could even be a correct kerneldoc comment, fixed the function
name and adding the argument description.

  parent reply	other threads:[~2022-07-12 14:41 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-12 14:31 [PATCH 1/2] drm/amd/display: fix comment format Alex Deucher
2022-07-12 14:31 ` [PATCH 2/2] drm/amd/display: make to_dal_irq_source_dcn314 static Alex Deucher
2022-07-12 15:28   ` Harry Wentland
2022-07-12 14:40 ` André Almeida [this message]
2022-07-12 15:33 ` [PATCH 1/2] drm/amd/display: fix comment format Christian König

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=541e256f-0ca0-d2fa-18ef-b31cdb48e5b2@igalia.com \
    --to=andrealmeid@igalia.com \
    --cc=alexander.deucher@amd.com \
    --cc=amd-gfx@lists.freedesktop.org \
    --cc=lkp@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox