mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2026-05-07 17:27:11 -04:00
afbd4d4247
Merge the x86 docs conversion from Changbin Du, who writes: > The kernel now uses Sphinx to generate intelligent and beautiful > documentation from reStructuredText files. I converted all of the Linux > x86 docs to rst format in this serias. > > For you to preview, please visit below url: > http://www.bytemem.com:8080/kernel-doc/index.html > > Thank you! The whole series was: Acked-by: Ingo Molnar <mingo@kernel.org>
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.
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.