fix member variable description warnings while building docs

[PATCH] fix member variable description warnings while building docs

Posted by abid-sayyad 1 year, 5 months ago

Fix the following warnings while building the docs :-

./include/linux/jbd2.h:1303: warning: Function parameter or struct member
		'j_transaction_overhead_buffers' not described in 'journal_s'
./include/linux/jbd2.h:1303: warning: Excess struct member
		'j_transaction_overhead' description in 'journal_s'

Fix spelling error for j_transaction_overhead to j_transaction_overhead_buffers.

./include/drm/display/drm_dp_helper.h:127: warning: Function parameter or struct
		member 'target_rr_divider' not described in 'drm_dp_as_sdp'

Add description for the 'target_rr_divider' member.

Signed-off-by: abid-sayyad <sayyad.abid16@gmail.com>
---
 include/drm/display/drm_dp_helper.h | 1 +
 include/linux/jbd2.h                | 2 +-
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/include/drm/display/drm_dp_helper.h b/include/drm/display/drm_dp_helper.h
index ea03e1dd26ba..7f2567fa230d 100644
--- a/include/drm/display/drm_dp_helper.h
+++ b/include/drm/display/drm_dp_helper.h
@@ -112,6 +112,7 @@ struct drm_dp_vsc_sdp {
  * @target_rr: Target Refresh
  * @duration_incr_ms: Successive frame duration increase
  * @duration_decr_ms: Successive frame duration decrease
+ * @target_rr_divider: Target refresh rate divider
  * @mode: Adaptive Sync Operation Mode
  */
 struct drm_dp_as_sdp {
diff --git a/include/linux/jbd2.h b/include/linux/jbd2.h
index 5157d92b6f23..17662eae408f 100644
--- a/include/linux/jbd2.h
+++ b/include/linux/jbd2.h
@@ -1086,7 +1086,7 @@ struct journal_s
 	int			j_revoke_records_per_block;

 	/**
-	 * @j_transaction_overhead:
+	 * @j_transaction_overhead_buffers:
 	 *
 	 * Number of blocks each transaction needs for its own bookkeeping
 	 */
--
2.39.2

RE: [PATCH] fix member variable description warnings while building docs

Posted by Golani, Mitulkumar Ajitkumar 1 year, 5 months ago

Hi @abid-sayyad

> -----Original Message-----
> From: abid-sayyad <sayyad.abid16@gmail.com>
> Sent: Sunday, August 18, 2024 4:56 PM
> To: airlied@gmail.com
> Cc: daniel@ffwll.ch; dmitry.baryshkov@linaro.org; mripard@kernel.org;
> Nautiyal, Ankit K <ankit.k.nautiyal@intel.com>; Nikula, Jani
> <jani.nikula@intel.com>; Deak, Imre <imre.deak@intel.com>; Golani,
> Mitulkumar Ajitkumar <mitulkumar.ajitkumar.golani@intel.com>;
> quic_abhinavk@quicinc.com; dianders@chromium.org;
> marilene.agarcia@gmail.com; dri-devel@lists.freedesktop.org; linux-
> kernel@vger.kernel.org; tytso@mit.edu; jack@suse.com; linux-
> ext4@vger.kernel.org; skhan@linuxfoundation.org; abid-sayyad
> <sayyad.abid16@gmail.com>
> Subject: [PATCH] fix member variable description warnings while building
> docs
> 
> Fix the following warnings while building the docs :-
> 
> ./include/linux/jbd2.h:1303: warning: Function parameter or struct member
> 		'j_transaction_overhead_buffers' not described in 'journal_s'
> ./include/linux/jbd2.h:1303: warning: Excess struct member
> 		'j_transaction_overhead' description in 'journal_s'
> 
> Fix spelling error for j_transaction_overhead to
> j_transaction_overhead_buffers.
> 
> ./include/drm/display/drm_dp_helper.h:127: warning: Function parameter or
> struct
> 		member 'target_rr_divider' not described in 'drm_dp_as_sdp'
> 
> Add description for the 'target_rr_divider' member.
> 
> Signed-off-by: abid-sayyad <sayyad.abid16@gmail.com>
> ---
>  include/drm/display/drm_dp_helper.h | 1 +
>  include/linux/jbd2.h                | 2 +-
>  2 files changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/include/drm/display/drm_dp_helper.h
> b/include/drm/display/drm_dp_helper.h
> index ea03e1dd26ba..7f2567fa230d 100644
> --- a/include/drm/display/drm_dp_helper.h
> +++ b/include/drm/display/drm_dp_helper.h
> @@ -112,6 +112,7 @@ struct drm_dp_vsc_sdp {
>   * @target_rr: Target Refresh
>   * @duration_incr_ms: Successive frame duration increase
>   * @duration_decr_ms: Successive frame duration decrease
> + * @target_rr_divider: Target refresh rate divider

This change is merged to drm-tip as part of following commit
a755947e050b8751fc5402609a7d600e9c756fa7

>   * @mode: Adaptive Sync Operation Mode
>   */
>  struct drm_dp_as_sdp {
> diff --git a/include/linux/jbd2.h b/include/linux/jbd2.h index
> 5157d92b6f23..17662eae408f 100644
> --- a/include/linux/jbd2.h
> +++ b/include/linux/jbd2.h
> @@ -1086,7 +1086,7 @@ struct journal_s
>  	int			j_revoke_records_per_block;
> 
>  	/**
> -	 * @j_transaction_overhead:
> +	 * @j_transaction_overhead_buffers:
>  	 *
>  	 * Number of blocks each transaction needs for its own bookkeeping
>  	 */
> --
> 2.39.2

Re: [PATCH] fix member variable description warnings while building docs

Posted by Jani Nikula 1 year, 5 months ago

On Sun, 18 Aug 2024, abid-sayyad <sayyad.abid16@gmail.com> wrote:
> Fix the following warnings while building the docs :-
>
> ./include/linux/jbd2.h:1303: warning: Function parameter or struct member
> 		'j_transaction_overhead_buffers' not described in 'journal_s'
> ./include/linux/jbd2.h:1303: warning: Excess struct member
> 		'j_transaction_overhead' description in 'journal_s'
>
> Fix spelling error for j_transaction_overhead to j_transaction_overhead_buffers.
>
> ./include/drm/display/drm_dp_helper.h:127: warning: Function parameter or struct
> 		member 'target_rr_divider' not described in 'drm_dp_as_sdp'
>
> Add description for the 'target_rr_divider' member.

Please send the two separately. They are part of two completely
different subsystems.

BR,
Jani.

>
> Signed-off-by: abid-sayyad <sayyad.abid16@gmail.com>
> ---
>  include/drm/display/drm_dp_helper.h | 1 +
>  include/linux/jbd2.h                | 2 +-
>  2 files changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/include/drm/display/drm_dp_helper.h b/include/drm/display/drm_dp_helper.h
> index ea03e1dd26ba..7f2567fa230d 100644
> --- a/include/drm/display/drm_dp_helper.h
> +++ b/include/drm/display/drm_dp_helper.h
> @@ -112,6 +112,7 @@ struct drm_dp_vsc_sdp {
>   * @target_rr: Target Refresh
>   * @duration_incr_ms: Successive frame duration increase
>   * @duration_decr_ms: Successive frame duration decrease
> + * @target_rr_divider: Target refresh rate divider
>   * @mode: Adaptive Sync Operation Mode
>   */
>  struct drm_dp_as_sdp {
> diff --git a/include/linux/jbd2.h b/include/linux/jbd2.h
> index 5157d92b6f23..17662eae408f 100644
> --- a/include/linux/jbd2.h
> +++ b/include/linux/jbd2.h
> @@ -1086,7 +1086,7 @@ struct journal_s
>  	int			j_revoke_records_per_block;
>
>  	/**
> -	 * @j_transaction_overhead:
> +	 * @j_transaction_overhead_buffers:
>  	 *
>  	 * Number of blocks each transaction needs for its own bookkeeping
>  	 */
> --
> 2.39.2
>

-- 
Jani Nikula, Intel