xref: /linux/README (revision 9f4a68e416a5930a0f8024453a84afa25134c1a0)
1Linux kernel
2============
3
4There are several guides for kernel developers and users. These guides can
5be rendered in a number of formats, like HTML and PDF. Please read
6Documentation/admin-guide/README.rst first.
7
8In order to build the documentation, use ``make htmldocs`` or
9``make pdfdocs``.
10
11There are various text files in the Documentation/ subdirectory,
12several of them using the Restructured Text markup notation.
13See Documentation/00-INDEX for a list of what is contained in each file.
14
15Please read the Documentation/process/changes.rst file, as it contains the
16requirements for building and running the kernel, and information about
17the problems which may result by upgrading your kernel.
18