Received-SPF: pass (google.com: domain of linux-kernel+bounces-183073-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1;
Date: Sun, 19 May 2024 12:09:15 +0300
From: Dmitry Baryshkov <dmitry.baryshkov@linaro.org>
To: MarileneGarcia <marilene.agarcia@gmail.com>
Cc: David Airlie <airlied@gmail.com>, Daniel Vetter <daniel@ffwll.ch>, 
	Maxime Ripard <mripard@kernel.org>, Ankit Nautiyal <ankit.k.nautiyal@intel.com>, 
	Imre Deak <imre.deak@intel.com>, Jani Nikula <jani.nikula@intel.com>, 
	Mitul Golani <mitulkumar.ajitkumar.golani@intel.com>, Douglas Anderson <dianders@chromium.org>, 
	Abhinav Kumar <quic_abhinavk@quicinc.com>, Shuah Khan <skhan@linuxfoundation.org>, 
	Javier Carrasco <javier.carrasco.cruz@gmail.com>, "open list:DRM DRIVERS" <dri-devel@lists.freedesktop.org>, 
	open list <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH] drm/dp: Fix documentation warning
Message-ID: <5e4fs3wjlnqjmbxsu5y5rksqcjvhzwyofhrahvnypbdrgjaf4t@bzm7z4oqvtz4>
References: <20240519031027.433751-1-marilene.agarcia@gmail.com>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20240519031027.433751-1-marilene.agarcia@gmail.com>

On Sun, May 19, 2024 at 12:10:27AM -0300, MarileneGarcia wrote:
> It fixes the following warnings when
> the kernel documentation is generated:
> 
> ./include/drm/display/drm_dp_helper.h:126:
> warning: Function parameter or struct member
> 'mode' not described in 'drm_dp_as_sdp'
> 
> ./include/drm/display/drm_dp_helper.h:126:
> warning: Excess struct member 'operation_mode'
> description in 'drm_dp_as_sdp'
> 
> Signed-off-by: MarileneGarcia <marilene.agarcia@gmail.com>
> ---
> Changes:
> This documentation comment should refer to the name of the 
> variable to solve the warnings. As operation_mode is the 
> name of the enum, and the declared variable name is mode.
> 
> Thank you.
> 
>  include/drm/display/drm_dp_helper.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 


Fixes: 0bbb8f594e33 ("drm/dp: Add Adaptive Sync SDP logging")
Reviewed-by: Dmitry Baryshkov <dmitry.baryshkov@linaro.org>

-- 
With best wishes
Dmitry