public inbox for intel-gfx@lists.freedesktop.org
 help / color / mirror / Atom feed
From: Daniel Vetter <daniel@ffwll.ch>
To: Uma Shankar <uma.shankar@intel.com>
Cc: dcastagna@chromium.org, jonas@kwiboo.se,
	intel-gfx@lists.freedesktop.org, dri-devel@lists.freedesktop.org,
	seanpaul@chromium.org
Subject: Re: [PATCH 4/4] video/hdmi: Dropped static functions from kernel doc
Date: Mon, 3 Jun 2019 10:24:32 +0200	[thread overview]
Message-ID: <20190603082432.GJ21222@phenom.ffwll.local> (raw)
In-Reply-To: <1559159944-21103-5-git-send-email-uma.shankar@intel.com>

On Thu, May 30, 2019 at 01:29:04AM +0530, Uma Shankar wrote:
> Dropped static functions from kernel documentation.
> 
> Suggested-by: Daniel Vetter <daniel@ffwll.ch>
> Signed-off-by: Uma Shankar <uma.shankar@intel.com>
> ---
>  drivers/video/hdmi.c | 32 ++++++++++++++++----------------
>  1 file changed, 16 insertions(+), 16 deletions(-)
> 
> diff --git a/drivers/video/hdmi.c b/drivers/video/hdmi.c
> index b99ba01..72c654b 100644
> --- a/drivers/video/hdmi.c
> +++ b/drivers/video/hdmi.c
> @@ -1191,11 +1191,11 @@ static const char *hdmi_nups_get_name(enum hdmi_nups nups)
>  	return "Invalid";
>  }
>  
> -/**
> +/*
>   * hdmi_avi_infoframe_log() - log info of HDMI AVI infoframe
> - * @level: logging level
> - * @dev: device
> - * @frame: HDMI AVI infoframe
> + * level: logging level
> + * dev: device
> + * frame: HDMI AVI infoframe
>   */
>  static void hdmi_avi_infoframe_log(const char *level,
>  				   struct device *dev,
> @@ -1268,11 +1268,11 @@ static const char *hdmi_spd_sdi_get_name(enum hdmi_spd_sdi sdi)
>  	return "Reserved";
>  }
>  
> -/**
> +/*
>   * hdmi_spd_infoframe_log() - log info of HDMI SPD infoframe
> - * @level: logging level
> - * @dev: device
> - * @frame: HDMI SPD infoframe
> + * level: logging level
> + * dev: device
> + * frame: HDMI SPD infoframe
>   */

For internal functions I think there's not really any value in documenting
this. The variable names are obvious enough. Imo better to ditch this
outright.
-Daniel

>  static void hdmi_spd_infoframe_log(const char *level,
>  				   struct device *dev,
> @@ -1404,11 +1404,11 @@ static void hdmi_spd_infoframe_log(const char *level,
>  	return "Reserved";
>  }
>  
> -/**
> +/*
>   * hdmi_audio_infoframe_log() - log info of HDMI AUDIO infoframe
> - * @level: logging level
> - * @dev: device
> - * @frame: HDMI AUDIO infoframe
> + * level: logging level
> + * dev: device
> + * frame: HDMI AUDIO infoframe
>   */
>  static void hdmi_audio_infoframe_log(const char *level,
>  				     struct device *dev,
> @@ -1437,11 +1437,11 @@ static void hdmi_audio_infoframe_log(const char *level,
>  			frame->downmix_inhibit ? "Yes" : "No");
>  }
>  
> -/**
> +/*
>   * hdmi_drm_infoframe_log() - log info of HDMI DRM infoframe
> - * @level: logging level
> - * @dev: device
> - * @frame: HDMI DRM infoframe
> + * level: logging level
> + * dev: device
> + * frame: HDMI DRM infoframe
>   */
>  static void hdmi_drm_infoframe_log(const char *level,
>  				   struct device *dev,
> -- 
> 1.9.1
> 

-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
_______________________________________________
Intel-gfx mailing list
Intel-gfx@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/intel-gfx

  reply	other threads:[~2019-06-03  8:24 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-05-29 19:59 [PATCH 0/4] Document fixes for DRM UAPI and HDR Uma Shankar
2019-05-29 19:59 ` [PATCH 1/4] drm: Drop a redundant unused variable Uma Shankar
2019-06-03  8:12   ` Daniel Vetter
2019-06-03 11:52     ` Shankar, Uma
2019-05-29 19:59 ` [PATCH 2/4] drm: Fix docbook warnings in hdr metadata helper structures Uma Shankar
2019-06-03  8:23   ` Daniel Vetter
2019-06-03 12:01     ` Shankar, Uma
2019-06-04 11:17     ` [v3 2/3] " Uma Shankar
2019-05-29 19:59 ` [PATCH 3/4] drm: Fixed doc warnings in drm uapi header Uma Shankar
2019-06-03  8:26   ` Daniel Vetter
2019-06-03 11:53     ` Shankar, Uma
2019-05-29 19:59 ` [PATCH 4/4] video/hdmi: Dropped static functions from kernel doc Uma Shankar
2019-06-03  8:24   ` Daniel Vetter [this message]
2019-06-03 11:54     ` Shankar, Uma
2019-05-29 20:35 ` ✓ Fi.CI.BAT: success for Document fixes for DRM UAPI and HDR Patchwork
2019-05-30  6:46 ` ✓ Fi.CI.IGT: " Patchwork
2019-05-31  8:02 ` ✓ Fi.CI.BAT: " Patchwork
2019-05-31 16:24 ` ✓ Fi.CI.IGT: " Patchwork

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=20190603082432.GJ21222@phenom.ffwll.local \
    --to=daniel@ffwll.ch \
    --cc=dcastagna@chromium.org \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=intel-gfx@lists.freedesktop.org \
    --cc=jonas@kwiboo.se \
    --cc=seanpaul@chromium.org \
    --cc=uma.shankar@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