From 0759a7664b8cdf90a4b7b14f5734a70a6c9f72d0 Mon Sep 17 00:00:00 2001 From: Jonathan Rubenstein Date: Sat, 16 Apr 2022 17:03:25 +0300 Subject: [PATCH] [doc] build: Change Client Building notes to full cmake commands This may help novices or people who have trouble constructing the commands themselves --- doc/build.rst | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/doc/build.rst b/doc/build.rst index 5906d77c..57be0522 100644 --- a/doc/build.rst +++ b/doc/build.rst @@ -177,17 +177,26 @@ it directly from the build directory: .. note:: - For users running GNOME on Wayland, you likely want to pass - ``-DENABLE_LIBDECOR=ON`` to ``cmake``, i.e. run ``cmake -DENABLE_LIBDECOR=ON ../``. + For users running GNOME on Wayland, you may want to enable libdecor when + building. + + .. code:: bash + + cmake -DENABLE_LIBDECOR=ON ../ For details, see :ref:`the FAQ `. .. note:: - The most common compile error is related to backtrace support. This can be - disabled by adding the following option to the cmake command: - ``-DENABLE_BACKTRACE=0``. However, if you disable this and need support for - a crash, use ``gdb`` to obtain a backtrace manually. + The most common compile error is related to backtrace support. Try disabling + this when building: + + .. code:: bash + + cmake -DENABLE_BACKTRACE=0 ../ + + If you disable this and need support for crash, use ``gdb`` to obtain a + backtrace manually. .. _host_building: