All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH] drm/edid: Fix drm_edid_encode_panel_id() kerneldoc warning
@ 2021-09-27 14:41 Douglas Anderson
  2021-09-27 16:18   ` Randy Dunlap
  2021-09-28  0:16   ` Doug Anderson
  0 siblings, 2 replies; 5+ messages in thread
From: Douglas Anderson @ 2021-09-27 14:41 UTC (permalink / raw)
  To: dri-devel
  Cc: Stephen Rothwell, Douglas Anderson, Daniel Vetter, David Airlie,
	Maarten Lankhorst, Maxime Ripard, Randy Dunlap, Sam Ravnborg,
	Thomas Zimmermann, linux-kernel

Due to a simple typo (apparently I can't count. It goes 0, 1, 2 and
not 0, 2, 3) we were getting a kernel doc warning that looked like
this:

include/drm/drm_edid.h:530: warning:
  Function parameter or member 'vend_chr_1' not described in 'drm_edid_encode_panel_id'
include/drm/drm_edid.h:530: warning:
  Excess function parameter 'vend_chr_3' description in 'drm_edid_encode_panel_id'

Fix it.

Fixes: 7d1be0a09fa6 ("drm/edid: Fix EDID quirk compile error on older compilers")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Douglas Anderson <dianders@chromium.org>
---

 include/drm/drm_edid.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/drm/drm_edid.h b/include/drm/drm_edid.h
