Re: [PATCH v2] Remove the parameter not described warning

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Vinayak,

Thanks for you patch

On 06/09/2023 13:51, Vinayak Hegde wrote:
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

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.

Signed-off-by: Vinayak Hegde <vinayakph123@xxxxxxxxx>
---
  include/uapi/linux/sync_file.h | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/uapi/linux/sync_file.h b/include/uapi/linux/sync_file.h
index 7e42a5b7558b..b389a5495181 100644
--- a/include/uapi/linux/sync_file.h
+++ b/include/uapi/linux/sync_file.h

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

@@ -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



[Index of Archives]     [Linux Input]     [Video for Linux]     [Gstreamer Embedded]     [Mplayer Users]     [Linux USB Devel]     [Linux Audio Users]     [Linux Kernel]     [Linux SCSI]     [Yosemite Backpacking]

  Powered by Linux