From 46d6883a13717b4d91e31f76176cb74f66691d1c Mon Sep 17 00:00:00 2001 From: Eric Engestrom Date: Wed, 24 Apr 2019 13:16:57 +0100 Subject: [PATCH] docs: replace autotools intructions with meson equivalent Signed-off-by: Eric Engestrom Reviewed-by: Dylan Baker --- docs/debugging.html | 8 ++------ docs/devinfo.html | 2 +- docs/egl.html | 39 ++++++++++++++++--------------------- docs/faq.html | 12 ++++++------ docs/install.html | 2 +- docs/llvmpipe.html | 8 +++++--- docs/opengles.html | 4 ++-- docs/releasing.html | 4 ++-- docs/sourcetree.html | 2 +- docs/submittingpatches.html | 8 ++++---- 10 files changed, 41 insertions(+), 48 deletions(-) diff --git a/docs/debugging.html b/docs/debugging.html index 76d0a4aa533..43c29dbc70a 100644 --- a/docs/debugging.html +++ b/docs/debugging.html @@ -26,12 +26,8 @@

- More extensive error checking is done when Mesa is compiled with the - DEBUG symbol defined. You'll have to edit the Make-config file and - add -DDEBUG to the CFLAGS line for your system configuration. You may - also want to replace any optimization flags with the -g flag so you can - use your debugger. After you've edited Make-config type 'make clean' - before recompiling. + More extensive error checking is done in DEBUG builds + (--buildtype debug for meson, build=debug for scons).

In your debugger you can set a breakpoint in _mesa_error() to trap Mesa diff --git a/docs/devinfo.html b/docs/devinfo.html index c6e97c68a62..02d6473266f 100644 --- a/docs/devinfo.html +++ b/docs/devinfo.html @@ -70,7 +70,7 @@ To add a new GL extension to Mesa you have to do at least the following.

  • The dispatch tests check_table.cpp and dispatch_sanity.cpp should be updated with details about the new extensions functions. These - tests are run using 'make check' + tests are run using 'meson test'

    • diff --git a/docs/egl.html b/docs/egl.html index 2bc8f237272..915a0e7d9f8 100644 --- a/docs/egl.html +++ b/docs/egl.html @@ -33,13 +33,16 @@ directly dispatched to the drivers.

    1. -

      Run configure with the desired client APIs and enable -the driver for your hardware. For example

      +

      Configure your build with the desired client APIs and enable +the driver for your hardware. For example:

      -  $ ./configure --enable-gles1 --enable-gles2 \
-                --with-dri-drivers=... \
-                --with-gallium-drivers=...
+$ meson configure \
+        -D egl=true \
+        -D gles1=true \
+        -D gles2=true \
+        -D dri-drivers=... \
+        -D gallium-drivers=...

      The main library and OpenGL is enabled by default. The first two options @@ -61,7 +64,7 @@ or more EGL drivers.

      time

      -
      --enable-egl
      +
      -D egl=true

      By default, EGL is enabled. When disabled, the main library and the drivers @@ -69,19 +72,11 @@ will not be built.

      -
      --with-egl-driver-dir
      -
      - -

      The directory EGL drivers should be installed to. If not specified, EGL -drivers will be installed to ${libdir}/egl.

      - -
      - -
      --with-platforms
      +
      -D platforms=...

      List the platforms (window systems) to support. Its argument is a comma -separated string such as --with-platforms=x11,drm. It decides +separated string such as -D platforms=x11,drm. It decides the platforms a driver may support. The first listed platform is also used by the main library to decide the native platform.

      @@ -90,15 +85,15 @@ the main library to decide the native platform.

      and haiku. The android platform can either be built as a system component, part of AOSP, using Android.mk files, or -cross-compiled using appropriate configure options. +cross-compiled using appropriate options. The haiku platform can only be built with SCons. Unless for special needs, the build system should select the right platforms automatically.

      -
      --enable-gles1
      -
      --enable-gles2
      +
      -D gles1=true
      +
      -D gles2=true

      These options enable OpenGL ES support in OpenGL. The result is one big @@ -106,7 +101,7 @@ internal library that supports multiple APIs.

      -
      --enable-shared-glapi
      +
      -D shared-glapi=true

      By default, libGL has its own copy of libglapi. @@ -134,9 +129,9 @@ runtime

      This variable specifies the native platform. The valid values are the same -as those for --with-platforms. When the variable is not set, +as those for -D platforms=.... When the variable is not set, the main library uses the first platform listed in ---with-platforms as the native platform.

      +-D platforms=... as the native platform.

      Extensions like EGL_MESA_drm_display define new functions to create displays for non-native platforms. These extensions are usually used by diff --git a/docs/faq.html b/docs/faq.html index 6270a071dac..3d73706a198 100644 --- a/docs/faq.html +++ b/docs/faq.html @@ -236,22 +236,22 @@ Basically you'll want the following: Mesa version number.

      2. -When configuring Mesa, there are three autoconf options that affect the install +When configuring Mesa, there are three meson options that affect the install location that you should take care with: --prefix, ---libdir, and --with-dri-driverdir. To install Mesa +--libdir, and -D dri-drivers-path. To install Mesa into the system location where it will be available for all programs to use, set --prefix=/usr. Set --libdir to where your Linux distribution installs system libraries, usually either /usr/lib or -/usr/lib64. Set --with-dri-driverdir to the directory +/usr/lib64. Set -D dri-drivers-path to the directory where your Linux distribution installs DRI drivers. To find your system's DRI driver directory, try executing find /usr -type d -name dri. For example, if the find command listed /usr/lib64/dri, -then set --with-dri-driverdir=/usr/lib64/dri. +then set -D dri-drivers-path=/usr/lib64/dri.

      After determining the correct values for the install location, configure Mesa -with ./configure --prefix=/usr --libdir=xxx --with-dri-driverdir=xxx -and then install with sudo make install. +with meson configure --prefix=/usr --libdir=xxx -D dri-drivers-path=xxx +and then install with sudo ninja install.



      diff --git a/docs/install.html b/docs/install.html index 1f83f69faa0..be038904b32 100644 --- a/docs/install.html +++ b/docs/install.html @@ -238,7 +238,7 @@ versions of libGL and device drivers.

      7. Building OpenGL programs with pkg-config

      -Running make install will install package configuration files +Running ninja install will install package configuration files for the pkg-config utility.

      diff --git a/docs/llvmpipe.html b/docs/llvmpipe.html index 28c0c2b0015..aea5100cc13 100644 --- a/docs/llvmpipe.html +++ b/docs/llvmpipe.html @@ -120,10 +120,12 @@ To build everything on Linux invoke scons as: scons build=debug libgl-xlib -Alternatively, you can build it with autoconf/make with: +Alternatively, you can build it with meson with: 
      -  ./configure --enable-glx=gallium-xlib --with-gallium-drivers=swrast --disable-dri --disable-gbm --disable-egl
-  make
+  mkdir build
+  cd build
+  meson -D glx=gallium-xlib -D gallium-drivers=swrast
+  ninja
      but the rest of these instructions assume that scons is used. diff --git a/docs/opengles.html b/docs/opengles.html index 2872b248a41..6abf265fef9 100644 --- a/docs/opengles.html +++ b/docs/opengles.html @@ -25,7 +25,7 @@ https://www.khronos.org/opengles/.

      Build the Libraries

        -
      1. Run configure with --enable-gles1 --enable-gles2 and enable the Gallium driver for your hardware.
        2. +
      2. Run meson configure with -D gles1=true -D gles2=true and enable the Gallium driver for your hardware.
      3. Build and install Mesa as usual.
      @@ -33,7 +33,7 @@ Alternatively, if XCB-DRI2 is installed on the system, one can use egl_dri2 EGL driver with OpenGL|ES-enabled DRI drivers
        -
      1. Run configure with --enable-gles1 --enable-gles2.
        2. +
      2. Run meson configure with -D gles1=true -D gles2=true.
      3. Build and install Mesa as usual.
      diff --git a/docs/releasing.html b/docs/releasing.html index 25088e5ceb6..2dbd03bc6f3 100644 --- a/docs/releasing.html +++ b/docs/releasing.html @@ -136,7 +136,7 @@ well contained. Thus it cannot affect more than one driver/subsystem.

      The following must pass:

        -
      • make distcheck, scons and scons check +
      • meson test, scons and scons check
      • Testing with different version of system components - LLVM and others is also performed where possible.
      • As a general rule, testing with various combinations of configure @@ -251,7 +251,7 @@ stabilisation and bugfixing.

        -Note: Before doing a branch ensure that basic build and make check +Note: Before doing a branch ensure that basic build and meson test testing is done and there are little to-no issues.
        Ideally all of those should be tackled already. diff --git a/docs/sourcetree.html b/docs/sourcetree.html index 07c8ece6ea4..d2d12960643 100644 --- a/docs/sourcetree.html +++ b/docs/sourcetree.html @@ -158,7 +158,7 @@ each directory.

        • glx - The GLX library code for building libGL using DRI drivers.
        -
      • lib - hardlinks to most binaries as produced by make. +
      • lib - hardlinks to most binaries as produced by the build system. These (shortcuts) are used for development purposes in conjunction with LD_LIBRARY_PATH and/or LIBGL_DRIVERS_PATH.
      diff --git a/docs/submittingpatches.html b/docs/submittingpatches.html index 65af32d4bba..957fdcd5cdc 100644 --- a/docs/submittingpatches.html +++ b/docs/submittingpatches.html @@ -141,7 +141,7 @@ do whatever testing is prudent.

      You should always run the Mesa test suite before submitting patches. -The test suite can be run using the 'make check' command. All tests +The test suite can be run using the 'meson test' command. All tests must pass before patches will be accepted, this may mean you have to update the tests themselves.

      @@ -160,10 +160,10 @@ to run your tests on each commit. Assuming your branch is based off origin/master, you can run: 

      -$ git rebase --interactive --exec "make check" origin/master
+$ git rebase --interactive --exec "meson test -C build/" origin/master

      -replacing "make check" with whatever other test you want to +replacing "meson test" with whatever other test you want to run.

      @@ -466,7 +466,7 @@ within the commit summary.
    2. Test for build breakage between patches e.g last 8 commits. 
      -    git rebase -i --exec="make -j4" HEAD~8
+    git rebase -i --exec="ninja -C build/" HEAD~8
    3. Sets the default mailing address for your repo. 
      -- 
2.30.2