2020-04-15 22:45:15 +08:00
|
|
|
.. SPDX-License-Identifier: GPL-2.0
|
|
|
|
|
|
2018-06-06 06:49:01 +08:00
|
|
|
.. _linux_doc:
|
|
|
|
|
|
2023-02-15 08:57:26 +08:00
|
|
|
==============================
|
2017-06-07 04:50:04 +08:00
|
|
|
The Linux Kernel documentation
|
|
|
|
|
==============================
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
|
2016-10-27 05:43:00 +08:00
|
|
|
This is the top level of the kernel's documentation tree. Kernel
|
|
|
|
|
documentation, like the kernel itself, is very much a work in progress;
|
|
|
|
|
that is especially true as we work to integrate our many scattered
|
|
|
|
|
documents into a coherent whole. Please note that improvements to the
|
|
|
|
|
documentation are welcome; join the linux-doc list at vger.kernel.org if
|
|
|
|
|
you want to help out.
|
|
|
|
|
|
2022-09-28 00:05:54 +08:00
|
|
|
Working with the development community
|
2023-02-15 08:57:26 +08:00
|
|
|
======================================
|
2017-12-29 06:17:17 +08:00
|
|
|
|
2022-09-28 00:05:54 +08:00
|
|
|
The essential guides for interacting with the kernel's development
|
|
|
|
|
community and getting your work upstream.
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
|
|
|
|
|
.. toctree::
|
2022-09-28 00:05:54 +08:00
|
|
|
:maxdepth: 1
|
2019-04-25 23:30:54 +08:00
|
|
|
|
2024-01-09 23:56:43 +08:00
|
|
|
Development process <process/development-process>
|
|
|
|
|
Submitting patches <process/submitting-patches>
|
2022-09-28 00:05:54 +08:00
|
|
|
Code of conduct <process/code-of-conduct>
|
2024-01-09 23:56:43 +08:00
|
|
|
Maintainer handbook <maintainer/index>
|
2022-09-28 00:05:54 +08:00
|
|
|
All development-process docs <process/index>
|
2019-04-25 23:30:54 +08:00
|
|
|
|
|
|
|
|
|
2022-09-28 00:05:54 +08:00
|
|
|
Internal API manuals
|
2023-02-15 08:57:26 +08:00
|
|
|
====================
|
2017-04-03 04:58:01 +08:00
|
|
|
|
2022-09-28 00:05:54 +08:00
|
|
|
Manuals for use by developers working to interface with the rest of the
|
|
|
|
|
kernel.
|
2017-04-03 04:58:01 +08:00
|
|
|
|
|
|
|
|
.. toctree::
|
2022-09-28 00:05:54 +08:00
|
|
|
:maxdepth: 1
|
2017-04-03 04:58:01 +08:00
|
|
|
|
2024-01-09 23:56:43 +08:00
|
|
|
Core API <core-api/index>
|
|
|
|
|
Driver APIs <driver-api/index>
|
|
|
|
|
Subsystems <subsystem-apis>
|
|
|
|
|
Locking <locking/index>
|
2017-04-03 04:58:01 +08:00
|
|
|
|
2022-09-28 00:05:54 +08:00
|
|
|
Development tools and processes
|
2023-02-15 08:57:26 +08:00
|
|
|
===============================
|
2016-10-27 05:43:00 +08:00
|
|
|
|
2022-09-28 00:05:54 +08:00
|
|
|
Various other manuals with useful information for all kernel developers.
|
2016-10-27 05:43:00 +08:00
|
|
|
|
|
|
|
|
.. toctree::
|
2022-09-28 00:05:54 +08:00
|
|
|
:maxdepth: 1
|
2016-10-27 05:43:00 +08:00
|
|
|
|
2024-01-09 23:56:43 +08:00
|
|
|
Licensing rules <process/license-rules>
|
|
|
|
|
Writing documentation <doc-guide/index>
|
|
|
|
|
Development tools <dev-tools/index>
|
|
|
|
|
Testing guide <dev-tools/testing-overview>
|
|
|
|
|
Hacking guide <kernel-hacking/index>
|
|
|
|
|
Tracing <trace/index>
|
|
|
|
|
Fault injection <fault-injection/index>
|
|
|
|
|
Livepatching <livepatch/index>
|
|
|
|
|
Rust <rust/index>
|
docs: add some directories to the main documentation index
The contents of those directories were orphaned at the documentation
body.
While those directories could likely be moved to be inside some guide,
I'm opting to just adding their indexes to the main one, removing the
:orphan: and adding the SPDX header.
For the drivers, the rationale is that the documentation contains
a mix of Kernelspace, uAPI and admin-guide. So, better to keep them on
separate directories, as we've be doing with similar subsystem-specific
docs that were not split yet.
For the others, well... I'm too lazy to do the move. Also, it
seems to make sense to keep at least some of those at the main
dir (like kbuild, for example). In any case, a latter patch
could do the move.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Acked-by: Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com>
2019-06-28 19:36:50 +08:00
|
|
|
|
2016-10-27 05:43:00 +08:00
|
|
|
|
2022-09-28 00:05:54 +08:00
|
|
|
User-oriented documentation
|
2023-02-15 08:57:26 +08:00
|
|
|
===========================
|
2016-10-27 05:43:00 +08:00
|
|
|
|
2022-09-28 00:05:54 +08:00
|
|
|
The following manuals are written for *users* of the kernel — those who are
|
|
|
|
|
trying to get it to work optimally on a given system and application
|
|
|
|
|
developers seeking information on the kernel's user-space APIs.
|
2016-10-27 05:43:00 +08:00
|
|
|
|
|
|
|
|
.. toctree::
|
2022-09-28 00:05:54 +08:00
|
|
|
:maxdepth: 1
|
|
|
|
|
|
2024-01-09 23:56:43 +08:00
|
|
|
Administration <admin-guide/index>
|
|
|
|
|
Build system <kbuild/index>
|
|
|
|
|
Reporting issues <admin-guide/reporting-issues.rst>
|
|
|
|
|
Userspace tools <tools/index>
|
|
|
|
|
Userspace API <userspace-api/index>
|
2022-09-28 00:05:54 +08:00
|
|
|
|
2022-09-28 00:05:59 +08:00
|
|
|
See also: the `Linux man pages <https://www.kernel.org/doc/man-pages/>`_,
|
|
|
|
|
which are kept separately from the kernel's own documentation.
|
2022-09-28 00:05:54 +08:00
|
|
|
|
|
|
|
|
Firmware-related documentation
|
2023-02-15 08:57:26 +08:00
|
|
|
==============================
|
2022-09-28 00:05:54 +08:00
|
|
|
The following holds information on the kernel's expectations regarding the
|
|
|
|
|
platform firmwares.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
2024-01-09 23:56:43 +08:00
|
|
|
Firmware <firmware-guide/index>
|
|
|
|
|
Firmware and Devicetree <devicetree/index>
|
2016-10-27 05:43:00 +08:00
|
|
|
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
|
2017-05-13 18:50:43 +08:00
|
|
|
Architecture-specific documentation
|
2023-02-15 08:57:26 +08:00
|
|
|
===================================
|
2017-05-13 18:50:43 +08:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
2024-01-09 23:56:43 +08:00
|
|
|
CPU architectures <arch/index>
|
2021-03-12 23:28:03 +08:00
|
|
|
|
2017-05-13 18:50:43 +08:00
|
|
|
|
2020-06-15 14:50:25 +08:00
|
|
|
Other documentation
|
2023-02-15 08:57:26 +08:00
|
|
|
===================
|
2020-06-15 14:50:25 +08:00
|
|
|
|
|
|
|
|
There are several unsorted documents that don't seem to fit on other parts
|
|
|
|
|
of the documentation body, or may require some adjustments and/or conversion
|
2024-03-23 14:21:12 +08:00
|
|
|
to reStructuredText format, or are simply too old.
|
2020-06-15 14:50:25 +08:00
|
|
|
|
|
|
|
|
.. toctree::
|
2022-09-28 00:05:54 +08:00
|
|
|
:maxdepth: 1
|
2020-06-15 14:50:25 +08:00
|
|
|
|
2024-01-09 23:56:43 +08:00
|
|
|
Unsorted documentation <staging/index>
|
2020-06-15 14:50:25 +08:00
|
|
|
|
|
|
|
|
|
2018-06-06 06:49:00 +08:00
|
|
|
Translations
|
2023-02-15 08:57:26 +08:00
|
|
|
============
|
2017-01-25 12:14:33 +08:00
|
|
|
|
|
|
|
|
.. toctree::
|
2018-06-06 06:49:00 +08:00
|
|
|
:maxdepth: 2
|
2017-04-08 18:24:04 +08:00
|
|
|
|
2024-01-09 23:56:43 +08:00
|
|
|
Translations <translations/index>
|
2017-04-08 18:24:04 +08:00
|
|
|
|
Documentation/sphinx: add basic working Sphinx configuration and build
Add basic configuration and makefile to build documentation from any
.rst files under Documentation using Sphinx. For starters, there's just
the placeholder index.rst.
At the top level Makefile, hook Sphinx documentation targets alongside
(but independent of) the DocBook toolchain, having both be run on the
various 'make *docs' targets.
All Sphinx processing is placed into Documentation/Makefile.sphinx. Both
that and the Documentation/DocBook/Makefile are now expected to handle
all the documentation targets, explicitly ignoring them if they're not
relevant for that particular toolchain. The changes to the existing
DocBook Makefile are kept minimal.
There is graceful handling of missing Sphinx and rst2pdf (which is
needed for pdf output) by checking for the tool and python module,
respectively, with informative messages to the user.
If the Read the Docs theme (sphinx_rtd_theme) is available, use it, but
otherwise gracefully fall back to the Sphinx default theme, with an
informative message to the user, and slightly less pretty HTML output.
Sphinx can now handle htmldocs, pdfdocs (if rst2pdf is available),
epubdocs and xmldocs targets. The output documents are written into per
output type subdirectories under Documentation/output.
Finally, you can pass options to sphinx-build using the SPHINXBUILD make
variable. For example, 'make SPHINXOPTS=-v htmldocs' for more verbose
output from Sphinx.
This is based on the original work by Jonathan Corbet, but he probably
wouldn't recognize this as his own anymore.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
2016-05-19 20:14:05 +08:00
|
|
|
Indices and tables
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
