mirror of
https://github.com/hardkernel/linux.git
synced 2026-06-07 19:30:30 +09:00
183ebe0355
Stephen Rothwell reported htmldocs warning then merging accel tree: Documentation/accel/introduction.rst:72: WARNING: Inline emphasis start-string without end-string. Sphinx confuses the file wildcards with inline emphasis (italics), hence the warning. Fix the warning by escaping wildcards. Link: https://lore.kernel.org/linux-next/20230120132116.21de1104@canb.auug.org.au/ Reported-by: Stephen Rothwell <sfr@canb.auug.org.au> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Reviewed-by: Jeffrey Hugo <quic_jhugo@quicinc.com> Signed-off-by: Oded Gabbay <ogabbay@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.