Re: [PATCH 4/4] video/hdmi: Dropped static functions from kernel doc

From: "Shankar, Uma" <uma.shankar@intel.com>
To: Daniel Vetter <daniel@ffwll.ch>
Cc: "dcastagna@chromium.org" <dcastagna@chromium.org>,
	"jonas@kwiboo.se" <jonas@kwiboo.se>,
	"intel-gfx@lists.freedesktop.org"
	<intel-gfx@lists.freedesktop.org>,
	"dri-devel@lists.freedesktop.org"
	<dri-devel@lists.freedesktop.org>,
	"seanpaul@chromium.org" <seanpaul@chromium.org>
Subject: Re: [PATCH 4/4] video/hdmi: Dropped static functions from kernel doc
Date: Mon, 3 Jun 2019 11:54:13 +0000	[thread overview]
Message-ID: <E7C9878FBA1C6D42A1CA3F62AEB6945F82035AD7@BGSMSX104.gar.corp.intel.com> (raw)
In-Reply-To: <20190603082432.GJ21222@phenom.ffwll.local>

>-----Original Message-----
>From: Daniel Vetter [mailto:daniel.vetter@ffwll.ch] On Behalf Of Daniel Vetter
>Sent: Monday, June 3, 2019 1:55 PM
>To: Shankar, Uma <uma.shankar@intel.com>
>Cc: intel-gfx@lists.freedesktop.org; dri-devel@lists.freedesktop.org;
>maarten.lankhorst@linux.intel.com; ville.syrjala@linux.intel.com; Sharma, Shashank
><shashank.sharma@intel.com>; emil.l.velikov@gmail.com; brian.starkey@arm.com;
>dcastagna@chromium.org; seanpaul@chromium.org; Roper, Matthew D
><matthew.d.roper@intel.com>; jonas@kwiboo.se; daniel@ffwll.ch
>Subject: Re: [PATCH 4/4] video/hdmi: Dropped static functions from kernel doc
>
>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.

Ok, will drop the comments from all these static functions.

Regards,
Uma Shankar

>-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