Re: [PATCH] drm/dp: Add missing description to parameter

From: Sean Paul <seanpaul@chromium.org>
To: Tomeu Vizoso <tomeu.vizoso@collabora.com>
Cc: linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org,
	Daniel Vetter <daniel.vetter@intel.com>,
	Gabriel Krisman Bertazi <krisman@collabora.co.uk>
Subject: Re: [PATCH] drm/dp: Add missing description to parameter
Date: Tue, 7 Mar 2017 17:03:15 -0500	[thread overview]
Message-ID: <20170307220315.GF20329@art_vandelay> (raw)
In-Reply-To: <20170307203511.14258-1-tomeu.vizoso@collabora.com>

On Tue, Mar 07, 2017 at 09:35:11PM +0100, Tomeu Vizoso wrote:
> Gabriel Krisman reported these warnings when building the documentation:
> 
>  ./drivers/gpu/drm/drm_dp_helper.c:1165: warning: No description found
> for parameter 'crtc'
> ./drivers/gpu/drm/drm_dp_helper.c:1166: warning: No description found
> for parameter 'crtc'
> 

I've now added htmldocs build to my pre-merge build testing so I'll hopefully
catch this earlier (no promises).

In the meantime, this has been applied to -misc

Thanks,

Sean

> Signed-off-by: Tomeu Vizoso <tomeu.vizoso@collabora.com>
> ---
>  drivers/gpu/drm/drm_dp_helper.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/gpu/drm/drm_dp_helper.c b/drivers/gpu/drm/drm_dp_helper.c
> index c40cfe2e63ab..3e5f52110ea1 100644
> --- a/drivers/gpu/drm/drm_dp_helper.c
> +++ b/drivers/gpu/drm/drm_dp_helper.c
> @@ -1158,6 +1158,7 @@ EXPORT_SYMBOL(drm_dp_psr_setup_time);
>  /**
>   * drm_dp_start_crc() - start capture of frame CRCs
>   * @aux: DisplayPort AUX channel
> + * @crtc: CRTC displaying the frames whose CRCs are to be captured
>   *
>   * Returns 0 on success or a negative error code on failure.
>   */
> -- 
> 2.9.3
> 
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel