Commit b55b54b5db33 ("staging/android: remove struct sync_pt")
added the members child_list and active_list to the fence struct, but
didn't add descriptions for these. Adding the descriptions.
Signed-off-by: Luis de Bethencourt <[email protected]>
---
Hi,
Noticed this missing descriptions when running make htmldocs.
Got the following warnings:
.//include/linux/fence.h:84: warning: No description found for parameter 'child_list'
.//include/linux/fence.h:84: warning: No description found for parameter 'active_list'
Thanks :)
Luis
include/linux/fence.h | 2 ++
1 file changed, 2 insertions(+)
diff --git a/include/linux/fence.h b/include/linux/fence.h
index 2b17698..2056e9f 100644
--- a/include/linux/fence.h
+++ b/include/linux/fence.h
@@ -49,6 +49,8 @@ struct fence_cb;
* @timestamp: Timestamp when the fence was signaled.
* @status: Optional, only valid if < 0, must be set before calling
* fence_signal, indicates that the fence has completed with an error.
+ * @child_list: list of children fences
+ * @active_list: list of active fences
*
* the flags member must be manipulated and read using the appropriate
* atomic ops (bit_*), so taking the spinlock will not be needed most
--
2.5.1
Hello Luis,
On Sat, Mar 19, 2016 at 4:50 PM, Luis de Bethencourt
<[email protected]> wrote:
> Commit b55b54b5db33 ("staging/android: remove struct sync_pt")
> added the members child_list and active_list to the fence struct, but
> didn't add descriptions for these. Adding the descriptions.
>
Patches whose commit message mentions a specific commit that
introduced and issue, usually also have a "Fixes:" tag before the
S-o-B. For example this patch should have:
Fixes: b55b54b5db33 ("staging/android: remove struct sync_pt")
> Signed-off-by: Luis de Bethencourt <[email protected]>
> ---
> Hi,
>
> Noticed this missing descriptions when running make htmldocs.
>
> Got the following warnings:
> .//include/linux/fence.h:84: warning: No description found for parameter 'child_list'
> .//include/linux/fence.h:84: warning: No description found for parameter 'active_list'
>
> Thanks :)
> Luis
>
Patch looks good to me.
Reviewed-by: Javier Martinez Canillas <[email protected]>
Best regards,
Javier
On 19/03/16 23:55, Javier Martinez Canillas wrote:
> Hello Luis,
>
> On Sat, Mar 19, 2016 at 4:50 PM, Luis de Bethencourt
> <[email protected]> wrote:
>> Commit b55b54b5db33 ("staging/android: remove struct sync_pt")
>> added the members child_list and active_list to the fence struct, but
>> didn't add descriptions for these. Adding the descriptions.
>>
>
> Patches whose commit message mentions a specific commit that
> introduced and issue, usually also have a "Fixes:" tag before the
> S-o-B. For example this patch should have:
>
> Fixes: b55b54b5db33 ("staging/android: remove struct sync_pt")
>> Signed-off-by: Luis de Bethencourt <[email protected]>
>> ---
>> Hi,
>>
>> Noticed this missing descriptions when running make htmldocs.
>>
>> Got the following warnings:
>> .//include/linux/fence.h:84: warning: No description found for parameter 'child_list'
>> .//include/linux/fence.h:84: warning: No description found for parameter 'active_list'
>>
>> Thanks :)
>> Luis
>>
>
> Patch looks good to me.
>
> Reviewed-by: Javier Martinez Canillas <[email protected]>
>
> Best regards,
> Javier
>
Hi Javier,
I didn't knew that, but thanks for saying so I can learn and use it in the
future.
I used the 'Commit b55b54b5db33 ("staging/android: remove struct sync_pt")'
format because that is what checkpatch recommended. But after re-reading
Documentation/SubmittingPatches it all makes sense and the process is clear
in my head.
Thanks!
Luis