index 4d17cd04fff7..18f6c700f6d0 100644
--- a/include/drm/drm_edid.h
+++ b/include/drm/drm_edid.h
@@ -511,8 +511,8 @@ static inline u8 drm_eld_get_conn_type(const uint8_t *eld)
 /**
  * drm_edid_encode_panel_id - Encode an ID for matching against drm_edid_get_panel_id()
  * @vend_chr_0: First character of the vendor string.
- * @vend_chr_2: Second character of the vendor string.
- * @vend_chr_3: Third character of the vendor string.
+ * @vend_chr_1: Second character of the vendor string.
+ * @vend_chr_2: Third character of the vendor string.
  * @product_id: The 16-bit product ID.
  *
  * This is a macro so that it can be calculated at compile time and used
-- 
2.33.0.685.g46640cef36-goog


^ permalink raw reply related	[flat|nested] 5+ messages in thread

* Re: [PATCH] drm/edid: Fix drm_edid_encode_panel_id() kerneldoc warning
  2021-09-27 14:41 [PATCH] drm/edid: Fix drm_edid_encode_panel_id() kerneldoc warning Douglas Anderson
@ 2021-09-27 16:18   ` Randy Dunlap
  2021-09-28  0:16   ` Doug Anderson
  1 sibling, 0 replies; 5+ messages in thread
From: Randy Dunlap @ 2021-09-27 16:18 UTC (permalink / raw)
  To: Douglas Anderson, dri-devel
  Cc: Stephen Rothwell, Daniel Vetter, David Airlie, Maarten Lankhorst,
	Maxime Ripard, Sam Ravnborg, Thomas Zimmermann, linux-kernel

On 9/27/21 7:41 AM, Douglas Anderson wrote:
> Due to a simple typo (apparently I can't count. It goes 0, 1, 2 and
> not 0, 2, 3) we were getting a kernel doc warning that looked like
> this:
> 
> include/drm/drm_edid.h:530: warning:
>    Function parameter or member 'vend_chr_1' not described in 'drm_edid_encode_panel_id'
> include/drm/drm_edid.h:530: warning:
>    Excess function parameter 'vend_chr_3' description in 'drm_edid_encode_panel_id'
> 
> Fix it.
> 
> Fixes: 7d1be0a09fa6 ("drm/edid: Fix EDID quirk compile error on older compilers")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Signed-off-by: Douglas Anderson <dianders@chromium.org>

Acked-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
> 
>   include/drm/drm_edid.h | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/include/drm/drm_edid.h b/include/drm/drm_edid.h
> index 4d17cd04fff7..18f6c700f6d0 100644
> --- a/include/drm/drm_edid.h
> +++ b/include/drm/drm_edid.h
> @@ -511,8 +511,8 @@ static inline u8 drm_eld_get_conn_type(const uint8_t *eld)
>   /**
>    * drm_edid_encode_panel_id - Encode an ID for matching against drm_edid_get_panel_id()
>    * @vend_chr_0: First character of the vendor string.
> - * @vend_chr_2: Second character of the vendor string.
> - * @vend_chr_3: Third character of the vendor string.
> + * @vend_chr_1: Second character of the vendor string.
> + * @vend_chr_2: Third character of the vendor string.
>    * @product_id: The 16-bit product ID.
>    *
>    * This is a macro so that it can be calculated at compile time and used
> 


-- 
~Randy

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] drm/edid: Fix drm_edid_encode_panel_id() kerneldoc warning
@ 2021-09-27 16:18   ` Randy Dunlap
  0 siblings, 0 replies; 5+ messages in thread
From: Randy Dunlap @ 2021-09-27 16:18 UTC (permalink / raw)
  To: Douglas Anderson, dri-devel
  Cc: Stephen Rothwell, Daniel Vetter, David Airlie, Maarten Lankhorst,
	Maxime Ripard, Sam Ravnborg, Thomas Zimmermann, linux-kernel

On 9/27/21 7:41 AM, Douglas Anderson wrote:
> Due to a simple typo (apparently I can't count. It goes 0, 1, 2 and
> not 0, 2, 3) we were getting a kernel doc warning that looked like
> this:
> 
> include/drm/drm_edid.h:530: warning:
>    Function parameter or member 'vend_chr_1' not described in 'drm_edid_encode_panel_id'
> include/drm/drm_edid.h:530: warning:
>    Excess function parameter 'vend_chr_3' description in 'drm_edid_encode_panel_id'
> 
> Fix it.
> 
> Fixes: 7d1be0a09fa6 ("drm/edid: Fix EDID quirk compile error on older compilers")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Signed-off-by: Douglas Anderson <dianders@chromium.org>

Acked-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
> 
>   include/drm/drm_edid.h | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/include/drm/drm_edid.h b/include/drm/drm_edid.h
> index 4d17cd04fff7..18f6c700f6d0 100644
> --- a/include/drm/drm_edid.h
> +++ b/include/drm/drm_edid.h
> @@ -511,8 +511,8 @@ static inline u8 drm_eld_get_conn_type(const uint8_t *eld)
>   /**
>    * drm_edid_encode_panel_id - Encode an ID for matching against drm_edid_get_panel_id()
>    * @vend_chr_0: First character of the vendor string.
> - * @vend_chr_2: Second character of the vendor string.
> - * @vend_chr_3: Third character of the vendor string.
> + * @vend_chr_1: Second character of the vendor string.
> + * @vend_chr_2: Third character of the vendor string.
>    * @product_id: The 16-bit product ID.
>    *
>    * This is a macro so that it can be calculated at compile time and used
> 


-- 
~Randy

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] drm/edid: Fix drm_edid_encode_panel_id() kerneldoc warning
  2021-09-27 14:41 [PATCH] drm/edid: Fix drm_edid_encode_panel_id() kerneldoc warning Douglas Anderson
@ 2021-09-28  0:16   ` Doug Anderson
  2021-09-28  0:16   ` Doug Anderson
  1 sibling, 0 replies; 5+ messages in thread
From: Doug Anderson @ 2021-09-28  0:16 UTC (permalink / raw)
  To: dri-devel
  Cc: Stephen Rothwell, Daniel Vetter, David Airlie, Maarten Lankhorst,
	Maxime Ripard, Randy Dunlap, Sam Ravnborg, Thomas Zimmermann,
	LKML

Hi,

On Mon, Sep 27, 2021 at 7:41 AM Douglas Anderson <dianders@chromium.org> wrote:
>
> Due to a simple typo (apparently I can't count. It goes 0, 1, 2 and
> not 0, 2, 3) we were getting a kernel doc warning that looked like
> this:
>
> include/drm/drm_edid.h:530: warning:
>   Function parameter or member 'vend_chr_1' not described in 'drm_edid_encode_panel_id'
> include/drm/drm_edid.h:530: warning:
>   Excess function parameter 'vend_chr_3' description in 'drm_edid_encode_panel_id'
>
> Fix it.
>
> Fixes: 7d1be0a09fa6 ("drm/edid: Fix EDID quirk compile error on older compilers")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Signed-off-by: Douglas Anderson <dianders@chromium.org>
> ---
>
>  include/drm/drm_edid.h | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)

Pushed with Randy's Ack to drm-misc-next:

116e5947d7bf drm/edid: Fix drm_edid_encode_panel_id() kerneldoc warning

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] drm/edid: Fix drm_edid_encode_panel_id() kerneldoc warning
@ 2021-09-28  0:16   ` Doug Anderson
  0 siblings, 0 replies; 5+ messages in thread
From: Doug Anderson @ 2021-09-28  0:16 UTC (permalink / raw)
  To: dri-devel
  Cc: Stephen Rothwell, Daniel Vetter, David Airlie, Maarten Lankhorst,
	Maxime Ripard, Randy Dunlap, Sam Ravnborg, Thomas Zimmermann,
	LKML

Hi,

On Mon, Sep 27, 2021 at 7:41 AM Douglas Anderson <dianders@chromium.org> wrote:
>
> Due to a simple typo (apparently I can't count. It goes 0, 1, 2 and
> not 0, 2, 3) we were getting a kernel doc warning that looked like
> this:
>
> include/drm/drm_edid.h:530: warning:
>   Function parameter or member 'vend_chr_1' not described in 'drm_edid_encode_panel_id'
> include/drm/drm_edid.h:530: warning:
>   Excess function parameter 'vend_chr_3' description in 'drm_edid_encode_panel_id'
>
> Fix it.
>
> Fixes: 7d1be0a09fa6 ("drm/edid: Fix EDID quirk compile error on older compilers")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Signed-off-by: Douglas Anderson <dianders@chromium.org>
> ---
>
>  include/drm/drm_edid.h | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)

Pushed with Randy's Ack to drm-misc-next:

116e5947d7bf drm/edid: Fix drm_edid_encode_panel_id() kerneldoc warning

^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2021-09-28  0:16 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-09-27 14:41 [PATCH] drm/edid: Fix drm_edid_encode_panel_id() kerneldoc warning Douglas Anderson
2021-09-27 16:18 ` Randy Dunlap
2021-09-27 16:18   ` Randy Dunlap
2021-09-28  0:16 ` Doug Anderson
2021-09-28  0:16   ` Doug Anderson

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.