#4244 refer to 'dev-env' in the documentation

Xpra-org · May 31, 2024 · 06496de · 06496de
1 parent daaf45e
commit 06496de
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 9 deletions.
diff --git a/docs/Build/Debian.md b/docs/Build/Debian.md
@@ -6,7 +6,28 @@ Debian and Ubuntu also ships xpra packages, though their _stable_ versions are c
 
 For general information, see [building](./README.md).
 
-## Build and runtime requirements
+## Build requirements
+The easiest way to install the build dependencies
+is using the `dev-env` build subcommand which will honour setup arguments. ie:
+```shell
+./setup.py dev-env --minimal --with-openh264
+```
+_(available in xpra v6.1 onwards)_
+
+
+Alternatively, you can install these sets yourself:
+<details>
+  <summary>Common dependencies</summary>
+
+To be able to run xpra, you are likely to need:
+```shell
+apt-get install xvfb python3-cairo python3-gi-cairo \
+    python3-opengl python3-pil
+```
+</details>
+<details>
+  <summary>X11</summary>
+
 ```shell
 apt-get install libx11-dev libxtst-dev libxcomposite-dev libxdamage-dev libxres-dev \
                 libxkbfile-dev \
@@ -15,19 +36,20 @@ apt-get install libx11-dev libxtst-dev libxcomposite-dev libxdamage-dev libxres-
                 libsystemd-dev \
                 liblz4-dev
 ```
-GTK3 for the server and GUI client:
-```shell
-apt-get install libgtk-3-dev python3-dev python3-cairo-dev python-gi-dev cython3
-```
-Also install some X11 utilities if not installed already:
+
+These X11 utilities are usually required at runtime:
 ```shell
 apt-get install xauth x11-xkb-utils
 ```
-To be able to run xpra, you are likely to need:
+</details>
+<details>
+  <summary>GTK3</summary>
+
+GTK3 toolkit for the server and GUI client:
 ```shell
-apt-get install xvfb python3-cairo python3-gi-cairo \
-    python3-opengl python3-pil
+apt-get install libgtk-3-dev python3-dev python3-cairo-dev python-gi-dev cython3
 ```
+</details>
 
 ### Optional:
 <details>

diff --git a/docs/Build/RPM.md b/docs/Build/RPM.md
@@ -20,6 +20,14 @@ dnf builddep xpra.spec
 ```
 You may also refer to the more generic list of [dependencies](./Dependencies.md)
 
+Alternatively, if you want to install a more limited set of build dependencies,
+you can use the `dev-env` build subcommand which will honour setup arguments. ie:
+```shell
+./setup.py dev-env --minimal --with-openh264
+```
+_(available in xpra v6.1 onwards)_
+
+
 ## Build
 ```shell
 python3 ./setup.py install