Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: Make syscalls' helpers naming consistent

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>

authored by

André Almeida and committed by
Jonathan Corbet
dd58e649 26606ce0

+1 -1
+1 -1
Documentation/process/adding-syscalls.rst
··· 501 501 useful to be used within the kernel, needs to be shared between an old and a 502 502 new syscall, or needs to be shared between a syscall and its compatibility 503 503 variant, it should be implemented by means of a "helper" function (such as 504 - ``kern_xyzzy()``). This kernel function may then be called within the 504 + ``ksys_xyzzy()``). This kernel function may then be called within the 505 505 syscall stub (``sys_xyzzy()``), the compatibility syscall stub 506 506 (``compat_sys_xyzzy()``), and/or other kernel code. 507 507