[doc] host: Touchups and sentence flow corrections

This commit is contained in:
Jonathan Rubenstein 2021-07-05 12:00:58 -04:00 committed by Geoffrey McRae
parent 733e634f4d
commit e2c3ffcbb4

View File

@ -3,18 +3,21 @@
Building Building
######## ########
The following instructions will help you build Looking Glass for yourself The following instructions will help you build Looking Glass from source code.
from source code. Before you attempt to do this, you should have a basic Before attempting this, you should have a basic understanding of
understanding of how to use the shell. how to use the shell.
.. _download_source: .. _download_source:
Downloading Downloading
----------- -----------
Either visit the Looking Glass website's `Download Visit the Looking Glass `Download Page <https://looking-glass.io/downloads>`__,
Page <https://looking-glass.io/downloads>`_, or pull the lastest **bleeding-edge and download the stable version (**recommended**).
version** with ``git``. You can also download a *bleeding-edge version*, or the latest RC version
during a Release Candidate cycle.
Developers can clone the source code repo with ``git``.
.. code:: bash .. code:: bash
@ -71,18 +74,18 @@ May be disabled
These dependencies are required by default, but may be omitted if their These dependencies are required by default, but may be omitted if their
feature is disabled when running :ref:`cmake <client_building>`. feature is disabled when running :ref:`cmake <client_building>`.
- Disable with ``cmake -DENABLE_BACKTRACE=no`` - Disable with ``cmake -DENABLE_BACKTRACE=no ..``
- binutils-dev - binutils-dev
- Disable with ``cmake -DENABLE_X11=no`` - Disable with ``cmake -DENABLE_X11=no ..``
- libx11-dev - libx11-dev
- libxfixes-dev - libxfixes-dev
- libxi-dev - libxi-dev
- libxss-dev - libxss-dev
- Disable with ``cmake -DENABLE_WAYLAND=no`` - Disable with ``cmake -DENABLE_WAYLAND=no ..``
- libwayland-bin - libwayland-bin
- libwayland-dev - libwayland-dev
@ -100,9 +103,9 @@ wayland-protocols``
Building Building
~~~~~~~~ ~~~~~~~~
If you've downloaded the source code as a zip file, simply unzip and cd into the If you've downloaded the source code as a zip file, simply unzip and ``cd``
new directory. If you've cloned the repo with ``git``, then ``cd`` into the into the new directory. If you've cloned the repo with ``git``, then ``cd``
'LookingGlass' directory. into the *LookingGlass* directory.
.. code:: bash .. code:: bash
@ -111,27 +114,28 @@ new directory. If you've cloned the repo with ``git``, then ``cd`` into the
cmake ../ cmake ../
make make
Should this all go well, you will build the **looking-glass-client**. This will build the **looking-glass-client** binary, which is used to display
frames from the guest.
.. seealso:: .. seealso::
:ref:`Installing the Client <client_install>` - :ref:`Installing the Client <client_install>`
- :ref:`Client Usage <client_usage>`
.. note:: .. note::
The most common compile error is related to backtrace support. This can be The most common compile error is related to backtrace support. This can be
disabled by adding the following option to the cmake command: disabled by adding the following option to the cmake command:
**-DENABLE_BACKTRACE=0**, however, if you disable this and need support for a ``-DENABLE_BACKTRACE=0``. However, if you disable this and need support for
crash please be sure to use gdb to obtain a backtrace manually or there is a crash, use ``gdb`` to obtain a backtrace manually.
nothing that can be done to help you.
.. _host_building: .. _host_building:
Host Host
---- ----
These instructions help you build the host yourself from the :ref:`downloaded These instructions help you build the host yourself from the
source code <download_source>`. :ref:`downloaded source code <download_source>`.
.. warning:: .. warning::
Building the host from source code is not recommended for most purposes, Building the host from source code is not recommended for most purposes,
@ -152,7 +156,9 @@ For Windows on Windows
1. Download and install msys2 x86_64 from 1. Download and install msys2 x86_64 from
`http://www.msys2.org/ <http://www.msys2.org/>`__ following the setup `http://www.msys2.org/ <http://www.msys2.org/>`__ following the setup
instructions provided instructions provided
2. Run the MSYS2 shell.
2. Run the MSYS2 shell
3. Download build dependencies with pacman 3. Download build dependencies with pacman
.. code:: bash .. code:: bash
@ -160,18 +166,14 @@ For Windows on Windows
pacman -Fy pacman -Fy
pacman -Sy git make mingw-w64-x86_64-gcc mingw-w64-x86_64-cmake pacman -Sy git make mingw-w64-x86_64-gcc mingw-w64-x86_64-cmake
4. Checkout the project 4. Change directory to the source tree with ``cd``
.. code:: bash
git clone https://github.com/gnif/LookingGlass.git
5. Configure the project and build it 5. Configure the project and build it
.. code:: bash .. code:: bash
mkdir LookingGlass/host/build mkdir host/build
cd LookingGlass/host/build cd host/build
cmake -G "MSYS Makefiles" .. cmake -G "MSYS Makefiles" ..
make make
@ -180,13 +182,12 @@ For Windows on Windows
For Linux on Linux For Linux on Linux
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
Make a ``host/build`` direstory, then run ``cmake`` Make a ``host/build`` directory, then run ``cmake``
.. code:: bash .. code:: bash
cd host mkdir host/build
mkdir build cd host/build
cd build
cmake .. cmake ..
make make
@ -195,14 +196,13 @@ Make a ``host/build`` direstory, then run ``cmake``
For Windows cross compiling on Linux For Windows cross compiling on Linux
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Like :ref:`host_linux_on_linux`, but specifying the mingw64 toolchain in cmake Like :ref:`host_linux_on_linux`, but using the mingw64 toolchain to
for building. cross-compile a Windows ``.exe`` file.
.. code:: bash .. code:: bash
cd host mkdir host/build
mkdir build cd host/build
cd build
cmake -DCMAKE_TOOLCHAIN_FILE=../toolchain-mingw64.cmake .. cmake -DCMAKE_TOOLCHAIN_FILE=../toolchain-mingw64.cmake ..
make make
@ -211,7 +211,7 @@ for building.
Building the Windows installer Building the Windows installer
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1. :ref:`Build <host_win_cross_on_linux>` the host for Linux. 1. :ref:`Build <host_win_cross_on_linux>` the host on Linux.
2. Install ``nsis`` 2. Install ``nsis``