2020-04-15 17:45:15 +03:00
|
|
|
.. SPDX-License-Identifier: GPL-2.0
|
|
|
|
|
|
2019-04-14 21:51:10 +03: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 15:14:05 +03:00
|
|
|
.. The Linux Kernel documentation master file, created by
|
|
|
|
|
sphinx-quickstart on Fri Feb 12 13:51:46 2016.
|
|
|
|
|
You can adapt this file completely to your liking, but it should at least
|
|
|
|
|
contain the root `toctree` directive.
|
|
|
|
|
|
2018-06-06 01:49:01 +03:00
|
|
|
.. _linux_doc:
|
|
|
|
|
|
2017-06-06 23:50:04 +03: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 15:14:05 +03:00
|
|
|
|
2016-10-27 00:43:00 +03: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.
|
|
|
|
|
|
2017-12-29 01:17:17 +03:00
|
|
|
Licensing documentation
|
|
|
|
|
-----------------------
|
|
|
|
|
|
|
|
|
|
The following describes the license of the Linux kernel source code
|
|
|
|
|
(GPLv2), how to properly mark the license of individual files in the source
|
|
|
|
|
tree, as well as links to the full license text.
|
|
|
|
|
|
2018-08-14 14:43:12 +03:00
|
|
|
* :ref:`kernel_licensing`
|
2017-12-29 01:17:17 +03:00
|
|
|
|
2016-10-27 00:43:00 +03:00
|
|
|
User-oriented documentation
|
|
|
|
|
---------------------------
|
|
|
|
|
|
|
|
|
|
The following manuals are written for *users* of the kernel — those who are
|
|
|
|
|
trying to get it to work optimally on a given system.
|
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 15:14:05 +03:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
2016-09-21 15:51:11 +03:00
|
|
|
admin-guide/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 14:36:50 +03:00
|
|
|
kbuild/index
|
2016-10-27 00:43:00 +03:00
|
|
|
|
2019-04-25 18:30:54 +03:00
|
|
|
Firmware-related documentation
|
|
|
|
|
------------------------------
|
|
|
|
|
The following holds information on the kernel's expectations regarding the
|
|
|
|
|
platform firmwares.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
firmware-guide/index
|
2020-04-15 17:45:15 +03:00
|
|
|
devicetree/index
|
2019-04-25 18:30:54 +03:00
|
|
|
|
2017-04-02 23:58:01 +03:00
|
|
|
Application-developer documentation
|
|
|
|
|
-----------------------------------
|
|
|
|
|
|
|
|
|
|
The user-space API manual gathers together documents describing aspects of
|
|
|
|
|
the kernel interface as seen by application developers.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
2018-03-21 22:22:48 +03:00
|
|
|
userspace-api/index
|
2017-04-02 23:58:01 +03:00
|
|
|
|
|
|
|
|
|
2016-10-27 00:43:00 +03:00
|
|
|
Introduction to kernel development
|
|
|
|
|
----------------------------------
|
|
|
|
|
|
|
|
|
|
These manuals contain overall information about how to develop the kernel.
|
|
|
|
|
The kernel community is quite large, with thousands of developers
|
|
|
|
|
contributing over the course of a year. As with any large community,
|
|
|
|
|
knowing how things are done will make the process of getting your changes
|
|
|
|
|
merged much easier.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
2016-10-18 14:05:32 +03:00
|
|
|
process/index
|
2016-10-26 09:23:14 +03:00
|
|
|
dev-tools/index
|
2016-11-17 13:32:33 +03:00
|
|
|
doc-guide/index
|
2017-05-11 14:03:27 +03:00
|
|
|
kernel-hacking/index
|
2018-02-17 08:39:34 +03:00
|
|
|
trace/index
|
2017-12-04 02:27:29 +03:00
|
|
|
maintainer/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 14:36:50 +03:00
|
|
|
fault-injection/index
|
|
|
|
|
livepatch/index
|
|
|
|
|
|
2016-10-27 00:43:00 +03:00
|
|
|
|
|
|
|
|
Kernel API documentation
|
|
|
|
|
------------------------
|
|
|
|
|
|
|
|
|
|
These books get into the details of how specific kernel subsystems work
|
|
|
|
|
from the point of view of a kernel developer. Much of the information here
|
|
|
|
|
is taken directly from the kernel source, with supplemental material added
|
|
|
|
|
as needed (or at least as we managed to add it — probably *not* all that is
|
2017-01-25 07:14:33 +03:00
|
|
|
needed).
|
2016-10-27 00:43:00 +03:00
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
2016-08-20 22:17:32 +03:00
|
|
|
driver-api/index
|
2016-10-28 11:14:10 +03:00
|
|
|
core-api/index
|
2019-06-28 13:29:15 +03:00
|
|
|
locking/index
|
2019-06-18 23:16:23 +03:00
|
|
|
accounting/index
|
|
|
|
|
block/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 14:36:50 +03:00
|
|
|
cdrom/index
|
2020-03-03 16:52:03 +03:00
|
|
|
cpu-freq/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 14:36:50 +03:00
|
|
|
fb/index
|
|
|
|
|
fpga/index
|
2019-06-18 23:16:23 +03:00
|
|
|
hid/index
|
2019-07-26 15:51:16 +03:00
|
|
|
i2c/index
|
2019-06-18 23:16:23 +03:00
|
|
|
iio/index
|
2019-07-26 15:51:25 +03:00
|
|
|
isdn/index
|
2019-06-28 15:30:28 +03:00
|
|
|
infiniband/index
|
2019-06-18 22:51:34 +03:00
|
|
|
leds/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 14:36:50 +03:00
|
|
|
netlabel/index
|
2017-05-12 15:14:02 +03:00
|
|
|
networking/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 14:36:50 +03:00
|
|
|
pcmcia/index
|
2019-07-15 15:39:57 +03:00
|
|
|
power/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 14:36:50 +03:00
|
|
|
target/index
|
|
|
|
|
timers/index
|
2019-07-31 23:08:50 +03:00
|
|
|
spi/index
|
2019-07-31 23:08:53 +03:00
|
|
|
w1/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 14:36:50 +03:00
|
|
|
watchdog/index
|
2019-08-09 16:23:49 +03:00
|
|
|
virt/index
|
2017-04-11 13:01:19 +03:00
|
|
|
input/index
|
2019-04-17 12:46:29 +03:00
|
|
|
hwmon/index
|
2016-06-21 14:48:57 +03:00
|
|
|
gpu/index
|
2016-11-04 02:57:52 +03:00
|
|
|
security/index
|
2016-11-02 23:30:39 +03:00
|
|
|
sound/index
|
2016-10-21 05:54:22 +03:00
|
|
|
crypto/index
|
2017-05-12 12:50:22 +03:00
|
|
|
filesystems/index
|
2018-03-21 22:22:48 +03:00
|
|
|
vm/index
|
2018-07-26 08:03:04 +03:00
|
|
|
bpf/index
|
2019-06-19 00:05:38 +03:00
|
|
|
usb/index
|
2019-05-14 17:47:23 +03:00
|
|
|
PCI/index
|
2020-03-02 11:15:34 +03:00
|
|
|
scsi/index
|
2019-01-14 06:21:46 +03:00
|
|
|
misc-devices/index
|
2019-04-22 22:49:11 +03:00
|
|
|
scheduler/index
|
2020-02-20 12:58:39 +03:00
|
|
|
mhi/index
|
2022-02-08 18:36:39 +03:00
|
|
|
peci/index
|
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 15:14:05 +03:00
|
|
|
|
linkage: Introduce new macros for assembler symbols
Introduce new C macros for annotations of functions and data in
assembly. There is a long-standing mess in macros like ENTRY, END,
ENDPROC and similar. They are used in different manners and sometimes
incorrectly.
So introduce macros with clear use to annotate assembly as follows:
a) Support macros for the ones below
SYM_T_FUNC -- type used by assembler to mark functions
SYM_T_OBJECT -- type used by assembler to mark data
SYM_T_NONE -- type used by assembler to mark entries of unknown type
They are defined as STT_FUNC, STT_OBJECT, and STT_NOTYPE
respectively. According to the gas manual, this is the most portable
way. I am not sure about other assemblers, so this can be switched
back to %function and %object if this turns into a problem.
Architectures can also override them by something like ", @function"
if they need.
SYM_A_ALIGN, SYM_A_NONE -- align the symbol?
SYM_L_GLOBAL, SYM_L_WEAK, SYM_L_LOCAL -- linkage of symbols
b) Mostly internal annotations, used by the ones below
SYM_ENTRY -- use only if you have to (for non-paired symbols)
SYM_START -- use only if you have to (for paired symbols)
SYM_END -- use only if you have to (for paired symbols)
c) Annotations for code
SYM_INNER_LABEL_ALIGN -- only for labels in the middle of code
SYM_INNER_LABEL -- only for labels in the middle of code
SYM_FUNC_START_LOCAL_ALIAS -- use where there are two local names for
one function
SYM_FUNC_START_ALIAS -- use where there are two global names for one
function
SYM_FUNC_END_ALIAS -- the end of LOCAL_ALIASed or ALIASed function
SYM_FUNC_START -- use for global functions
SYM_FUNC_START_NOALIGN -- use for global functions, w/o alignment
SYM_FUNC_START_LOCAL -- use for local functions
SYM_FUNC_START_LOCAL_NOALIGN -- use for local functions, w/o
alignment
SYM_FUNC_START_WEAK -- use for weak functions
SYM_FUNC_START_WEAK_NOALIGN -- use for weak functions, w/o alignment
SYM_FUNC_END -- the end of SYM_FUNC_START_LOCAL, SYM_FUNC_START,
SYM_FUNC_START_WEAK, ...
For functions with special (non-C) calling conventions:
SYM_CODE_START -- use for non-C (special) functions
SYM_CODE_START_NOALIGN -- use for non-C (special) functions, w/o
alignment
SYM_CODE_START_LOCAL -- use for local non-C (special) functions
SYM_CODE_START_LOCAL_NOALIGN -- use for local non-C (special)
functions, w/o alignment
SYM_CODE_END -- the end of SYM_CODE_START_LOCAL or SYM_CODE_START
d) For data
SYM_DATA_START -- global data symbol
SYM_DATA_START_LOCAL -- local data symbol
SYM_DATA_END -- the end of the SYM_DATA_START symbol
SYM_DATA_END_LABEL -- the labeled end of SYM_DATA_START symbol
SYM_DATA -- start+end wrapper around simple global data
SYM_DATA_LOCAL -- start+end wrapper around simple local data
==========
The macros allow to pair starts and ends of functions and mark functions
correctly in the output ELF objects.
All users of the old macros in x86 are converted to use these in further
patches.
Signed-off-by: Jiri Slaby <jslaby@suse.cz>
Signed-off-by: Borislav Petkov <bp@suse.de>
Acked-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Andrey Ryabinin <aryabinin@virtuozzo.com>
Cc: Boris Ostrovsky <boris.ostrovsky@oracle.com>
Cc: "H. Peter Anvin" <hpa@zytor.com>
Cc: Ingo Molnar <mingo@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Josh Poimboeuf <jpoimboe@redhat.com>
Cc: Juergen Gross <jgross@suse.com>
Cc: Len Brown <len.brown@intel.com>
Cc: Linus Torvalds <torvalds@linux-foundation.org>
Cc: linux-arch@vger.kernel.org
Cc: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Cc: linux-pm@vger.kernel.org
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Pavel Machek <pavel@ucw.cz>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Will Deacon <will@kernel.org>
Cc: x86-ml <x86@kernel.org>
Cc: xen-devel@lists.xenproject.org
Link: https://lkml.kernel.org/r/20191011115108.12392-2-jslaby@suse.cz
2019-10-11 14:50:41 +03:00
|
|
|
Architecture-agnostic documentation
|
|
|
|
|
-----------------------------------
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
asm-annotations
|
|
|
|
|
|
2017-05-13 13:50:43 +03:00
|
|
|
Architecture-specific documentation
|
|
|
|
|
-----------------------------------
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
2021-03-12 18:28:03 +03:00
|
|
|
arch
|
|
|
|
|
|
2017-05-13 13:50:43 +03:00
|
|
|
|
2020-06-15 09:50:25 +03:00
|
|
|
Other documentation
|
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
|
|
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
|
|
|
|
|
to ReStructured Text format, or are simply too old.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
2022-01-21 03:00:33 +03:00
|
|
|
tools/index
|
2020-06-15 09:50:25 +03:00
|
|
|
staging/index
|
|
|
|
|
|
|
|
|
|
|
2018-06-06 01:49:00 +03:00
|
|
|
Translations
|
|
|
|
|
------------
|
2017-01-25 07:14:33 +03:00
|
|
|
|
|
|
|
|
.. toctree::
|
2018-06-06 01:49:00 +03:00
|
|
|
:maxdepth: 2
|
2017-04-08 13:24:04 +03:00
|
|
|
|
2018-06-06 01:49:00 +03:00
|
|
|
translations/index
|
2017-04-08 13:24:04 +03: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 15:14:05 +03:00
|
|
|
Indices and tables
|
|
|
|
|
==================
|
|
|
|
|
|
|
|
|
|
* :ref:`genindex`
|
