Re: [PATCH] fence: add missing descriptions for fence
From: Luis de Bethencourt
Date: Sat Mar 19 2016 - 20:07:55 EST
On 19/03/16 23:55, Javier Martinez Canillas wrote:
> Hello Luis,
>
> On Sat, Mar 19, 2016 at 4:50 PM, Luis de Bethencourt
> <luisbg@xxxxxxxxxxxxxxx> 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 <luisbg@xxxxxxxxxxxxxxx>
>> ---
>> 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 <javier@xxxxxxxxxxxxxxx>
>
> 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