Go to file
Jonathan Corbet d74b0d31dd Docs: An initial automarkup extension for sphinx
Rather than fill our text files with :c:func:`function()` syntax, just do
the markup via a hook into the sphinx build process.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-06-26 11:14:09 -06:00
Documentation Docs: An initial automarkup extension for sphinx 2019-06-26 11:14:09 -06:00
LICENSES
arch docs: kdump: convert docs to ReST and rename to *.rst 2019-06-14 14:21:24 -06:00
block block, bfq: add weight symlink to the bfq.weight cgroup parameter 2019-06-07 01:29:40 -06:00
certs
crypto SPDX update for 5.2-rc4 2019-06-08 12:52:42 -07:00
drivers docs: EDID/HOWTO.txt: convert it and rename to howto.rst 2019-06-14 14:32:29 -06:00
fs A change to call iput() asynchronously to avoid a possible deadlock 2019-06-08 15:57:35 -07:00
include docs: timers: convert docs to ReST and rename to *.rst 2019-06-14 14:31:48 -06:00
init docs: scheduler: convert docs to ReST and rename to *.rst 2019-06-14 14:32:18 -06:00
ipc treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 441 2019-06-05 17:37:17 +02:00
kernel docs: scheduler: convert docs to ReST and rename to *.rst 2019-06-14 14:32:18 -06:00
lib lib: list_sort.c: add a blank line to avoid kernel-doc warnings 2019-06-20 14:07:34 -06:00
mm Linux 5.2-rc4 2019-06-14 14:18:53 -06:00
net docs: kbuild: convert docs to ReST and rename to *.rst 2019-06-14 14:21:21 -06:00
samples SPDX update for 5.2-rc4 2019-06-08 12:52:42 -07:00
scripts scripts/documentation-file-ref-check: ignore output dir 2019-06-14 14:43:01 -06:00
security Linux 5.2-rc4 2019-06-14 14:18:53 -06:00
sound docs: timers: convert docs to ReST and rename to *.rst 2019-06-14 14:31:48 -06:00
tools docs: fault-injection: convert docs to ReST and rename to *.rst 2019-06-14 14:21:07 -06:00
usr
virt treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 333 2019-06-05 17:37:06 +02:00
.clang-format
.cocciconfig
.get_maintainer.ignore
.gitattributes
.gitignore
.mailmap
COPYING
CREDITS
Kbuild
Kconfig docs: kbuild: convert docs to ReST and rename to *.rst 2019-06-14 14:21:21 -06:00
MAINTAINERS docs: watchdog: convert docs to ReST and rename to *.rst 2019-06-14 14:32:05 -06:00
Makefile Linux 5.2-rc4 2019-06-08 20:24:46 -07:00
README

README

Linux kernel
============

There are several guides for kernel developers and users. These guides can
be rendered in a number of formats, like HTML and PDF. Please read
Documentation/admin-guide/README.rst first.

In order to build the documentation, use ``make htmldocs`` or
``make pdfdocs``.  The formatted documentation can also be read online at:

    https://www.kernel.org/doc/html/latest/

There are various text files in the Documentation/ subdirectory,
several of them using the Restructured Text markup notation.

Please read the Documentation/process/changes.rst file, as it contains the
requirements for building and running the kernel, and information about
the problems which may result by upgrading your kernel.