Skip to contentSkip to conversation

drm/amd/display: adds kernel-doc comment for dc_stream_remove_writeback()

PATCH RESEND Superseded James Flowers 2 participants 3 messages May 1, 2025 – May 3, 2025

Subsystems (3)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH RESEND 1/1 drm/amd/display: adds kernel-doc comment for dc_stream_remove_writeback()

Adds a kernel-doc for externally linked dc_stream_remove_writeback() function.

---
 drivers/gpu/drm/amd/display/dc/core/dc_stream.c | 8 ++++++++
 1 file changed, 8 insertions(+)
drivers/gpu/drm/amd/display/dc/core/dc_stream.c +8 -0
index 0478dd856d8c..060ee6c3fc2e 100644
@@ -552,6 +552,14 @@ bool dc_stream_fc_disable_writeback(struct dc *dc,
 	return true;
 }
 
+/**
+ * dc_stream_remove_writeback() - Disables writeback and removes writeback info.
+ * @dc: Display core control structure.
+ * @stream: Display core stream state.
+ * @dwb_pipe_inst: Display writeback pipe.
+ *
+ * Return: returns true on success, false otherwise. 
+ */
 bool dc_stream_remove_writeback(struct dc *dc,
 		struct dc_stream_state *stream,
 		uint32_t dwb_pipe_inst)
Signature · 1 line
2.49.0
#1 lore raw

Hi James,

checkpatch reports the following warning and error

WARNING: Prefer a maximum 75 chars per line (possible unwrapped commit description?) #18:
Adds a kernel-doc for externally linked dc_stream_remove_writeback() function.

ERROR: trailing whitespace
#39: FILE: drivers/gpu/drm/amd/display/dc/core/dc_stream.c:561:
+ * Return: returns true on success, false otherwise. $

total: 1 errors, 1 warnings, 14 lines checked

Quoted 26 lines · James Flowers

Adds a kernel-doc for externally linked dc_stream_remove_writeback() function.

---
  drivers/gpu/drm/amd/display/dc/core/dc_stream.c | 8 ++++++++
  1 file changed, 8 insertions(+)
drivers/gpu/drm/amd/display/dc/core/dc_stream.c +8 -0
index 0478dd856d8c..060ee6c3fc2e 100644
@@ -552,6 +552,14 @@ bool dc_stream_fc_disable_writeback(struct dc *dc,
  	return true;
  }
 
+/**
+ * dc_stream_remove_writeback() - Disables writeback and removes writeback info.
+ * @dc: Display core control structure.
+ * @stream: Display core stream state.
+ * @dwb_pipe_inst: Display writeback pipe.
+ *
+ * Return: returns true on success, false otherwise.
+ */
  bool dc_stream_remove_writeback(struct dc *dc,
  		struct dc_stream_state *stream,
  		uint32_t dwb_pipe_inst)
author
#2 lore raw
Quoted 33 lines · Alex Hung

Hi James,

checkpatch reports the following warning and error

WARNING: Prefer a maximum 75 chars per line (possible unwrapped commit description?)
#18:
Adds a kernel-doc for externally linked dc_stream_remove_writeback() function.

ERROR: trailing whitespace
#39: FILE: drivers/gpu/drm/amd/display/dc/core/dc_stream.c:561:
+ * Return: returns true on success, false otherwise. $

total: 1 errors, 1 warnings, 14 lines checked

Quoted 15 lines · James Flowers

Adds a kernel-doc for externally linked dc_stream_remove_writeback() function.

---
  drivers/gpu/drm/amd/display/dc/core/dc_stream.c | 8 ++++++++
  1 file changed, 8 insertions(+)
drivers/gpu/drm/amd/display/dc/core/dc_stream.c +0 -0
index 0478dd856d8c..060ee6c3fc2e 100644
@@ -552,6 +552,14 @@ bool dc_stream_fc_disable_writeback(struct dc *dc,
  	return true;
  }
 
Quoted 11 lines

drivers/gpu/drm/amd/display/dc/core/dc_stream.c bool dc_stream_fc_disable_writeback(struct dc *dc, · line 565

Quoted 11 lines
drivers/gpu/drm/amd/display/dc/core/dc_stream.c +8 -0
+/**
+ * dc_stream_remove_writeback() - Disables writeback and removes writeback info.
+ * @dc: Display core control structure.
+ * @stream: Display core stream state.
+ * @dwb_pipe_inst: Display writeback pipe.
+ *
+ * Return: returns true on success, false otherwise.
+ */
  bool dc_stream_remove_writeback(struct dc *dc,
  		struct dc_stream_state *stream,
  		uint32_t dwb_pipe_inst)

Thank you Alex, and sorry about that. I will correct those issues and submit a new version.