mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2026-04-05 03:35:52 -04:00
a592a36e49
The root document usually has a special :ref:`genindex` link to the generated index. This is also the case for Documentation/index.rst. The other index.rst files deeper in the directory hierarchy usually don't. For SPHINXDIRS builds, the root document isn't Documentation/index.rst, but some other index.rst in the hierarchy. Currently they have a ".. only::" block to add the index link when doing SPHINXDIRS html builds. This is obviously very tedious and repetitive. The link is also added to all index.rst files in the hierarchy for SPHINXDIRS builds, not just the root document. Put the boilerplate in a sphinx-includes/subproject-index.rst file, and include it at the end of the root document for subproject builds in an ad-hoc source-read extension defined in conf.py. For now, keep having the boilerplate in translations, because this approach currently doesn't cover translated index link headers. Cc: Jonathan Corbet <corbet@lwn.net> Cc: Mauro Carvalho Chehab <mchehab@kernel.org> Cc: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jani Nikula <jani.nikula@intel.com> Tested-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> [jc: did s/doctree/kern_doc_dir/ ] Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260123143149.2024303-1-jani.nikula@intel.com>
192 lines
3.4 KiB
ReStructuredText
192 lines
3.4 KiB
ReStructuredText
=================================================
|
|
The Linux kernel user's and administrator's guide
|
|
=================================================
|
|
|
|
The following is a collection of user-oriented documents that have been
|
|
added to the kernel over time. There is, as yet, little overall order or
|
|
organization here — this material was not written to be a single, coherent
|
|
document! With luck things will improve quickly over time.
|
|
|
|
General guides to kernel administration
|
|
---------------------------------------
|
|
|
|
This initial section contains overall information, including the README
|
|
file describing the kernel as a whole, documentation on kernel parameters,
|
|
etc.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
README
|
|
devices
|
|
|
|
features
|
|
|
|
A big part of the kernel's administrative interface is the /proc and sysfs
|
|
virtual filesystems; these documents describe how to interact with tem
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
sysfs-rules
|
|
sysctl/index
|
|
cputopology
|
|
abi
|
|
|
|
Security-related documentation:
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
hw-vuln/index
|
|
LSM/index
|
|
perf-security
|
|
|
|
Booting the kernel
|
|
------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
bootconfig
|
|
kernel-parameters
|
|
efi-stub
|
|
initrd
|
|
|
|
|
|
Tracking down and identifying problems
|
|
--------------------------------------
|
|
|
|
Here is a set of documents aimed at users who are trying to track down
|
|
problems and bugs in particular.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
reporting-issues
|
|
reporting-regressions
|
|
quickly-build-trimmed-linux
|
|
verify-bugs-and-bisect-regressions
|
|
bug-hunting
|
|
bug-bisect
|
|
tainted-kernels
|
|
ramoops
|
|
dynamic-debug-howto
|
|
init
|
|
kdump/index
|
|
perf/index
|
|
pstore-blk
|
|
clearing-warn-once
|
|
kernel-per-CPU-kthreads
|
|
lockup-watchdogs
|
|
RAS/index
|
|
sysrq
|
|
|
|
|
|
Core-kernel subsystems
|
|
----------------------
|
|
|
|
These documents describe core-kernel administration interfaces that are
|
|
likely to be of interest on almost any system.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
cgroup-v2
|
|
cgroup-v1/index
|
|
cpu-load
|
|
mm/index
|
|
module-signing
|
|
namespaces/index
|
|
numastat
|
|
pm/index
|
|
syscall-user-dispatch
|
|
|
|
Support for non-native binary formats. Note that some of these
|
|
documents are ... old ...
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
binfmt-misc
|
|
java
|
|
mono
|
|
|
|
|
|
Block-layer and filesystem administration
|
|
-----------------------------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
bcache
|
|
binderfs
|
|
blockdev/index
|
|
cifs/index
|
|
device-mapper/index
|
|
ext4
|
|
filesystem-monitoring
|
|
nfs/index
|
|
iostats
|
|
jfs
|
|
md
|
|
ufs
|
|
xfs
|
|
|
|
Device-specific guides
|
|
----------------------
|
|
|
|
How to configure your hardware within your Linux system.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
acpi/index
|
|
aoe/index
|
|
auxdisplay/index
|
|
braille-console
|
|
btmrvl
|
|
dell_rbu
|
|
edid
|
|
gpio/index
|
|
hw_random
|
|
laptops/index
|
|
lcd-panel-cgram
|
|
media/index
|
|
nvme-multipath
|
|
parport
|
|
pnp
|
|
rapidio
|
|
rtc
|
|
serial-console
|
|
svga
|
|
thermal/index
|
|
thunderbolt
|
|
vga-softcursor
|
|
video-output
|
|
|
|
Workload analysis
|
|
-----------------
|
|
|
|
This is the beginning of a section with information of interest to
|
|
application developers and system integrators doing analysis of the
|
|
Linux kernel for safety critical applications. Documents supporting
|
|
analysis of kernel interactions with applications, and key kernel
|
|
subsystems expectations will be found here.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
workload-tracing
|
|
|
|
Everything else
|
|
---------------
|
|
|
|
A few hard-to-categorize and generally obsolete documents.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
ldm
|
|
unicode
|