| Message ID | 1559159944-21103-5-git-send-email-uma.shankar@intel.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Document fixes for DRM UAPI and HDR | expand |
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 >
>-----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
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 */ 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,
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(-)