linux-kernel - [PATCH] doc: add kernel-doc comment for u64_to_user

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: <20230102184349.10399-1-federico.vaga@vaga.pv.it>
Date:   Mon,  2 Jan 2023 19:43:49 +0100
From:   Federico Vaga <federico.vaga@...a.pv.it>
To:     Jonathan Corbet <corbet@....net>, Jens Axboe <axboe@...nel.dk>,
        Keith Busch <kbusch@...nel.org>,
        Peter Zijlstra <peterz@...radead.org>,
        Andrew Morton <akpm@...ux-foundation.org>,
        Mark Rutland <mark.rutland@....com>,
        Mikulas Patocka <mpatocka@...hat.com>,
        Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
Cc:     Federico Vaga <federico.vaga@...a.pv.it>,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: [PATCH] doc: add kernel-doc comment for u64_to_user_ptr

Add a kernel-doc comment in kernel.h to document the macro
`u64_to_user_ptr`.

As of today, this macro is mentioned in the documentation in
'ioctl.rst' and 'botching-up-ioctls.rst'

Signed-off-by: Federico Vaga <federico.vaga@...a.pv.it>
---
 include/linux/kernel.h | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/include/linux/kernel.h b/include/linux/kernel.h
index fe6efb24d151..8bcd126f64f2 100644
--- a/include/linux/kernel.h
+++ b/include/linux/kernel.h
@@ -56,6 +56,10 @@
 
 #define PTR_IF(cond, ptr)	((cond) ? (ptr) : NULL)
 
+/**
+ * u64_to_user_ptr - convert an unsigned 64bit number into a user pointer
+ * @x: the number to convert
+ */
 #define u64_to_user_ptr(x) (		\
 {					\
 	typecheck(u64, (x));		\
-- 
2.30.2