[linux-2.6-block.git] / 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.
See Documentation/00-INDEX for a list of what is contained in each file.

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.
Commit	Line	Data
6bef44b9 MCC	1	Linux kernel
	2	============
	3
9f4a68e4 MK	4	There are several guides for kernel developers and users. These guides can
	5	be rendered in a number of formats, like HTML and PDF. Please read
	6	Documentation/admin-guide/README.rst first.
6bef44b9 MCC	7
6bef44b9 MCC	8	In order to build the documentation, use ``make htmldocs`` or
4b290af0 JC	9	``make pdfdocs``. The formatted documentation can also be read online at:
	10
	11	https://www.kernel.org/doc/html/latest/
6bef44b9 MCC	12
	13	There are various text files in the Documentation/ subdirectory,
	14	several of them using the Restructured Text markup notation.
	15	See Documentation/00-INDEX for a list of what is contained in each file.
	16
	17	Please read the Documentation/process/changes.rst file, as it contains the
	18	requirements for building and running the kernel, and information about
	19	the problems which may result by upgrading your kernel.