doc: pick doc updates for v2.6 release

Tracked-On: #5692

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>

doc/asa.rst

@@ -3,6 +3,21 @@
 Security Advisory
 #################
 
+Addressed in ACRN v2.6
+************************
+
+We recommend that all developers upgrade to this v2.6 release (or later), which
+addresses the following security issue discovered in previous releases:
+
+-----
+
+-  Memory leakage vulnerability in ``devicemodel/hw/pci/xhci.c``
+    De-initializing of emulated USB devices results in a memory leakage issue
+    as some resources allocated for transfer are not properly released.
+
+    **Affected Release:** v2.5 and earlier.
+
+
 Addressed in ACRN v2.5
 ************************
 

doc/conf.py

@@ -381,8 +381,10 @@ def setup(app):
    ('developer-guides/index', 'contribute'),
    ('getting-started/index', 'try'),
    ('user-guides/index', 'develop'),
+   ('tutorials/index', 'develop'),
    ('hardware', 'reference/hardware'),
    ('release_notes', 'release_notes/index'),
    ('getting-started/rt_industry', 'getting-started/getting-started'),
    ('getting-started/rt_industry_ubuntu', 'getting-started/getting-started'),
+   ('getting-started/building-from-source', 'getting-started/getting-started'),
    ]

doc/develop.rst

@@ -3,26 +3,16 @@
 Advanced Guides
 ###############
 
-
-Configuration and Tools
-***********************
+Advanced Scenario Tutorials
+*********************************
 
 .. rst-class:: rst-columns2
 
 .. toctree::
-   :glob:
    :maxdepth: 1
 
