mirror of
https://github.com/edk2-porting/linux-next.git
synced 2024-11-25 19:14:39 +08:00
4b290af0b3
Kernel.org nicely maintains an online copy of the formatted documentation; tell our users that it exists. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
20 lines
800 B
Plaintext
20 lines
800 B
Plaintext
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.
|