|
|
f2d475 |
Linux kernel
|
|
|
f2d475 |
============
|
|
|
f2d475 |
|
|
|
f2d475 |
There are several guides for kernel developers and users. These guides can
|
|
|
f2d475 |
be rendered in a number of formats, like HTML and PDF. Please read
|
|
|
f2d475 |
Documentation/admin-guide/README.rst first.
|
|
|
f2d475 |
|
|
|
f2d475 |
In order to build the documentation, use ``make htmldocs`` or
|
|
|
f2d475 |
``make pdfdocs``. The formatted documentation can also be read online at:
|
|
|
f2d475 |
|
|
|
f2d475 |
https://www.kernel.org/doc/html/latest/
|
|
|
f2d475 |
|
|
|
f2d475 |
There are various text files in the Documentation/ subdirectory,
|
|
|
f2d475 |
several of them using the Restructured Text markup notation.
|
|
|
f2d475 |
See Documentation/00-INDEX for a list of what is contained in each file.
|
|
|
f2d475 |
|
|
|
f2d475 |
Please read the Documentation/process/changes.rst file, as it contains the
|
|
|
f2d475 |
requirements for building and running the kernel, and information about
|
|
|
f2d475 |
the problems which may result by upgrading your kernel.
|