From a88783e5b793fc4c3ff0937c4243deb2c91229fc Mon Sep 17 00:00:00 2001 From: Geoffrey McRae Date: Sat, 9 Mar 2024 11:14:51 +1100 Subject: [PATCH] [doc] fix lack of consistency of `Recommended` --- doc/build.rst | 2 +- doc/install_host.rst | 2 +- doc/ivshmem_kvmfr.rst | 18 +++--------------- 3 files changed, 5 insertions(+), 17 deletions(-) diff --git a/doc/build.rst b/doc/build.rst index d6b8717d..37621de7 100644 --- a/doc/build.rst +++ b/doc/build.rst @@ -13,7 +13,7 @@ Downloading ----------- Visit the Looking Glass `Download Page `__, -and download the stable version (**recommended**). +and download the stable version (**Recommended**). You can also download a *bleeding-edge version*, or the latest RC version during a Release Candidate cycle. diff --git a/doc/install_host.rst b/doc/install_host.rst index cdb98e64..ca0f1d53 100644 --- a/doc/install_host.rst +++ b/doc/install_host.rst @@ -11,7 +11,7 @@ Virtual Machine—through a low-latency transfer protocol over shared memory. You can get the host program in two ways: - Download a pre-built binary from https://looking-glass.io/downloads - (**recommended**) + (**Recommended**) - Download the source code as described in :ref:`building`, then :ref:`build the host `. diff --git a/doc/ivshmem_kvmfr.rst b/doc/ivshmem_kvmfr.rst index 2c0e87ab..2c1bd7a4 100644 --- a/doc/ivshmem_kvmfr.rst +++ b/doc/ivshmem_kvmfr.rst @@ -12,12 +12,12 @@ for Looking Glass allowing DMA GPU transfers. Prerequisites ------------- -The Linux kernel headers for your kernel version are required for building. -Install them with ``apt-get`` +The Linux kernel headers for your kernel version are required for building +along with `dkms` to manage the module when you upgrade your kernel. .. code:: bash - apt-get install linux-headers-$(uname -r) + apt-get install linux-headers-$(uname -r) dkms Then switch to the ``module/`` directory @@ -27,18 +27,6 @@ Then switch to the ``module/`` directory .. _ivshmem_kvmfr_dkms: -Using DKMS (recommended) ------------------------- - -You can use the kernel's DKMS feature to keep the module across upgrades. -``dkms`` must be installed. - -.. code:: bash - - apt-get install dkms - -.. _ivshmem_kvmfr_installing: - Installing ~~~~~~~~~~