linux-kernel - [PATCH] fix member variable description warnings while building docs

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20240818112543.1089986-1-sayyad.abid16@gmail.com>
Date: Sun, 18 Aug 2024 16:55:44 +0530
From: abid-sayyad <sayyad.abid16@...il.com>
To: airlied@...il.com
Cc: daniel@...ll.ch,
	dmitry.baryshkov@...aro.org,
	mripard@...nel.org,
	ankit.k.nautiyal@...el.com,
	jani.nikula@...el.com,
	imre.deak@...el.com,
	mitulkumar.ajitkumar.golani@...el.com,
	quic_abhinavk@...cinc.com,
	dianders@...omium.org,
	marilene.agarcia@...il.com,
	dri-devel@...ts.freedesktop.org,
	linux-kernel@...r.kernel.org,
	tytso@....edu,
	jack@...e.com,
	linux-ext4@...r.kernel.org,
	skhan@...uxfoundation.org,
	abid-sayyad <sayyad.abid16@...il.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@...il.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