diff options
| author | André Almeida <andrealmeid@collabora.com> | 2021-01-30 02:45:46 +0100 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2021-02-04 22:47:24 +0100 |
| commit | dd58e649742a5eabd327d47096f12d3302d908f1 (patch) | |
| tree | 949de4f4e63837fce47b7cbd86711e28084641d8 /Documentation | |
| parent | coding-style.rst: Avoid comma statements (diff) | |
| download | linux-dd58e649742a5eabd327d47096f12d3302d908f1.tar.xz linux-dd58e649742a5eabd327d47096f12d3302d908f1.zip | |
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>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/process/adding-syscalls.rst | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/process/adding-syscalls.rst b/Documentation/process/adding-syscalls.rst index 02857b5ad2b5..906c47f1a9e5 100644 --- a/Documentation/process/adding-syscalls.rst +++ b/Documentation/process/adding-syscalls.rst @@ -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. |