mirror of
https://github.com/torvalds/linux
synced 2024-07-08 20:29:39 +00:00
1f44039766
- Some cleanup of the main index page for easier navigation
- Rework some of the other top-level pages for better readability and, with
luck, fewer merge conflicts in the future.
- Submit-checklist improvements, hopefully the first of many.
- New Italian translations
- A fair number of kernel-doc fixes and improvements. We have also dropped
the recommendation to use an old version of Sphinx.
- A new document from Thorsten on bisection
...and lots of fixes and updates.
-----BEGIN PGP SIGNATURE-----
iQEzBAABCAAdFiEEIw+MvkEiF49krdp9F0NaE2wMflgFAmXvKVIACgkQF0NaE2wM
flik1gf/ZFS1mHwDdmHA/vpx8UxdUlFEo0Pms8V24iPSW5aEIqkZ406c9DSyMTtp
CXTzW+RSCfB1Q3ciYtakHBgv0RzZ5+RyaEZ1l7zVmMyw4nYvK6giYKmg8Y0EVPKI
fAVuPWo5iE7io0sNVbKBKJJkj9Z8QEScM48hv/CV1FblMvHYn0lie6muJrF9G6Ez
HND+hlYZtWkbRd5M86CDBiFeGMLVPx17T+psQyQIcbUYm9b+RUqZRHIVRLYbad7r
18r9+83DsOhXTVJCBBSfCSZwzF8yAm+eD1w47sxnSItF8OiIjqCzQgXs3BZe9TXH
h2YyeWbMN3xByA4mEgpmOPP44RW7Pg==
=SC60
-----END PGP SIGNATURE-----
Merge tag 'docs-6.9' of git://git.lwn.net/linux
Pull documentation updates from Jonathan Corbet:
"A moderatly busy cycle for development this time around.
- Some cleanup of the main index page for easier navigation
- Rework some of the other top-level pages for better readability
and, with luck, fewer merge conflicts in the future.
- Submit-checklist improvements, hopefully the first of many.
- New Italian translations
- A fair number of kernel-doc fixes and improvements. We have also
dropped the recommendation to use an old version of Sphinx.
- A new document from Thorsten on bisection
... and lots of fixes and updates"
* tag 'docs-6.9' of git://git.lwn.net/linux: (54 commits)
docs: verify/bisect: fixes, finetuning, and support for Arch
docs: Makefile: Add dependency to $(YNL_INDEX) for targets other than htmldocs
docs: Move ja_JP/howto.rst to ja_JP/process/howto.rst
docs: submit-checklist: use subheadings
docs: submit-checklist: structure by category
docs: new text on bisecting which also covers bug validation
docs: drop the version constraints for sphinx and dependencies
docs: kerneldoc-preamble.sty: Remove code for Sphinx <2.4
docs: Restore "smart quotes" for quotes
docs/zh_CN: accurate translation of "function"
docs: Include simplified link titles in main index
docs: Correct formatting of title in admin-guide/index.rst
docs: kernel_feat.py: fix build error for missing files
MAINTAINERS: Set the field name for subsystem profile section
kasan: Add documentation for CONFIG_KASAN_EXTRA_INFO
Fixed case issue with 'fault-injection' in documentation
kernel-doc: handle #if in enums as well
Documentation: update mailing list addresses
doc: kerneldoc.py: fix indentation
scripts/kernel-doc: simplify signature printing
...
147 lines
2.8 KiB
ReStructuredText
147 lines
2.8 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.
|
|
|
|
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
|
|
kernel-parameters
|
|
devices
|
|
sysctl/index
|
|
|
|
abi
|
|
features
|
|
|
|
This section describes CPU vulnerabilities and their mitigations.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
hw-vuln/index
|
|
|
|
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
|
|
|
|
This is the beginning of a section with information of interest to
|
|
application developers. Documents covering various aspects of the kernel
|
|
ABI will be found here.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
sysfs-rules
|
|
|
|
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
|
|
|
|
The rest of this manual consists of various unordered guides on how to
|
|
configure specific aspects of kernel behavior to your liking.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
acpi/index
|
|
aoe/index
|
|
auxdisplay/index
|
|
bcache
|
|
binderfs
|
|
binfmt-misc
|
|
blockdev/index
|
|
bootconfig
|
|
braille-console
|
|
btmrvl
|
|
cgroup-v1/index
|
|
cgroup-v2
|
|
cifs/index
|
|
clearing-warn-once
|
|
cpu-load
|
|
cputopology
|
|
dell_rbu
|
|
device-mapper/index
|
|
edid
|
|
efi-stub
|
|
ext4
|
|
filesystem-monitoring
|
|
nfs/index
|
|
gpio/index
|
|
highuid
|
|
hw_random
|
|
initrd
|
|
iostats
|
|
java
|
|
jfs
|
|
kernel-per-CPU-kthreads
|
|
laptops/index
|
|
lcd-panel-cgram
|
|
ldm
|
|
lockup-watchdogs
|
|
LSM/index
|
|
md
|
|
media/index
|
|
mm/index
|
|
module-signing
|
|
mono
|
|
namespaces/index
|
|
numastat
|
|
parport
|
|
perf-security
|
|
pm/index
|
|
pmf
|
|
pnp
|
|
rapidio
|
|
RAS/index
|
|
rtc
|
|
serial-console
|
|
svga
|
|
syscall-user-dispatch
|
|
sysrq
|
|
thermal/index
|
|
thunderbolt
|
|
ufs
|
|
unicode
|
|
vga-softcursor
|
|
video-output
|
|
xfs
|
|
|
|
.. only:: subproject and html
|
|
|
|
Indices
|
|
=======
|
|
|
|
* :ref:`genindex`
|