Remove the parameter not described warning
Subsystems (2)
PATCH v2 1/1 Remove the parameter not described warning
I encountered a warning during kernel documentation compilation due to a missing colon in the documentation for the 'num_fences' variable in the sync_file.h header file.
This change adds the missing colon to align with the documentation format.
--- include/uapi/linux/sync_file.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/uapi/linux/sync_file.h +1 -1
@@ -56,7 +56,7 @@ struct sync_fence_info {* @name: name of fence * @status: status of fence. 1: signaled 0:active <0:error * @flags: sync_file_info flags -* @num_fences number of fences in the sync_file +* @num_fences: number of fences in the sync_file * @pad: padding for 64-bit alignment, should always be zero * @sync_fence_info: pointer to array of struct &sync_fence_info with all * fences in the sync_file
Signature · 1 line
2.34.1
Sumit Semwal
maintainerHi Vinayak,
Quoted 7 lines · Vinayak Hegde
I encountered a warning during kernel documentation compilation due to a missing colon in the documentation for the '
num_fences' variable in thesync_file.hheader file.
This change adds the missing colon to align with the documentation format.Signed-off-by Vinayak Hegde <[email protected]>
Thanks for your patch; I'll queue it via drm-misc.
Quoted 18 lines
--- include/uapi/linux/sync_file.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)include/uapi/linux/sync_file.h +1
-2@@ -56,7 +56,7 @@ struct sync_fence_info {* @name: name of fence * @status: status of fence. 1: signaled 0:active <0:error * @flags: sync_file_info flags -* @num_fences number of fences in the sync_file +* @num_fences: number of fences in the sync_file * @pad: padding for 64-bit alignment, should always be zero * @sync_fence_info: pointer to array of struct &sync_fence_info with all * fences in the sync_file --
Quoted 2 lines
2.34.1
Best,
Sumit.
Signature · 5 lines
Thanks and regards, Sumit Semwal (he / him) Tech Lead - LCG, Vertical Technologies Linaro.org │ Open source software for ARM SoCs
Hi Vinayak,
Thanks for you patch
Quoted 1 line · Vinayak Hegde
I encountered a warning during kernel documentation compilation
Usually we write the commit message in imperative mood, please check: https://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes
include/uapi/linux/sync_file.h
Quoted 13 lines
due to a missing colon in the documentation for the '
num_fences' variable in thesync_file.hheader file.
This change adds the missing colon to align with the documentation format.Signed-off-by Vinayak Hegde <[email protected]>--- include/uapi/linux/sync_file.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)include/uapi/linux/sync_file.h +0
-0
Since you are modifying this file, if you run:
git log --oneline include/uapi/linux/sync_file.h
you will notice that almost all changes start with "dma-buf/sync_file:" prefix, it would be nice to maintain the style pattern for the commit title.
Regards,
Helen
Quoted 9 lines
include/uapi/linux/sync_file.h +1
-1@@ -56,7 +56,7 @@ struct sync_fence_info {* @name: name of fence * @status: status of fence. 1: signaled 0:active <0:error * @flags: sync_file_info flags -* @num_fences number of fences in the sync_file +* @num_fences: number of fences in the sync_file * @pad: padding for 64-bit alignment, should always be zero * @sync_fence_info: pointer to array of struct &sync_fence_info with all * fences in the sync_file