mirror of
https://github.com/hardkernel/linux.git
synced 2026-06-06 10:58:48 +09:00
db6e7e5fd4
[ Upstream commit c9ad95adc096f25004d4192258863806a68a9bc8 ] Add sparst.rst to toctree, so it can be part of the docs build. Cc: Randy Dunlap <rdunlap@infradead.org> Cc: Jonathan Corbet <corbet@lwn.net> Suggested-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Min-Hua Chen <minhuadotchen@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20230902052512.12184-4-minhuadotchen@gmail.com Stable-dep-of: c48a7c44a1d0 ("docs: kernel_feat.py: fix potential command injection") Signed-off-by: Sasha Levin <sashal@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.