No description
  • C 98.2%
  • Assembly 1%
  • Makefile 0.3%
  • Shell 0.2%
  • Python 0.1%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Mauro Carvalho Chehab d67297ad34 docs: kdump: convert docs to ReST and rename to *.rst
Convert kdump documentation to ReST and add it to the
user faced manual, as the documents are mainly focused on
sysadmins that would be enabling kdump.

Note: the vmcoreinfo.rst has one very long title on one of its
sub-sections:

	PG_lru|PG_private|PG_swapcache|PG_swapbacked|PG_slab|PG_hwpoision|PG_head_mask|PAGE_BUDDY_MAPCOUNT_VALUE(~PG_buddy)|PAGE_OFFLINE_MAPCOUNT_VALUE(~PG_offline)

I opted to break this one, into two entries with the same content,
in order to make it easier to display after being parsed in html and PDF.

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>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-06-14 14:21:24 -06:00
arch docs: kdump: convert docs to ReST and rename to *.rst 2019-06-14 14:21:24 -06:00
block
certs
crypto
Documentation docs: kdump: convert docs to ReST and rename to *.rst 2019-06-14 14:21:24 -06:00
drivers docs: kbuild: convert docs to ReST and rename to *.rst 2019-06-14 14:21:21 -06:00
fs A change to call iput() asynchronously to avoid a possible deadlock 2019-06-08 15:57:35 -07:00
include docs: fault-injection: convert docs to ReST and rename to *.rst 2019-06-14 14:21:07 -06:00
init
ipc
kernel
lib docs: fault-injection: convert docs to ReST and rename to *.rst 2019-06-14 14:21:07 -06:00
LICENSES
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
scripts docs: kbuild: convert docs to ReST and rename to *.rst 2019-06-14 14:21:21 -06:00
security Linux 5.2-rc4 2019-06-14 14:18:53 -06:00
sound docs: kbuild: convert docs to ReST and rename to *.rst 2019-06-14 14:21:21 -06:00
tools docs: fault-injection: convert docs to ReST and rename to *.rst 2019-06-14 14:21:07 -06:00
usr
virt
.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: fpga: convert docs to ReST and rename to *.rst 2019-06-14 14:21:15 -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.