summaryrefslogtreecommitdiffstats
path: root/Documentation/userspace-api/index.rst
diff options
context:
space:
mode:
authorCheng Lingfei <chenglingfei@foxmail.com>2026-08-24 20:45:46 +0800
committerTejun Heo <tj@kernel.org>2026-08-24 06:55:59 -1000
commit909a3f0e9d8b0d8001cf6e99808f88eca8e44328 (patch)
treebe05d18bd5619b55ff3b30f28a292907021768ee /Documentation/userspace-api/index.rst
downloadlinux-stable-909a3f0e9d8b0d8001cf6e99808f88eca8e44328.tar.gz
linux-stable-909a3f0e9d8b0d8001cf6e99808f88eca8e44328.zip
docs: cgroup-v2: fix misc.events key format descriptiongrafted
In misc cgroup, misc.events does not output a simple "max" key. Instead, each registered misc resource outputs a separate key suffixed with ".max" (i.e., "<res>.max"). Update the documentation to clarify that the entry key is "<res>.max". Suggested-by: Michal Koutný <mkoutny@suse.com> Signed-off-by: Cheng Lingfei <chenglingfei@foxmail.com> Signed-off-by: Tejun Heo <tj@kernel.org>
Diffstat (limited to 'Documentation/userspace-api/index.rst')
-rw-r--r--Documentation/userspace-api/index.rst71
1 files changed, 71 insertions, 0 deletions
diff --git a/Documentation/userspace-api/index.rst b/Documentation/userspace-api/index.rst
new file mode 100644
index 000000000..a68b1bea5
--- /dev/null
+++ b/Documentation/userspace-api/index.rst
@@ -0,0 +1,71 @@
+=====================================
+The Linux kernel user-space API guide
+=====================================
+
+.. _man-pages: https://www.kernel.org/doc/man-pages/
+
+While much of the kernel's user-space API is documented elsewhere
+(particularly in the man-pages_ project), some user-space information can
+also be found in the kernel tree itself. This manual is intended to be the
+place where this information is gathered.
+
+
+System calls
+============
+
+.. toctree::
+ :maxdepth: 1
+
+ unshare
+ futex2
+ ebpf/index
+ ioctl/index
+ mseal
+ rseq
+
+Security-related interfaces
+===========================
+
+.. toctree::
+ :maxdepth: 1
+
+ no_new_privs
+ seccomp_filter
+ landlock
+ lsm
+ mfd_noexec
+ spec_ctrl
+ tee
+ check_exec
+
+Devices and I/O
+===============
+
+.. toctree::
+ :maxdepth: 1
+
+ accelerators/ocxl
+ dma-buf-heaps
+ dma-buf-alloc-exchange
+ fwctl/index
+ gpio/index
+ iommufd
+ media/index
+ dcdbas
+ vduse
+ isapnp
+
+Everything else
+===============
+
+.. toctree::
+ :maxdepth: 1
+
+ ELF
+ liveupdate
+ netlink/index
+ sysfs-platform_profile
+ vduse
+ futex2
+ perf_ring_buffer
+ ntsync