b0deb1b5bd
Some ACRN kernel components are using the API documentation methods of
the Linux kernel. While they use Sphinx for generating their
documentation, they don't use doxygen to collect the API information as
we do for the rest of the project. Instead, they use their own tools
called "kerneldoc". This PR incorporates those tools into our
documentation build process.
There is a prescribed directory structure for this to work: that the
acrn-hypervisor and acrn-kernel repos are cloned to sibling folders,
e.g.:
projectacrn
acrn-hypervisor
acrn-kernel
so that documentation references from acrn_hypervisor/doc can access the
source code in ../../acrn-kernel to do the kerneldoc processing. A full
display of the kerneldoc API material for a source file in the
acrn-kernel tree can be done using a sphinx extension directive:
.. kernel-doc:: /tools/virtio/linux/scatterlist.h
where the assumed root of these file references is ../../acrn-kernel.
The format for kerneldoc comments is documented in
https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html and
references to kerneldoc API material in .rst files is documented in
https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#including-kernel-doc-comments
Without options, the kernel-doc directive includes all documentation
comments from the source file. With options, you can display subsets of
these comments.
The intention is to limit use of kerneldoc comments to the acrn-kernel
repo and not use them elsewhere within the ACRN project (where doxygen
comments are expected.)
While I'd prefer NOT to include the kerneldoc perl script here (it is
already in the acrn-kernel/sphinx folder), I don't want to create a
dependency on the acrn-kernel folder existing for documentation
generation, but this might be unavoidable once we have part of the API
material coming from there. We can update this in a later PR.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
|
||
|---|---|---|
| .. | ||
| .known-issues | ||
| _templates | ||
| api | ||
| custom-doxygen | ||
| developer-guides | ||
| extensions | ||
| getting-started | ||
| images | ||
| introduction | ||
| reference/kconfig | ||
| scripts | ||
| static | ||
| tutorials | ||
| user-guides | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| acrn.doxyfile | ||
| conf.py | ||
| glossary.rst | ||
| index.rst | ||
| release_notes.rst | ||
| substitutions.txt | ||
README.md
Project ACRN Documentation
This folder hold the source and configuration files used to generate the Project ACRN documentation web site published to https://projectacrn.github.io