diff mbox series

drm/panel: Fix sphinx warning

Message ID 20180815203833.210143-1-sean@poorly.run (mailing list archive)
State New, archived
Headers show
Series drm/panel: Fix sphinx warning | expand

Commit Message

Sean Paul Aug. 15, 2018, 8:38 p.m. UTC
From: Sean Paul <seanpaul@chromium.org>

Resolves the following warnings.
../drivers/gpu/drm/drm_panel.c:158: WARNING: Unexpected indentation.
../drivers/gpu/drm/drm_panel.c:159: WARNING: Block quote ends without a blank line; unexpected unindent.

Fixes: 83127f67e450 ("drm/panel: Flesh out kerneldoc")
Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
Cc: Thierry Reding <thierry.reding@gmail.com>
Cc: Jyri Sarha <jsarha@ti.com>
Signed-off-by: Sean Paul <seanpaul@chromium.org>
---
 drivers/gpu/drm/drm_panel.c | 2 ++
 1 file changed, 2 insertions(+)

Comments

Daniel Vetter Aug. 16, 2018, 7:29 a.m. UTC | #1
On Wed, Aug 15, 2018 at 04:38:28PM -0400, Sean Paul wrote:
> From: Sean Paul <seanpaul@chromium.org>
> 
> Resolves the following warnings.
> ../drivers/gpu/drm/drm_panel.c:158: WARNING: Unexpected indentation.
> ../drivers/gpu/drm/drm_panel.c:159: WARNING: Block quote ends without a blank line; unexpected unindent.
> 
> Fixes: 83127f67e450 ("drm/panel: Flesh out kerneldoc")
> Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
> Cc: Thierry Reding <thierry.reding@gmail.com>
> Cc: Jyri Sarha <jsarha@ti.com>
> Signed-off-by: Sean Paul <seanpaul@chromium.org>

I was sitting on this fix since a while, but forgot to send it out :-/

You picked the wrong culprit though, the issue is with the enumeration
formatting below:

Fixes: c59eb3cfde1f ("drm/panel: Let of_drm_find_panel() return -ENODEV when the panel is disabled")
Cc: Boris Brezillon <boris.brezillon@bootlin.com>

With that adjusted: Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>

> ---
>  drivers/gpu/drm/drm_panel.c | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/drivers/gpu/drm/drm_panel.c b/drivers/gpu/drm/drm_panel.c
> index b902361dee6e..0db486d10d1c 100644
> --- a/drivers/gpu/drm/drm_panel.c
> +++ b/drivers/gpu/drm/drm_panel.c
> @@ -152,7 +152,9 @@ EXPORT_SYMBOL(drm_panel_detach);
>   *
>   * Return: A pointer to the panel registered for the specified device tree
>   * node or an ERR_PTR() if no panel matching the device tree node can be found.
> + *
>   * Possible error codes returned by this function:
> + *
>   * - EPROBE_DEFER: the panel device has not been probed yet, and the caller
>   *   should retry later
>   * - ENODEV: the device is not available (status != "okay" or "ok")
> -- 
> Sean Paul, Software Engineer, Google / Chromium OS
>
Thierry Reding Aug. 16, 2018, 9:24 a.m. UTC | #2
On Wed, Aug 15, 2018 at 04:38:28PM -0400, Sean Paul wrote:
> From: Sean Paul <seanpaul@chromium.org>
> 
> Resolves the following warnings.
> ../drivers/gpu/drm/drm_panel.c:158: WARNING: Unexpected indentation.
> ../drivers/gpu/drm/drm_panel.c:159: WARNING: Block quote ends without a blank line; unexpected unindent.
> 
> Fixes: 83127f67e450 ("drm/panel: Flesh out kerneldoc")
> Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
> Cc: Thierry Reding <thierry.reding@gmail.com>
> Cc: Jyri Sarha <jsarha@ti.com>
> Signed-off-by: Sean Paul <seanpaul@chromium.org>
> ---
>  drivers/gpu/drm/drm_panel.c | 2 ++
>  1 file changed, 2 insertions(+)

Feel free to push this after addressing Daniel's comments:

Acked-by: Thierry Reding <treding@nvidia.com>
Sean Paul Aug. 16, 2018, 3:46 p.m. UTC | #3
On Thu, Aug 16, 2018 at 11:24:42AM +0200, Thierry Reding wrote:
> On Wed, Aug 15, 2018 at 04:38:28PM -0400, Sean Paul wrote:
> > From: Sean Paul <seanpaul@chromium.org>
> > 
> > Resolves the following warnings.
> > ../drivers/gpu/drm/drm_panel.c:158: WARNING: Unexpected indentation.
> > ../drivers/gpu/drm/drm_panel.c:159: WARNING: Block quote ends without a blank line; unexpected unindent.
> > 
> > Fixes: 83127f67e450 ("drm/panel: Flesh out kerneldoc")
> > Cc: Daniel Vetter <daniel.vetter@ffwll.ch>
> > Cc: Thierry Reding <thierry.reding@gmail.com>
> > Cc: Jyri Sarha <jsarha@ti.com>
> > Signed-off-by: Sean Paul <seanpaul@chromium.org>
> > ---
> >  drivers/gpu/drm/drm_panel.c | 2 ++
> >  1 file changed, 2 insertions(+)
> 
> Feel free to push this after addressing Daniel's comments:
> 
> Acked-by: Thierry Reding <treding@nvidia.com>

Pushed to -misc-next

Thanks!

Sean
diff mbox series

Patch

diff --git a/drivers/gpu/drm/drm_panel.c b/drivers/gpu/drm/drm_panel.c
index b902361dee6e..0db486d10d1c 100644
--- a/drivers/gpu/drm/drm_panel.c
+++ b/drivers/gpu/drm/drm_panel.c
@@ -152,7 +152,9 @@  EXPORT_SYMBOL(drm_panel_detach);
  *
  * Return: A pointer to the panel registered for the specified device tree
  * node or an ERR_PTR() if no panel matching the device tree node can be found.
+ *
  * Possible error codes returned by this function:
+ *
  * - EPROBE_DEFER: the panel device has not been probed yet, and the caller
  *   should retry later
  * - ENODEV: the device is not available (status != "okay" or "ok")