From: Alissa Guo <guoalissa@gmail.com>
To: skhan@linuxfoundation.org, akpm@linux-foundation.org,
gregkh@linuxfoundation.org, brauner@kernel.org, kuba@kernel.org
Cc: Alissa Guo <guoalissa@gmail.com>, linux-kernel@vger.kernel.org
Subject: [PATCH] documentation: key header files: fix member variable description warnings
Date: Wed, 31 Jul 2024 17:51:38 -0700 [thread overview]
Message-ID: <20240801005206.126984-2-guoalissa@gmail.com> (raw)
In-Reply-To: <20240731043609.9762-1-guoalissa@gmail.com>
Fix the following documentation compilation warnings from missing member variable descriptions when 'make htmldocs' is called:
Fixed misspelling of @j_transaction_overhead to @j_transaction_overhead_buffers in ./include/linux/jbd2.h:1303
Add description of 'target_rr_divider' in ./include/drm/display/drm_dp_helper.h
Add description of 'width' and 'height' in struct 'drm_plane_size_hint' in ./include/uapi/drm/drm_mode.h
Effects:
The following warnings should no longer arise upon 'make htmldocs'
./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'
./include/drm/display/drm_dp_helper.h:127: warning: Function parameter or struct member 'target_rr_divider' not described in 'drm_dp_as_sdp'
./include/uapi/drm/drm_mode.h:869: warning: Function parameter or struct member 'width' not described in 'drm_plane_size_hint'
./include/uapi/drm/drm_mode.h:869: warning: Function parameter or struct member 'height' not described in 'drm_plane_size_hint'
Signed-off-by: Alissa Guo <guoalissa@gmail.com>
---
include/drm/display/drm_dp_helper.h | 1 +
include/linux/jbd2.h | 2 +-
include/uapi/drm/drm_mode.h | 6 ++++++
3 files changed, 8 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
*/
diff --git a/include/uapi/drm/drm_mode.h b/include/uapi/drm/drm_mode.h
index d390011b89b4..c61b72bc04a6 100644
--- a/include/uapi/drm/drm_mode.h
+++ b/include/uapi/drm/drm_mode.h
@@ -864,7 +864,13 @@ struct drm_color_lut {
* array of struct drm_plane_size_hint.
*/
struct drm_plane_size_hint {
+ /**
+ * @width: Desired horizontal size of the plane in pixels
+ */
__u16 width;
+ /**
+ * @height: Desired vertical size of the plane in pixels
+ */
__u16 height;
};
--
2.43.0
next prev parent reply other threads:[~2024-08-01 0:52 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-07-31 4:35 [PATCH] documentation: key header files: fix member variable description warnings Alissa Guo
2024-07-31 5:30 ` Greg KH
2024-08-01 0:51 ` Alissa Guo [this message]
2024-08-01 17:42 ` Shuah Khan
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240801005206.126984-2-guoalissa@gmail.com \
--to=guoalissa@gmail.com \
--cc=akpm@linux-foundation.org \
--cc=brauner@kernel.org \
--cc=gregkh@linuxfoundation.org \
--cc=kuba@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=skhan@linuxfoundation.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox