Skip to content

Commit

Permalink
[doc] fix lack of consistency of Recommended
Browse files Browse the repository at this point in the history
  • Loading branch information
gnif committed Mar 9, 2024
1 parent da82076 commit a88783e
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 17 deletions.
2 changes: 1 addition & 1 deletion doc/build.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Downloading
-----------

Visit the Looking Glass `Download Page <https://looking-glass.io/downloads>`__,
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.

Expand Down
2 changes: 1 addition & 1 deletion doc/install_host.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <host_building>`.
Expand Down
18 changes: 3 additions & 15 deletions doc/ivshmem_kvmfr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
~~~~~~~~~~

Expand Down

0 comments on commit a88783e

Please sign in to comment.