From 791b091bbea9bea5c6ad770d50e255fb7289bf57 Mon Sep 17 00:00:00 2001 From: "David B. Kinder" Date: Fri, 30 Oct 2020 16:00:23 -0700 Subject: [PATCH] doc: more prep for upgrading doc build tools Preparing for upgrading to newer versions of doc building tools including sphing, doxygen, breathe, docutils, etc. This PR's changes still work find with the older tool versions, but should eliminate issues found while moving to newer tool versions (later). Signed-off-by: David B. Kinder --- doc/.known-issues/doc/dupdecl.conf | 3 +++ doc/.known-issues/doc/kerneldoc.conf | 8 ++++++++ doc/glossary.rst | 8 ++++---- 3 files changed, 15 insertions(+), 4 deletions(-) create mode 100644 doc/.known-issues/doc/kerneldoc.conf diff --git a/doc/.known-issues/doc/dupdecl.conf b/doc/.known-issues/doc/dupdecl.conf index e086dbf65..c71875da3 100644 --- a/doc/.known-issues/doc/dupdecl.conf +++ b/doc/.known-issues/doc/dupdecl.conf @@ -5,3 +5,6 @@ ^(?P[-._/\w]+/hld/[-._/\w]+.rst):(?P[0-9]+): WARNING: Duplicate declaration. # Sphinx 2.0 ^(?P[-._/\w]+/hld/[-._/\w]+.rst):(?P[0-9]+): WARNING: Duplicate declaration, .* +# +^(?P[-._/\w]+/hld/[-._/\w]+.rst):(?P[0-9]+): WARNING: Duplicate C\+\+ declaration, .* +^Declaration is .* diff --git a/doc/.known-issues/doc/kerneldoc.conf b/doc/.known-issues/doc/kerneldoc.conf new file mode 100644 index 000000000..293fda7e1 --- /dev/null +++ b/doc/.known-issues/doc/kerneldoc.conf @@ -0,0 +1,8 @@ +# +# Kerneldoc (vbs.h) +# +# +^(?P[-._/\w]+/acrn-kernel/include/linux/vbs/vbs.h):(?P[0-9]+): WARNING: Error in declarator or parameters +^Invalid C declaration:.* +^ long virtio_.* +^[- \t]*\^ diff --git a/doc/glossary.rst b/doc/glossary.rst index b2ba20151..99ed91fff 100644 --- a/doc/glossary.rst +++ b/doc/glossary.rst @@ -144,7 +144,7 @@ Glossary of Terms Pre-launched VMs are started by the ACRN hypervisor before the Service VM is launched. (See :term:`Post-launched VM`) - Post-Launched VM + Post-launched VM Post-Launched VMs are launched and configured by the Service VM. (See :term:`Pre-launched VM`) @@ -176,9 +176,9 @@ Glossary of Terms soft real-time workloads (or applications) much more efficiently than the typical User VM through the use of a passthrough interrupt controller, polling-mode Virtio, Intel RDT allocation features (CAT, - MBA), and I/O prioritization. RTVMs are typically a :term:`pre-launched VM`. - A non-:term:`safety VM` with real-time requirements is a - :term:`post-launched VM`. + MBA), and I/O prioritization. RTVMs are typically a :term:`Pre-launched VM`. + A non-:term:`Safety VM` with real-time requirements is a + :term:`Post-launched VM`. Safety VM A special VM with dedicated hardware resources, running in