linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH RESEND] drm/amd/display: adds kernel-doc comment for dc_stream_remove_writeback()
@ 2025-05-01  5:56 James Flowers
  2025-05-02 22:25 ` Alex Hung
  0 siblings, 1 reply; 3+ messages in thread
From: James Flowers @ 2025-05-01  5:56 UTC (permalink / raw)
  To: harry.wentland, sunpeng.li, siqueira, alexander.deucher,
	christian.koenig, airlied, simona, skhan
  Cc: James Flowers, amd-gfx, dri-devel, linux-kernel,
	linux-kernel-mentees

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

Signed-off-by: James Flowers <bold.zone2373@fastmail.com>
---
 drivers/gpu/drm/amd/display/dc/core/dc_stream.c | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/drivers/gpu/drm/amd/display/dc/core/dc_stream.c b/drivers/gpu/drm/amd/display/dc/core/dc_stream.c
index 0478dd856d8c..060ee6c3fc2e 100644
--- a/drivers/gpu/drm/amd/display/dc/core/dc_stream.c
+++ b/drivers/gpu/drm/amd/display/dc/core/dc_stream.c
@@ -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)
-- 
2.49.0


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH RESEND] drm/amd/display: adds kernel-doc comment for dc_stream_remove_writeback()
  2025-05-01  5:56 [PATCH RESEND] drm/amd/display: adds kernel-doc comment for dc_stream_remove_writeback() James Flowers
@ 2025-05-02 22:25 ` Alex Hung
  2025-05-03 18:52   ` James
  0 siblings, 1 reply; 3+ messages in thread
From: Alex Hung @ 2025-05-02 22:25 UTC (permalink / raw)
  To: James Flowers, harry.wentland, sunpeng.li, siqueira,
	alexander.deucher, christian.koenig, airlied, simona, skhan
  Cc: amd-gfx, dri-devel, linux-kernel, linux-kernel-mentees

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


On 4/30/25 23:56, James Flowers wrote:
> Adds a kernel-doc for externally linked dc_stream_remove_writeback() function.
> 
> Signed-off-by: James Flowers <bold.zone2373@fastmail.com>
> ---
>   drivers/gpu/drm/amd/display/dc/core/dc_stream.c | 8 ++++++++
>   1 file changed, 8 insertions(+)
> 
> diff --git a/drivers/gpu/drm/amd/display/dc/core/dc_stream.c b/drivers/gpu/drm/amd/display/dc/core/dc_stream.c
> index 0478dd856d8c..060ee6c3fc2e 100644
> --- a/drivers/gpu/drm/amd/display/dc/core/dc_stream.c
> +++ b/drivers/gpu/drm/amd/display/dc/core/dc_stream.c
> @@ -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)


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH RESEND] drm/amd/display: adds kernel-doc comment for dc_stream_remove_writeback()
  2025-05-02 22:25 ` Alex Hung
@ 2025-05-03 18:52   ` James
  0 siblings, 0 replies; 3+ messages in thread
From: James @ 2025-05-03 18:52 UTC (permalink / raw)
  To: Alex Hung, Harry Wentland, sunpeng.li, Rodrigo Siqueira,
	Alex Deucher, Christian König, airlied, simona, Shuah Khan
  Cc: amd-gfx, dri-devel, linux-kernel, linux-kernel-mentees


On Fri, May 2, 2025, at 3:25 PM, Alex Hung wrote:
> 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
>
>
> On 4/30/25 23:56, James Flowers wrote:
>> Adds a kernel-doc for externally linked dc_stream_remove_writeback() function.
>> 
>> Signed-off-by: James Flowers <bold.zone2373@fastmail.com>
>> ---
>>   drivers/gpu/drm/amd/display/dc/core/dc_stream.c | 8 ++++++++
>>   1 file changed, 8 insertions(+)
>> 
>> diff --git a/drivers/gpu/drm/amd/display/dc/core/dc_stream.c b/drivers/gpu/drm/amd/display/dc/core/dc_stream.c
>> index 0478dd856d8c..060ee6c3fc2e 100644
>> --- a/drivers/gpu/drm/amd/display/dc/core/dc_stream.c
>> +++ b/drivers/gpu/drm/amd/display/dc/core/dc_stream.c
>> @@ -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)

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

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2025-05-03 18:52 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-05-01  5:56 [PATCH RESEND] drm/amd/display: adds kernel-doc comment for dc_stream_remove_writeback() James Flowers
2025-05-02 22:25 ` Alex Hung
2025-05-03 18:52   ` James

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).