Go to file
Mauro Carvalho Chehab 168869492e docs: kbuild: fix build with pdf and fix some minor issues
The tag ".. include" should be replaced by ".. literalinclude" at
issues.rst, otherwise it causes TeX to crash due to excessive usage
of stack with Sphinx 2.0.

While here, solve a few minor issues at the kbuild book output by
adding extra blank lines.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
2019-07-15 11:03:04 -03:00
Documentation docs: kbuild: fix build with pdf and fix some minor issues 2019-07-15 11:03:04 -03:00
LICENSES LICENSES: Rename other to deprecated 2019-05-03 06:34:32 -06:00
arch docs: admin-guide: add a series of orphaned documents 2019-07-15 11:03:02 -03:00
block docs: admin-guide: add a series of orphaned documents 2019-07-15 11:03:02 -03:00
certs Revert "Merge tag 'keys-acl-20190703' of git://git.kernel.org/pub/scm/linux/kernel/git/dhowells/linux-fs" 2019-07-10 18:43:43 -07:00
crypto USB / PHY patches for 5.3-rc1 2019-07-11 15:40:06 -07:00
drivers docs: serial: move it to the driver-api 2019-07-15 11:03:03 -03:00
fs docs: admin-guide: move sysctl directory to it 2019-07-15 11:03:01 -03:00
include docs: serial: move it to the driver-api 2019-07-15 11:03:03 -03:00
init docs: cgroup-v1: add it to the admin-guide book 2019-07-15 11:03:02 -03:00
ipc treewide: Replace GPLv2 boilerplate/reference with SPDX - rule 441 2019-06-05 17:37:17 +02:00
kernel docs: cgroup-v1: add it to the admin-guide book 2019-07-15 11:03:02 -03:00
lib docs: locking: convert docs to ReST and rename to *.rst 2019-07-15 08:53:27 -03:00
mm docs: admin-guide: move sysctl directory to it 2019-07-15 11:03:01 -03:00
net Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/net 2019-07-13 15:57:37 -07:00
samples docs: driver-api: add a series of orphaned documents 2019-07-15 11:03:02 -03:00
scripts docs: driver-model: move it to the driver-api book 2019-07-15 11:03:02 -03:00
security docs: cgroup-v1: add it to the admin-guide book 2019-07-15 11:03:02 -03:00
sound Driver Core and debugfs changes for 5.3-rc1 2019-07-12 12:24:03 -07:00
tools docs: cgroup-v1: add it to the admin-guide book 2019-07-15 11:03:02 -03:00
usr docs: early-userspace: move to driver-api guide 2019-07-15 11:03:01 -03:00
virt ARM: 2019-07-12 15:35:14 -07: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 MAINTAINERS: Update my email address 2019-06-18 14:37:27 +01:00
COPYING COPYING: use the new text with points to the license files 2018-03-23 12:41:45 -06:00
CREDITS docs: admin-guide: move sysctl directory to it 2019-07-15 11:03:01 -03:00
Kbuild Kbuild updates for v5.1 2019-03-10 17:48:21 -07:00
Kconfig docs: kbuild: convert docs to ReST and rename to *.rst 2019-06-14 14:21:21 -06:00
MAINTAINERS docs: gpio: add sysfs interface to the admin-guide 2019-07-15 11:03:03 -03:00
Makefile Kbuild updates for v5.3 2019-07-12 16:03:16 -07:00
README Drop all 00-INDEX files from Documentation/ 2018-09-09 15:08:58 -06: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.