Following the structure used in sysctl/kernel.rst, this updates
abi.rst to use ReStructured Text more fully and updates the entries to
match current kernels:
* the list of files is now the table of contents;
* links are used to point to other documentation and other sections;
* all the existing entries are no longer present, so this removes
them;
* document vsyscall32.
Mentions of the kernel version are dropped. Since the document is
entirely rewritten, I've replaced the copyright statement.
Signed-off-by: Stephen Kitt <[email protected]>
---
Documentation/admin-guide/sysctl/abi.rst | 71 ++++++------------------
1 file changed, 18 insertions(+), 53 deletions(-)
diff --git a/Documentation/admin-guide/sysctl/abi.rst b/Documentation/admin-guide/sysctl/abi.rst
index 599bcde7f0b7..d88b48db8bf9 100644
--- a/Documentation/admin-guide/sysctl/abi.rst
+++ b/Documentation/admin-guide/sysctl/abi.rst
@@ -2,66 +2,31 @@
Documentation for /proc/sys/abi/
================================
-kernel version 2.6.0.test2
+.. See scripts/check-sysctl-docs to keep this up to date:
+.. scripts/check-sysctl-docs -vtable="abi" \
+.. Documentation/admin-guide/sysctl/abi.rst \
+.. $(git grep -l register_sysctl_)
-Copyright (c) 2003, Fabian Frederick <[email protected]>
+Copyright (c) 2020, Stephen Kitt
-For general info: index.rst.
+For general info, see :doc:`index`.
------------------------------------------------------------------------------
-This path is binary emulation relevant aka personality types aka abi.
-When a process is executed, it's linked to an exec_domain whose
-personality is defined using values available from /proc/sys/abi.
-You can find further details about abi in include/linux/personality.h.
+The files in ``/proc/sys/abi`` can be used to see and modify
+ABI-related settings.
-Here are the files featuring in 2.6 kernel:
+Currently, these files might (depending on your configuration)
+show up in ``/proc/sys/kernel``:
-- defhandler_coff
-- defhandler_elf
-- defhandler_lcall7
-- defhandler_libcso
-- fake_utsname
-- trace
+.. contents:: :local:
-defhandler_coff
----------------
+vsyscall32 (x86)
+================
-defined value:
- PER_SCOSVR3::
+Determines whether the kernels maps a vDSO page into 32-bit processes;
+can be set to 1 to enable, or 0 to disable. Defaults to enabled if
+``CONFIG_COMPAT_VDSO`` is set, disabled otherwide.
- 0x0003 | STICKY_TIMEOUTS | WHOLE_SECONDS | SHORT_INODE
-
-defhandler_elf
---------------
-
-defined value:
- PER_LINUX::
-
- 0
-
-defhandler_lcall7
------------------
-
-defined value :
- PER_SVR4::
-
- 0x0001 | STICKY_TIMEOUTS | MMAP_PAGE_ZERO,
-
-defhandler_libsco
------------------
-
-defined value:
- PER_SVR4::
-
- 0x0001 | STICKY_TIMEOUTS | MMAP_PAGE_ZERO,
-
-fake_utsname
-------------
-
-Unused
-
-trace
------
-
-Unused
+This controls the same setting as the ``vdso32`` kernel boot
+parameter.
base-commit: 5ff4aa70bf347e13ec87697b1c732ce86060c47d
--
2.20.1
On Fri, 11 Sep 2020 21:01:52 +0200
Stephen Kitt <[email protected]> wrote:
> Following the structure used in sysctl/kernel.rst, this updates
> abi.rst to use ReStructured Text more fully and updates the entries to
> match current kernels:
>
> * the list of files is now the table of contents;
> * links are used to point to other documentation and other sections;
> * all the existing entries are no longer present, so this removes
> them;
> * document vsyscall32.
>
> Mentions of the kernel version are dropped. Since the document is
> entirely rewritten, I've replaced the copyright statement.
>
> Signed-off-by: Stephen Kitt <[email protected]>
Replacing a copyright makes me a little nervous, but I guess that is OK
here since everything else is replaced too. Could I trouble you, though,
for a version that adds an SPDX line at the top while you're at it?
Thanks,
jon
On Wed, 16 Sep 2020 12:43:10 -0600, Jonathan Corbet <[email protected]> wrote:
> On Fri, 11 Sep 2020 21:01:52 +0200
> Stephen Kitt <[email protected]> wrote:
> > Following the structure used in sysctl/kernel.rst, this updates
> > abi.rst to use ReStructured Text more fully and updates the entries to
> > match current kernels:
> >
> > * the list of files is now the table of contents;
> > * links are used to point to other documentation and other sections;
> > * all the existing entries are no longer present, so this removes
> > them;
> > * document vsyscall32.
> >
> > Mentions of the kernel version are dropped. Since the document is
> > entirely rewritten, I've replaced the copyright statement.
> >
> > Signed-off-by: Stephen Kitt <[email protected]>
>
> Replacing a copyright makes me a little nervous, but I guess that is OK
> here since everything else is replaced too.
I hesitated too, but after checking carefully that the original contents were
all gone, decided it sort of made sense... I could just drop that line too,
I’m not sure there’s much point in documentation that’s supposed to be
collectively maintained (and authorship is determined by the commits anyway).
> Could I trouble you, though, for a version that adds an SPDX line at the
> top while you're at it?
No problem, v2 incoming.
While I’m at it, might I ask if it would be possible to carry
https://lkml.org/lkml/2020/8/12/181 (sort-of-re-submitted in
https://lkml.org/lkml/2020/9/11/1079) in the docs tree? It fixes a docs
commit...
Regards,
Stephen