-   tutorials/acrn_configuration_tool
-   reference/config-options
-   user-guides/hv-parameters
-   user-guides/kernel-parameters
-   user-guides/acrn-shell
-   user-guides/acrn-dm-parameters
-   misc/debug_tools/acrn_crashlog/README
-   misc/packaging/README
-   misc/debug_tools/**
-   misc/services/acrn_manager/**
+   tutorials/using_hybrid_mode_on_nuc
+   tutorials/using_partition_mode_on_nuc
 
 Service VM Tutorials
 ********************
@@ -35,6 +25,8 @@ Service VM Tutorials
    tutorials/running_deb_as_serv_vm
    tutorials/using_yp
 
+.. _develop_acrn_user_vm:
+
 User VM Tutorials
 *****************
 
@@ -50,7 +42,27 @@ User VM Tutorials
    tutorials/using_vxworks_as_uos
    tutorials/using_zephyr_as_uos
 
-Enable ACRN Features
+Configuration Tutorials
+***********************
+
+.. rst-class:: rst-columns2
+
+.. toctree::
+   :glob:
+   :maxdepth: 1
+
+   tutorials/acrn_configuration_tool
+   tutorials/board_inspector_tool
+   tutorials/acrn_configurator_tool
+   reference/config-options
+   reference/config-options-launch
+   reference/hv-make-options
+   user-guides/hv-parameters
+   user-guides/kernel-parameters
+   user-guides/acrn-dm-parameters
+   misc/packaging/README
+
+Advanced Features
 ********************
 
 .. rst-class:: rst-columns2
@@ -77,17 +89,21 @@ Enable ACRN Features
    tutorials/acrn-secure-boot-with-efi-stub
    tutorials/pre-launched-rt
    tutorials/enable_ivshmem
-   tutorials/enable_ptm
 
 Debug
 *****
 
 .. rst-class:: rst-columns2
 
 .. toctree::
+   :glob:
    :maxdepth: 1
 
    tutorials/using_serial_port
    tutorials/debug
    tutorials/realtime_performance_tuning
    tutorials/rtvm_performance_tips
+   user-guides/acrn-shell
+   misc/debug_tools/acrn_crashlog/README
+   misc/debug_tools/**
+   misc/services/acrn_manager/**

doc/developer-guides/VBSK-analysis.rst

@@ -80,14 +80,14 @@ two parts:  kick overhead and notify overhead.
 -  **Kick Overhead**: The User VM gets trapped when it executes sensitive
    instructions that notify the hypervisor first. The notification is
    assembled into an IOREQ, saved in a shared IO page, and then
-   forwarded to the VHM module by the hypervisor. The VHM notifies its
+   forwarded to the HSM module by the hypervisor. The HSM notifies its
    client for this IOREQ, in this case, the client is the vbs-echo
    backend driver. Kick overhead is defined as the interval from the
    beginning of User VM trap to a specific VBS-K driver, e.g. when
    virtio-echo gets notified.
 -  **Notify Overhead**: After the data in virtqueue being processed by the
-   backend driver, vbs-echo calls the VHM module to inject an interrupt
-   into the frontend. The VHM then uses the hypercall provided by the
+   backend driver, vbs-echo calls the HSM module to inject an interrupt
+   into the frontend. The HSM then uses the hypercall provided by the
    hypervisor, which causes a User VM VMEXIT. The hypervisor finally injects
    an interrupt into the vLAPIC of the User VM and resumes it. The User VM
    therefore receives the interrupt notification.  Notify overhead is

doc/developer-guides/c_coding_guidelines.rst

@@ -3283,10 +3283,10 @@ each function:
 
 1) The comments block shall start with ``/**`` (slash-asterisk-asterisk) in a
    single line.
-2) The comments block shall end with :literal:`\ */` (space-asterisk-slash) in
+2) The comments block shall end with :literal:`\ */` (space-asterisk-slash) in
    a single line.
 3) Other than the first line and the last line, every line inside the comments
-   block shall start with :literal:`\ *` (space-asterisk). It also applies to
+   block shall start with :literal:`\ *` (space-asterisk). It also applies to
    the line which is used to separate different paragraphs. We'll call it a
    blank line for simplicity.
 4) For each function, following information shall be documented:

doc/developer-guides/contribute_guidelines.rst

@@ -135,6 +135,9 @@ Submitting Issues
 .. _ACRN-dev mailing list:
    https://lists.projectacrn.org/g/acrn-dev
 
+.. _ACRN-users mailing list:
+   https://lists.projectacrn.org/g/acrn-users
+
 .. _ACRN hypervisor issues:
    https://github.com/projectacrn/acrn-hypervisor/issues
 
@@ -143,7 +146,8 @@ GitHub issues in the `ACRN hypervisor issues`_ list. Before submitting a
 bug or enhancement request, first check to see what's already been
 reported, and add to that discussion if you have additional information.
 (Be sure to check both the "open" and "closed" issues.)
-You should also read through discussions in the `ACRN-dev mailing list`_
+You should also read through discussions in the `ACRN-users mailing list`_
+(and the `ACRN-dev mailing list`_)
 to see what's been reported on or discussed.  You may find others that
 have encountered the issue you're finding, or that have similar ideas
 for changes or additions.
@@ -463,13 +467,13 @@ All changes and topics sent to GitHub must be well-formed, as described above.
 Commit Message Body
 ===================
 
-When editing the commit message, please briefly explain what your change
+When editing the commit message, briefly explain what your change
 does and why it's needed. A change summary of ``"Fixes stuff"`` will be
 rejected.
 
 .. warning::
    An empty change summary body is not permitted. Even for trivial changes,
-   please include a summary body in the commit message.
+   include a summary body in the commit message.
 
 The description body of the commit message must include:
 

doc/developer-guides/doc_guidelines.rst

@@ -311,9 +311,9 @@ creates a hyperlink to that file in the current branch.  For example, a GitHub
 link to the reST file used to create this document can be generated
 using ``:acrn_file:`doc/developer-guides/doc_guidelines.rst```, which will
 appear as :acrn_file:`doc/developer-guides/doc_guidelines.rst`, a link to
-the “blob” file in the GitHub repo as displayed by GitHub. There’s also an
+the "blob" file in the GitHub repo as displayed by GitHub. There's also an
 ``:acrn_raw:`doc/developer-guides/doc_guidelines.rst``` role that will link
-to the “raw” uninterpreted file,
+to the "raw" uninterpreted file,
 :acrn_raw:`doc/developer-guides/doc_guidelines.rst` file. (Click these links
 to see the difference.)
 

doc/developer-guides/graphviz.rst

@@ -5,13 +5,13 @@ Drawings Using Graphviz
 
 We support using the Sphinx `graphviz extension`_ for creating simple
 graphs and line drawings using the dot language.  The advantage of using
-graphviz for drawings is that the source for a drawing is a text file that
+Graphviz for drawings is that the source for a drawing is a text file that
 can be edited and maintained in the repo along with the documentation.
 
 .. _graphviz extension: http://graphviz.gitlab.io
 
 These source ``.dot`` files are generally kept separate from the document
-itself, and included by using a graphviz directive:
+itself, and included by using a Graphviz directive:
 
 .. code-block:: none
 
@@ -38,7 +38,7 @@ the dot language and drawing options.
 Simple Directed Graph
 *********************
 
-For simple drawings with shapes and lines, you can put the graphviz commands
+For simple drawings with shapes and lines, you can put the Graphviz commands
 in the content block for the directive. For example, for a simple directed
 graph (digraph) with two nodes connected by an arrow, you can write:
 
@@ -108,7 +108,7 @@ are centered, left-justified, and right-justified, respectively.
 Finite-State Machine
 ********************
 
-Here's an example of using graphviz for defining a finite-state machine
+Here's an example of using Graphviz for defining a finite-state machine
 for pumping gas:
 
 .. literalinclude:: images/gaspump.dot