Module: Mesa
Branch: main
Commit: e316416dd0d4398e3fd3c4970325477566a4e637
URL:    
http://cgit.freedesktop.org/mesa/mesa/commit/?id=e316416dd0d4398e3fd3c4970325477566a4e637

Author: Eric Engestrom <[email protected]>
Date:   Wed Feb 22 15:43:57 2023 +0000

docs: include explicit `setup` in instructions

The implicit `meson builddir/` is deprecated, and while we have fixed
our scripts, we forgot to update the docs we give our users ^^'

Signed-off-by: Eric Engestrom <[email protected]>
Reviewed-by: Emma Anholt <[email protected]>
Reviewed-by: Erik Faye-Lund <[email protected]>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/21468>

---

 docs/android.rst |  2 +-
 docs/install.rst |  8 ++++----
 docs/meson.rst   | 14 +++++++-------
 docs/osmesa.rst  |  2 +-
 4 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/docs/android.rst b/docs/android.rst
index 06379f683ce..b96d43c05e5 100644
--- a/docs/android.rst
+++ b/docs/android.rst
@@ -41,7 +41,7 @@ one cross-compiling the turnip driver for a stock Pixel phone)
 
 .. code-block:: console
 
-    meson build-android-aarch64 \
+    meson setup build-android-aarch64 \
         --cross-file android-aarch64 \
        -Dplatforms=android \
        -Dplatform-sdk-version=26 \
diff --git a/docs/install.rst b/docs/install.rst
index 13964ee3395..7fc3b3afbfe 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -86,7 +86,7 @@ The general approach is:
 
 .. code-block:: console
 
-     meson builddir/
+     meson setup builddir/
      ninja -C builddir/
      sudo ninja -C builddir/ install
 
@@ -94,7 +94,7 @@ On Windows you can also use the Visual Studio backend
 
 .. code-block:: console
 
-     meson builddir --backend=vs
+     meson setup builddir --backend=vs
      cd builddir
      msbuild mesa.sln /m
 
@@ -115,7 +115,7 @@ First, configure Mesa and install in the temporary location:
 
 .. code-block:: console
 
-   meson builddir/ -Dprefix="$MESA_INSTALLDIR" OTHER_OPTIONS
+   meson setup builddir/ -Dprefix="$MESA_INSTALLDIR" OTHER_OPTIONS
    ninja -C builddir/ install
 
 where ``OTHER_OPTIONS`` is replaced by any meson configuration options you may
@@ -124,7 +124,7 @@ like this:
 
 .. code-block:: console
 
-   meson builddir/ -Dprefix="$MESA_INSTALLDIR" \
+   meson setup builddir/ -Dprefix="$MESA_INSTALLDIR" \
       -Dgallium-drivers=swrast -Dvulkan-drivers=swrast
    ninja -C builddir/ install
 
diff --git a/docs/meson.rst b/docs/meson.rst
index ffcd99ffe6b..ff5be73c8f0 100644
--- a/docs/meson.rst
+++ b/docs/meson.rst
@@ -92,7 +92,7 @@ Basic configuration is done with:
 
 .. code-block:: console
 
-   meson build/
+   meson setup build/
 
 This will create the build directory. If any dependencies are missing,
 you can install them, or try to remove the dependency with a Meson
@@ -105,7 +105,7 @@ To review the options which Meson chose, run:
    meson configure build/
 
 Meson does not currently support listing configuration options before
-running "meson build/" but this feature is being discussed upstream. For
+running ``meson setup build/`` but this feature is being discussed upstream. 
For
 now, we have a ``bin/meson-options.py`` script that prints the options
 for you. If that script doesn't work for some reason, you can always
 look in the
@@ -197,7 +197,7 @@ for C++ sources:
 
 .. code-block:: console
 
-   meson builddir/ -Dc_args=-fmax-errors=10 -Dcpp_args=-DMAGIC=123
+   meson setup builddir/ -Dc_args=-fmax-errors=10 -Dcpp_args=-DMAGIC=123
 
 Compiler Specification
 ^^^^^^^^^^^^^^^^^^^^^^
@@ -212,7 +212,7 @@ build directory before reconfiguring with an extra C option:
 
 .. code-block:: console
 
-   CC=clang CXX=clang++ meson build-clang
+   CC=clang CXX=clang++ meson setup build-clang
    ninja -C build-clang
    ninja -C build-clang clean
    meson configure build -Dc_args="-Wno-typedef-redefinition"
@@ -236,7 +236,7 @@ For example:
 
 .. code-block:: console
 
-   meson builddir -Dcmake_module_path=/home/user/mycmake/prefix
+   meson setup builddir -Dcmake_module_path=/home/user/mycmake/prefix
 
 As of Meson 0.49.0 Meson also has the concept of a `"native
 file" <https://mesonbuild.com/Native-environments.html>`__, these files
@@ -254,7 +254,7 @@ Then configure Meson:
 
 .. code-block:: console
 
-   meson builddir/ --native-file custom-llvm.ini
+   meson setup builddir/ --native-file custom-llvm.ini
 
 For selecting llvm-config for cross compiling a `"cross
 file" 
<https://mesonbuild.com/Cross-compilation.html#defining-the-environment>`__
@@ -274,7 +274,7 @@ Then configure Meson:
 
 .. code-block:: console
 
-   meson builddir/ --cross-file cross-llvm.ini
+   meson setup builddir/ --cross-file cross-llvm.ini
 
 See the :ref:`Cross Compilation <cross-compilation>` section for more
 information.
diff --git a/docs/osmesa.rst b/docs/osmesa.rst
index 1f4df635ae1..54eeb4fd1f4 100644
--- a/docs/osmesa.rst
+++ b/docs/osmesa.rst
@@ -25,7 +25,7 @@ Configure and build Mesa with something like:
 
 .. code-block:: console
 
-   meson builddir -Dosmesa=true -Dgallium-drivers=swrast -Dvulkan-drivers=[] 
-Dprefix=$PWD/builddir/install
+   meson setup builddir -Dosmesa=true -Dgallium-drivers=swrast 
-Dvulkan-drivers=[] -Dprefix=$PWD/builddir/install
    ninja -C builddir install
 
 Make sure you have LLVM installed first if you want to use the LLVMpipe

Reply via email to