doc: update release branch with changed docs

After the release branch is made, we continue with documentation up to
the release date.  This PR includes all those changes for the v3.2
release.

Signed-off-by: David B. Kinder <[email protected]>

Author: dbkinder

doc/acrn.doxyfile

@@ -1809,7 +1809,7 @@ LATEX_HIDE_INDICES     = NO
 # The default value is: NO.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
-LATEX_SOURCE_CODE      = NO
+# LATEX_SOURCE_CODE      = NO
 
 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
 # bibliography, e.g. plainnat, or ieeetr. See
@@ -1891,7 +1891,7 @@ RTF_EXTENSIONS_FILE    =
 # The default value is: NO.
 # This tag requires that the tag GENERATE_RTF is set to YES.
 
-RTF_SOURCE_CODE        = NO
+# RTF_SOURCE_CODE        = NO
 
 #---------------------------------------------------------------------------
 # Configuration options related to the man page output
@@ -1989,7 +1989,7 @@ DOCBOOK_OUTPUT         = docbook
 # The default value is: NO.
 # This tag requires that the tag GENERATE_DOCBOOK is set to YES.
 
-DOCBOOK_PROGRAMLISTING = NO
+# DOCBOOK_PROGRAMLISTING = NO
 
 #---------------------------------------------------------------------------
 # Configuration options for the AutoGen Definitions output
@@ -2187,7 +2187,7 @@ EXTERNAL_PAGES         = YES
 # powerful graphs.
 # The default value is: YES.
 
-CLASS_DIAGRAMS         = YES
+# CLASS_DIAGRAMS         = YES
 
 # You can define message sequence charts within doxygen comments using the \msc
 # command. Doxygen will then run the mscgen tool (see:

doc/asa.rst

@@ -3,6 +3,45 @@
 Security Advisory
 #################
 
+Addressed in ACRN v3.0.2
+************************
+We recommend that all developers using v3.0.1 or earlier upgrade to this v3.0.2
+release (or later), which addresses the following security issue discovered in
+previous releases. For v3.1 users, these issues are addressed in the v3.2
+release:
+
+-----
+
+- Board_inspector: use executables found under system paths
+    Using partial executable paths in the board inspector may cause unintended
+    results when another executable has the same name and is also detectable in
+    the search paths.
+
+    Introduce a wrapper module (`external_tools`) which locates executables
+    only under system paths such as /usr/bin and /usr/sbin and converts partial
+    executable paths to absolute ones before executing them via the subprocess
+    module. All invocations to `subprocess.run` or `subprocess.Popen`
+    throughout the board inspector are replaced with `external_tools.run`, with
+    the only exception being the invocation to the legacy board parser which
+    already uses an absolute path to the current Python interpreter.
+
+    **Affected Release:** v3.1, v3.0.1 and earlier
+
+- Add tarfile member sanitization to extractall()
+    A directory traversal vulnerability in the Python tarfile module extractall() functions
+    could allow user-assisted remote attackers to overwrite arbitrary files via
+    a ``..`` (dot dot) sequence in filenames in a tar archive, related to CVE-2001-1267.
+    (Addresses security issue tracked by CVE-2007-4559)
+
+    **Affected Release:** v3.1, v3.0.1 and earlier
+
+- PMU (Performance Monitoring Unit) is passed through to an RTVM only for debug mode
+    Enabling Pass-through PMU counters to RTVM can cause workload interference
+    in a release build, so enable PMU passthrough only when building ACRN in
+    debug mode.
+
+    **Affected Release:** v3.1, v3.0.1 and earlier
+
 Addressed in ACRN v3.0.1
 ************************
 We recommend that all developers upgrade to this v3.0.1 release (or later), which

doc/conf.py

@@ -46,7 +46,8 @@
 # extlinks provides a macro template
 
 extlinks = {
-            'acrn-issue': ('https://github.com/projectacrn/acrn-hypervisor/issues/%s', '#')
+            'acrn-issue': ('https://github.com/projectacrn/acrn-hypervisor/issues/%s', '#'),
+            'acrn-pr': ('https://github.com/projectacrn/acrn-hypervisor/pull/%s', '#')
            }
 
 # use intersphinx linking to link to previous version release notes
@@ -133,7 +134,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'misc/README.rst' ]
+exclude_patterns = ['_build', 'misc/README.rst', 'venv' ]
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'

doc/developer-guides/c_coding_guidelines.rst

@@ -3312,8 +3312,7 @@ each function:
     ``@post <post-condition description>``.
 12) The brief description of the function return value shall be documented
     with the format ``@return <brief description of return value>``.
-13) A void-returning function shall be documented with the format
-    ``@return None``.
+13) A void-returning function shall not be documented with ``@return``.
 14) The comments explaining the actual return values shall be documented with
     the format ``@retval <return value> <return value explanation>``.
 15) If the description of one element needs to span multiple lines, each line