| Message ID | 20211117163239.529781-1-kieran.bingham+renesas@ideasonboard.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | gpu: drm: panel-edp: Fix edp_panel_entry documentation | expand |
Hi, On Wed, Nov 17, 2021 at 8:32 AM Kieran Bingham <kieran.bingham+renesas@ideasonboard.com> wrote: > > The edp_panel_entry members 'delay' and 'name' are documented, but > without the correct syntax for kernel doc. > > This generates the following warnings: > > drivers/gpu/drm/panel/panel-edp.c:204: warning: Function parameter or member 'delay' not described in 'edp_panel_entry' > drivers/gpu/drm/panel/panel-edp.c:204: warning: Function parameter or member 'name' not described in 'edp_panel_entry' > > Fix them accordingly. > > Fixes: 5540cf8f3e8d ("drm/panel-edp: Implement generic "edp-panel"s probed by EDID") > Signed-off-by: Kieran Bingham <kieran.bingham+renesas@ideasonboard.com> > --- > drivers/gpu/drm/panel/panel-edp.c | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) Thanks! Pushed to drm-misc-next (though technically it's a fix, it didn't seem urgent enough to go through -fixes. Hopefully this is OK). 1e66f04c14ab gpu: drm: panel-edp: Fix edp_panel_entry documentation -Doug
Quoting Doug Anderson (2021-11-17 16:49:43) > Hi, > > On Wed, Nov 17, 2021 at 8:32 AM Kieran Bingham > <kieran.bingham+renesas@ideasonboard.com> wrote: > > > > The edp_panel_entry members 'delay' and 'name' are documented, but > > without the correct syntax for kernel doc. > > > > This generates the following warnings: > > > > drivers/gpu/drm/panel/panel-edp.c:204: warning: Function parameter or member 'delay' not described in 'edp_panel_entry' > > drivers/gpu/drm/panel/panel-edp.c:204: warning: Function parameter or member 'name' not described in 'edp_panel_entry' > > > > Fix them accordingly. > > > > Fixes: 5540cf8f3e8d ("drm/panel-edp: Implement generic "edp-panel"s probed by EDID") > > Signed-off-by: Kieran Bingham <kieran.bingham+renesas@ideasonboard.com> > > --- > > drivers/gpu/drm/panel/panel-edp.c | 4 ++-- > > 1 file changed, 2 insertions(+), 2 deletions(-) > > Thanks! Pushed to drm-misc-next (though technically it's a fix, it > didn't seem urgent enough to go through -fixes. Hopefully this is OK). > Certainly, I agree it's not urgent. I wasn't even sure if I should add the Fixes tag, but I figured if I left it out someone would jump in with it ;-) > 1e66f04c14ab gpu: drm: panel-edp: Fix edp_panel_entry documentation > > -Doug Thanks Kieran
diff --git a/drivers/gpu/drm/panel/panel-edp.c b/drivers/gpu/drm/panel/panel-edp.c index fc03046de134..176ef0c3cc1d 100644 --- a/drivers/gpu/drm/panel/panel-edp.c +++ b/drivers/gpu/drm/panel/panel-edp.c @@ -196,10 +196,10 @@ struct edp_panel_entry { /** @panel_id: 32-bit ID for panel, encoded with drm_edid_encode_panel_id(). */ u32 panel_id; - /* @delay: The power sequencing delays needed for this panel. */ + /** @delay: The power sequencing delays needed for this panel. */ const struct panel_delay *delay; - /* @name: Name of this panel (for printing to logs). */ + /** @name: Name of this panel (for printing to logs). */ const char *name; };
The edp_panel_entry members 'delay' and 'name' are documented, but without the correct syntax for kernel doc. This generates the following warnings: drivers/gpu/drm/panel/panel-edp.c:204: warning: Function parameter or member 'delay' not described in 'edp_panel_entry' drivers/gpu/drm/panel/panel-edp.c:204: warning: Function parameter or member 'name' not described in 'edp_panel_entry' Fix them accordingly. Fixes: 5540cf8f3e8d ("drm/panel-edp: Implement generic "edp-panel"s probed by EDID") Signed-off-by: Kieran Bingham <kieran.bingham+renesas@ideasonboard.com> --- drivers/gpu/drm/panel/panel-edp.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)