diff --git a/doc/conf.py b/doc/conf.py index de50d07d8..0e9c2525b 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -389,4 +389,8 @@ html_redirect_pages = [ ('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'), + ('tutorials/using_vx_works_as_uos', 'tutorials/using_vx_works_as_user_vm'), + ('tutorials/using_xenomai_as_uos', 'tutorials/using_xenomai_as_user_vm'), + ('tutorials/using_zephyr_as_uos', 'tutorials/using_zephyr_as_user_vm'), + ('tutorials/using_windows_as_uos', 'tutorials/using_windows_as_user_vm') ] diff --git a/doc/develop.rst b/doc/develop.rst index 2c83fc04d..6c2f8326a 100644 --- a/doc/develop.rst +++ b/doc/develop.rst @@ -35,12 +35,12 @@ User VM Tutorials .. toctree:: :maxdepth: 1 - tutorials/using_windows_as_uos + tutorials/using_windows_as_user_vm tutorials/running_ubun_as_user_vm tutorials/running_deb_as_user_vm - tutorials/using_xenomai_as_uos - tutorials/using_vxworks_as_uos - tutorials/using_zephyr_as_uos + tutorials/using_xenomai_as_user_vm + tutorials/using_vxworks_as_user_vm + tutorials/using_zephyr_as_user_vm Configuration Tutorials *********************** diff --git a/doc/developer-guides/hld/hld-security.rst b/doc/developer-guides/hld/hld-security.rst index bc17debf3..131cf55df 100644 --- a/doc/developer-guides/hld/hld-security.rst +++ b/doc/developer-guides/hld/hld-security.rst @@ -254,7 +254,7 @@ In ACRN, User VM Secure Boot can be enabled as follows: #. Sign the User VM images with `db.key` and `db.crt`. #. Boot the User VM with Secure Boot enabled. -.. _sos_hardening: +.. _service_vm_hardening: Service VM Hardening -------------------- @@ -732,7 +732,7 @@ must be disabled in a production release. Users who want to use this feature must possess the private signing key to re-sign the image after enabling the configuration. -.. _uos_suspend_resume: +.. _user_vm_suspend_resume: User VM Suspend/Resume ~~~~~~~~~~~~~~~~~~~~~~ @@ -1041,7 +1041,7 @@ Note that there are some security considerations in this design: Keeping the Service VM system as secure as possible is a very important goal in the system security design. Follow the recommendations in -:ref:`sos_hardening`. +:ref:`service_vm_hardening`. SEED Derivation --------------- @@ -1065,7 +1065,7 @@ the restore state hypercall is called only by vBIOS when the User VM is ready to resume from suspend state. For security design considerations of handling secure world S3, -read the previous section: :ref:`uos_suspend_resume`. +read the previous section: :ref:`user_vm_suspend_resume`. Platform Security Feature Virtualization and Enablement ======================================================= diff --git a/doc/developer-guides/hld/images/network-virt-sos-infrastruct.png b/doc/developer-guides/hld/images/network-virt-service-vm-infrastruct.png similarity index 100% rename from doc/developer-guides/hld/images/network-virt-sos-infrastruct.png rename to doc/developer-guides/hld/images/network-virt-service-vm-infrastruct.png diff --git a/doc/developer-guides/hld/virtio-net.rst b/doc/developer-guides/hld/virtio-net.rst index c4d3428b7..14eb6e7c3 100644 --- a/doc/developer-guides/hld/virtio-net.rst +++ b/doc/developer-guides/hld/virtio-net.rst @@ -414,7 +414,7 @@ prepared in the Service VM before we start. We need to create a bridge and at least one TAP device (two TAP devices are needed to create a dual virtual NIC) and attach a physical NIC and TAP device to the bridge. -.. figure:: images/network-virt-sos-infrastruct.png +.. figure:: images/network-virt-service-vm-infrastruct.png :align: center :width: 900px :name: net-virt-infra diff --git a/doc/tutorials/using_hybrid_mode_on_nuc.rst b/doc/tutorials/using_hybrid_mode_on_nuc.rst index fb6b008cb..fc0a53de3 100644 --- a/doc/tutorials/using_hybrid_mode_on_nuc.rst +++ b/doc/tutorials/using_hybrid_mode_on_nuc.rst @@ -44,7 +44,7 @@ Prepare the Zephyr image Prepare the Zephyr kernel that you will run in VM0 later. -- Follow step 1 from the :ref:`using_zephyr_as_uos` instructions +- Follow step 1 from the :ref:`using_zephyr_as_user_vm` instructions .. note:: We only need the ELF binary Zephyr kernel, not the entire ``zephyr.img`` diff --git a/doc/tutorials/using_vxworks_as_uos.rst b/doc/tutorials/using_vxworks_as_user_vm.rst similarity index 99% rename from doc/tutorials/using_vxworks_as_uos.rst rename to doc/tutorials/using_vxworks_as_user_vm.rst index 0a1505d60..b570d5215 100644 --- a/doc/tutorials/using_vxworks_as_uos.rst +++ b/doc/tutorials/using_vxworks_as_user_vm.rst @@ -1,4 +1,5 @@ .. _using_vxworks_as_uos: +.. _using_vxworks_as_user_vm: Run VxWorks as the User VM ########################## diff --git a/doc/tutorials/using_windows_as_uos.rst b/doc/tutorials/using_windows_as_user_vm.rst similarity index 99% rename from doc/tutorials/using_windows_as_uos.rst rename to doc/tutorials/using_windows_as_user_vm.rst index 335157bdc..183cfaba3 100644 --- a/doc/tutorials/using_windows_as_uos.rst +++ b/doc/tutorials/using_windows_as_user_vm.rst @@ -1,5 +1,5 @@ .. _using_windows_as_uos: - +.. _using_windows_as_user_vm: Launch Windows as the Guest VM on ACRN ###################################### diff --git a/doc/tutorials/using_xenomai_as_uos.rst b/doc/tutorials/using_xenomai_as_user_vm.rst similarity index 99% rename from doc/tutorials/using_xenomai_as_uos.rst rename to doc/tutorials/using_xenomai_as_user_vm.rst index 404129b25..93327986f 100644 --- a/doc/tutorials/using_xenomai_as_uos.rst +++ b/doc/tutorials/using_xenomai_as_user_vm.rst @@ -1,4 +1,5 @@ .. _using_xenomai_as_uos: +.. _using_xenomai_as_user_vm: Run Xenomai as the User VM OS (Real-Time VM) ############################################ diff --git a/doc/tutorials/using_zephyr_as_uos.rst b/doc/tutorials/using_zephyr_as_user_vm.rst similarity index 99% rename from doc/tutorials/using_zephyr_as_uos.rst rename to doc/tutorials/using_zephyr_as_user_vm.rst index 7e16bf493..cb7a579cb 100644 --- a/doc/tutorials/using_zephyr_as_uos.rst +++ b/doc/tutorials/using_zephyr_as_user_vm.rst @@ -1,4 +1,5 @@ .. _using_zephyr_as_uos: +.. _using_zephyr_as_user_vm: Run Zephyr as the User VM #########################