mirror of
https://github.com/hardkernel/linux.git
synced 2026-06-09 04:10:18 +09:00
b97d4a1eb4
There are several :c:type: definitions there, in order to do cross-references with the driver's documentation. Those are broken when docs are built with Sphinx 3.x, as it would require :c:struct: instead. For Sphinx < 3.x, the automarkup.py extension is able to do the replacement already, and a future improvement on it should make it also work with Sphinx 3.x. So, get rid of the usage of the :c:type: macro there. Reviewed-by: Sakari Ailus <sakari.ailus@linux.intel.com> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@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.