Re: [Intel-gfx] [PATCH 1/2] drm/edid: fix kernel-doc parameter name mismatches

[Jani Nikula <jani.nikula@intel.com>]

On Tue, 26 Apr 2022, Jani Nikula <jani.nikula@intel.com> wrote:
> Fix the below drm/edid kernel-doc warnings:
>
> drivers/gpu/drm/drm_edid.c:1589: warning: Function parameter or member '_edid' not described in 'drm_edid_header_is_valid'
> drivers/gpu/drm/drm_edid.c:1589: warning: Excess function parameter 'raw_edid' description in 'drm_edid_header_is_valid'
> drivers/gpu/drm/drm_edid.c:1737: warning: Function parameter or member '_block' not described in 'drm_edid_block_valid'
> drivers/gpu/drm/drm_edid.c:1737: warning: Excess function parameter 'raw_edid' description in 'drm_edid_block_valid'
> drivers/gpu/drm/drm_edid.c:2136: warning: Function parameter or member 'read_block' not described in 'drm_do_get_edid'
> drivers/gpu/drm/drm_edid.c:2136: warning: Function parameter or member 'context' not described in 'drm_do_get_edid'
> drivers/gpu/drm/drm_edid.c:2136: warning: Excess function parameter 'get_edid_block' description in 'drm_do_get_edid'
> drivers/gpu/drm/drm_edid.c:2136: warning: Excess function parameter 'data' description in 'drm_do_get_edid'
>
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> References: https://lore.kernel.org/r/20220406154431.567414c3@canb.auug.org.au
> References: https://lore.kernel.org/r/20220420162431.2b28ddea@canb.auug.org.au
> Signed-off-by: Jani Nikula <jani.nikula@intel.com>

Pushed both to drm-misc-next with Simon's irc r-b. Thanks for the report
& review.

BR,
Jani.

> ---
>  drivers/gpu/drm/drm_edid.c | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/gpu/drm/drm_edid.c b/drivers/gpu/drm/drm_edid.c
> index 7a8482b75071..6446f5d3944b 100644
> --- a/drivers/gpu/drm/drm_edid.c
> +++ b/drivers/gpu/drm/drm_edid.c
> @@ -1610,7 +1610,7 @@ static void edid_header_fix(void *edid)
>  
>  /**
>   * drm_edid_header_is_valid - sanity check the header of the base EDID block
> - * @raw_edid: pointer to raw base EDID block
> + * @_edid: pointer to raw base EDID block
>   *
>   * Sanity check the header of the base EDID block.
>   *
> @@ -1827,7 +1827,7 @@ static void edid_block_dump(const char *level, const void *block, int block_num)
>  
>  /**
>   * drm_edid_block_valid - Sanity check the EDID block (base or extension)
> - * @raw_edid: pointer to raw EDID block
> + * @_block: pointer to raw EDID block
>   * @block_num: type of block to validate (0 for base, extension otherwise)
>   * @print_bad_edid: if true, dump bad EDID blocks to the console
>   * @edid_corrupt: if true, the header or checksum is invalid
> @@ -2112,8 +2112,8 @@ static enum edid_block_status edid_block_read(void *block, unsigned int block_nu
>  /**
>   * drm_do_get_edid - get EDID data using a custom EDID block read function
>   * @connector: connector we're probing
> - * @get_edid_block: EDID block read function
> - * @data: private data passed to the block read function
> + * @read_block: EDID block read function
> + * @context: private data passed to the block read function
>   *
>   * When the I2C adapter connected to the DDC bus is hidden behind a device that
>   * exposes a different interface to read EDID blocks this function can be used

-- 
Jani Nikula, Intel Open Source Graphics Center