MIRRORS/linux-imx
1
0
Fork 0
mirror of https://github.com/nxp-imx/linux-imx.git synced 2026-01-07 10:16:22 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity
0ea97a2d61
linux-imx/README
Jonathan Corbet 4b290af0b3 Docs: Added a pointer to the formatted docs to README 
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>
2018-03-21 09:02:53 -06:00

800 B
Raw Blame History

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.