From f3dd19dea7a268747e1c4b382ea884e47ffa18fb Mon Sep 17 00:00:00 2001 From: "David B. Kinder" Date: Mon, 21 Jun 2021 11:35:59 -0700 Subject: [PATCH] doc: fix renaming of getting started guide Tweak references to account for renaming the getting started guide in PR #6226 and create a redirect link from the previous filename. Signed-off-by: David B. Kinder --- doc/conf.py | 20 ++------------------ doc/getting-started/getting-started.rst | 6 +++++- doc/reference/hardware.rst | 2 +- doc/tutorials/gpu-passthru.rst | 2 +- doc/tutorials/nvmx_virtualization.rst | 4 ++-- doc/tutorials/pre-launched-rt.rst | 4 ++-- doc/tutorials/run_kata_containers.rst | 4 ++-- doc/tutorials/using_windows_as_uos.rst | 2 +- 8 files changed, 16 insertions(+), 28 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 065fca55a..cdb3bf8e3 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -389,22 +389,6 @@ html_redirect_pages = [ ('user-guides/index', 'develop'), ('hardware', 'reference/hardware'), ('release_notes', 'release_notes/index'), - ('getting-started/rt_industry', 'tutorials/cl_servicevm'), - ('tutorials/acrn-dm_QoS', 'nocl'), - ('tutorials/acrn_ootb', 'nocl'), - ('tutorials/agl-vms', 'nocl'), - ('tutorials/building_acrn_in_docker', 'nocl'), - ('tutorials/building_uos_from_clearlinux', 'nocl'), - ('tutorials/cl_servicevm', 'nocl'), - ('tutorials/enable_laag_secure_boot', 'nocl'), - ('tutorials/increase_uos_disk_size', 'nocl'), - ('tutorials/kbl-nuc-sdc', 'nocl'), - ('tutorials/open_vswitch', 'nocl'), - ('tutorials/running_deb_as_serv_vm', 'nocl'), - ('tutorials/sign_clear_linux_image', 'nocl'), - ('tutorials/static-ip', 'nocl'), - ('tutorials/up2', 'nocl'), - ('tutorials/using_celadon_as_uos', 'nocl'), - ('tutorials/using_sbl_on_up2', 'nocl'), - ('tutorials/using_ubuntu_as_sos', 'nocl'), + ('getting-started/rt_industry', 'getting_started/getting_started'), + ('getting-started/rt_industry_ubuntu', 'getting_started/getting_started'), ] diff --git a/doc/getting-started/getting-started.rst b/doc/getting-started/getting-started.rst index 489c5550c..c16a1a10d 100644 --- a/doc/getting-started/getting-started.rst +++ b/doc/getting-started/getting-started.rst @@ -1,3 +1,4 @@ +.. _gsg: .. _rt_industry_ubuntu_setup: Getting Started Guide @@ -29,7 +30,8 @@ Verified Version - HW: Intel NUC 11 Pro Kit NUC11TNHi5 (`NUC11TNHi5 `_) -.. note:: This NUC is based on the `NUC11TNBi5 board `_. +.. note:: This NUC is based on the + `NUC11TNBi5 board `_. The ``BOARD`` parameter that is used to build ACRN for this NUC is therefore ``nuc11tnbi5``. Prerequisites @@ -248,6 +250,8 @@ Install the Service VM Kernel and Modules $ sudo make modules_install $ sudo cp arch/x86/boot/bzImage /boot/bzImage +.. _gsg_update_grub: + Update Grub for the Ubuntu Service VM ===================================== diff --git a/doc/reference/hardware.rst b/doc/reference/hardware.rst index 90a8fe47d..4b4d92ac7 100644 --- a/doc/reference/hardware.rst +++ b/doc/reference/hardware.rst @@ -70,7 +70,7 @@ release version and may not work as expected on later ACRN releases. https://up-shop.org/home/270-up-squared.html -For general instructions setting up ACRN on supported hardware platforms, visit the :ref:`rt_industry_ubuntu_setup` page. +For general instructions setting up ACRN on supported hardware platforms, visit the :ref:`gsg` page. .. list-table:: Supported Target Platforms :widths: 20 20 12 5 5 diff --git a/doc/tutorials/gpu-passthru.rst b/doc/tutorials/gpu-passthru.rst index c689e74b2..e1a153376 100644 --- a/doc/tutorials/gpu-passthru.rst +++ b/doc/tutorials/gpu-passthru.rst @@ -28,7 +28,7 @@ Verified Version Prerequisites ************* -Follow :ref:`these instructions ` to set up +Follow :ref:`these instructions ` to set up Ubuntu as the ACRN Service VM. Supported Hardware Platform diff --git a/doc/tutorials/nvmx_virtualization.rst b/doc/tutorials/nvmx_virtualization.rst index 34dfb3f8b..685e7f5b7 100644 --- a/doc/tutorials/nvmx_virtualization.rst +++ b/doc/tutorials/nvmx_virtualization.rst @@ -169,7 +169,7 @@ Prepare for Service VM Kernel and rootfs The service VM can run Ubuntu or other Linux distributions. Instructions on how to boot Ubuntu as the Service VM can be found in -:ref:`rt_industry_ubuntu_setup`. +:ref:`gsg`. The Service VM kernel needs to be built from the ``acrn-kernel`` repo, and some changes to the kernel ``.config`` are needed. @@ -195,7 +195,7 @@ guests on the Service VM: CONFIG_ACRN_GUEST=y After you made these configuration modifications, build and install the kernel -as described in :ref:`rt_industry_ubuntu_setup`. +as described in :ref:`gsg`. Launch a Nested Guest VM diff --git a/doc/tutorials/pre-launched-rt.rst b/doc/tutorials/pre-launched-rt.rst index 6e4cc6cd5..4687c34f5 100644 --- a/doc/tutorials/pre-launched-rt.rst +++ b/doc/tutorials/pre-launched-rt.rst @@ -44,7 +44,7 @@ kernels are loaded as multiboot modules. The ACRN hypervisor, Service VM, and Pre-Launched RT kernel images are all located on the NVMe drive. We recommend installing Ubuntu on the NVMe drive as the Service VM OS, which also has the required GRUB image to launch Pre-Launched RT mode. -Refer to :ref:`rt_industry_ubuntu_setup`, to +Refer to :ref:`gsg`, to install Ubuntu on the NVMe drive, and use grub to launch the Service VM. Install Pre-Launched RT Filesystem on SATA and Kernel Image on NVMe @@ -83,7 +83,7 @@ Add Pre-Launched RT Kernel Image to GRUB Config The last step is to modify the GRUB configuration file to load the Pre-Launched kernel. (For more information about this, see :ref:`Update Grub for the Ubuntu Service VM -`.) The grub config file will look something +` section in the :ref:`gsg`.) The grub config file will look something like this: .. code-block:: none diff --git a/doc/tutorials/run_kata_containers.rst b/doc/tutorials/run_kata_containers.rst index aac0450ba..29cb7d281 100644 --- a/doc/tutorials/run_kata_containers.rst +++ b/doc/tutorials/run_kata_containers.rst @@ -18,7 +18,7 @@ Prerequisites #. Refer to the :ref:`ACRN supported hardware `. #. For a default prebuilt ACRN binary in the end-to-end (E2E) package, you must have 4 CPU cores or enable "CPU Hyper-threading" in order to have 4 CPU threads for 2 CPU cores. -#. Follow the :ref:`rt_industry_ubuntu_setup` to set up the ACRN Service VM +#. Follow the :ref:`gsg` to set up the ACRN Service VM based on Ubuntu. #. This tutorial is validated on the following configurations: @@ -75,7 +75,7 @@ to automate the Kata Containers installation procedure. $ sudo cp build/misc/tools/acrnctl /usr/bin/ .. note:: This assumes you have built ACRN on this machine following the - instructions in the :ref:`rt_industry_ubuntu_setup`. + instructions in the :ref:`gsg`. #. Modify the :ref:`daemon.json` file in order to: diff --git a/doc/tutorials/using_windows_as_uos.rst b/doc/tutorials/using_windows_as_uos.rst index 179501961..a1297c15d 100644 --- a/doc/tutorials/using_windows_as_uos.rst +++ b/doc/tutorials/using_windows_as_uos.rst @@ -11,7 +11,7 @@ ACRN hypervisor. ACRN Service VM Setup ********************* -Follow the steps in this :ref:`rt_industry_ubuntu_setup` to set up ACRN +Follow the steps in this :ref:`gsg` to set up ACRN based on Ubuntu and launch the Service VM. Setup for Using Windows as the Guest VM