docs: Make syscalls' helpers naming consistent
authorAndré Almeida <andrealmeid@collabora.com>
Sat, 30 Jan 2021 01:45:46 +0000 (22:45 -0300)
committerJonathan Corbet <corbet@lwn.net>
Thu, 4 Feb 2021 21:47:24 +0000 (14:47 -0700)
The documentation explains the need to create internal syscalls' helpers,
and that they should be called `kern_xyzzy()`. However, the comment at
include/linux/syscalls.h says that they should be named as
`ksys_xyzzy()`, and so are all the helpers declared bellow it. Change the
documentation to reflect this.

Fixes: 819671ff849b ("syscalls: define and explain goal to not call syscalls in the kernel")
Signed-off-by: André Almeida <andrealmeid@collabora.com>
Reviewed-by: Dominik Brodowski <linux@dominikbrodowski.net>
Link: https://lore.kernel.org/r/20210130014547.123006-1-andrealmeid@collabora.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/process/adding-syscalls.rst

index 02857b5ad2b5e155fbe5b5dbe592b8e388c35bdc..906c47f1a9e5086a1c5f451b1d8bebe19b0c6ff0 100644 (file)
@@ -501,7 +501,7 @@ table, but not from elsewhere in the kernel.  If the syscall functionality is
 useful to be used within the kernel, needs to be shared between an old and a
 new syscall, or needs to be shared between a syscall and its compatibility
 variant, it should be implemented by means of a "helper" function (such as
-``kern_xyzzy()``).  This kernel function may then be called within the
+``ksys_xyzzy()``).  This kernel function may then be called within the
 syscall stub (``sys_xyzzy()``), the compatibility syscall stub
 (``compat_sys_xyzzy()``), and/or other kernel code.