Re: [PATCH] drm/edid: Fix drm_edid_encode_panel_id() kerneldoc warning

[Randy Dunlap]

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@xxxxxxxxxxxxxxxx>
> Signed-off-by: Douglas Anderson <dianders@xxxxxxxxxxxx>

Acked-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

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