linux-kernel - [PATCH] dma-buf/sync_file: Fix missing colon in kernel-doc for num

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <20230727011944.327807-1-me@davidreaver.com>
Date:   Wed, 26 Jul 2023 18:19:44 -0700
From:   David Reaver <me@...idreaver.com>
To:     Jonathan Corbet <corbet@....net>
Cc:     David Reaver <me@...idreaver.com>, linux-doc@...r.kernel.org,
        Sumit Semwal <sumit.semwal@...aro.org>,
        Gustavo Padovan <gustavo@...ovan.org>,
        linux-media@...r.kernel.org, dri-devel@...ts.freedesktop.org,
        linux-kernel@...r.kernel.org
Subject: [PATCH] dma-buf/sync_file: Fix missing colon in kernel-doc for num_fences

The struct sync_fence_info member num_fences was missing a colon in the
kernel-doc, causing this warning when running make htmldocs:

./include/uapi/linux/sync_file.h:77: warning: Function parameter or member 'num_fences' not described in 'sync_file_info'

num_fences was also clearly missing from
https://docs.kernel.org/driver-api/dma-buf.html#c.sync_file_info before
this patch.

Signed-off-by: David Reaver <me@...idreaver.com>
---
 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
@@ -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