Go to file
Mauro Carvalho Chehab cc2a2d19f8 docs: watchdog: convert docs to ReST and rename to *.rst
Convert those documents and prepare them to be part of the kernel
API book, as most of the stuff there are related to the
Kernel interfaces.

Still, in the future, it would make sense to split the docs,
as some of the stuff is clearly focused on sysadmin tasks.

The conversion is actually:
  - add blank lines and identation in order to identify paragraphs;
  - fix tables markups;
  - add some lists markups;
  - mark literal blocks;
  - adjust title markups.

At its new index.rst, let's add a :orphan: while this is not linked to
the main index.rst file, in order to avoid build warnings.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Reviewed-by: Guenter Roeck <linux@roeck-us.net>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-06-14 14:32:05 -06:00
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 treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 36 2019-05-24 17:27:11 +02:00
crypto SPDX update for 5.2-rc4 2019-06-08 12:52:42 -07:00
Documentation docs: watchdog: convert docs to ReST and rename to *.rst 2019-06-14 14:32:05 -06:00
drivers docs: watchdog: convert docs to ReST and rename to *.rst 2019-06-14 14:32:05 -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 Char/Misc driver fixes for 5.2-rc4 2019-06-08 12:50:36 -07:00
ipc treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 441 2019-06-05 17:37:17 +02:00
kernel SPDX update for 5.2-rc4 2019-06-08 12:52:42 -07:00
lib docs: fault-injection: convert docs to ReST and rename to *.rst 2019-06-14 14:21:07 -06:00
LICENSES LICENSES: Rename other to deprecated 2019-05-03 06:34:32 -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 docs: timers: convert docs to ReST and rename to *.rst 2019-06-14 14:31:48 -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 Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/net 2019-04-17 11:26:25 -07:00
.cocciconfig
.get_maintainer.ignore Opt out of scripts/get_maintainer.pl 2019-05-16 10:53:40 -07:00
.gitattributes
.gitignore .gitignore: exclude .get_maintainer.ignore and .gitattributes 2019-05-18 11:49:54 +09:00
.mailmap A reasonably busy cycle for docs, including: 2019-05-08 12:42:50 -07:00
COPYING
CREDITS MAINTAINERS: Farewell Martin Schwidefsky 2019-05-31 10:14:11 +02:00
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

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.