docs: mark KHR_blend_equation_advanced done on a6xx
[mesa.git] / docs / meson.html
index 7ffef817f426ca9ec127d6e95dc460254ce68e71..ad954c1cc31afe60ae5efbaa66464248d30ac895 100644 (file)
@@ -44,7 +44,7 @@ or
 sudo dnf install meson   # Fedora
 </pre>
 
-<p><strong>Mesa requires Meson >= 0.45.0 to build.</strong>
+<p><strong>Mesa requires Meson &gt;= 0.45.0 to build.</strong>
 
 Some older versions of meson do not check that they are too old and will error
 out in odd ways.
@@ -76,8 +76,6 @@ separate build directory</a> for each configuration you might want to use.
 
 
 
-</p>
-
 <p>Basic configuration is done with:</p>
 
 <pre>
@@ -103,7 +101,8 @@ running "meson build/" but this feature is being discussed upstream.
 For now, we have a <code>bin/meson-options.py</code> script that prints
 the options for you.
 If that script doesn't work for some reason, you can always look in the
-<code>meson_options.txt</code> file at the root of the project.
+<a href="https://gitlab.freedesktop.org/mesa/mesa/blob/master/meson_options.txt">
+meson_options.txt</a> file at the root of the project.
 </p>
 
 <p>
@@ -146,7 +145,7 @@ ninja -C build/ install
 </pre>
 
 <p>
-Note: autotools automatically updates translation files (used by the DRI
+Note: autotools automatically updated translation files (used by the DRI
 configuration tool) as part of the build process,
 Meson does not do this.  Instead, you will need do this:
 </p>
@@ -169,47 +168,66 @@ Developers will often want to install Mesa to a testing directory rather
 than the system library directory.
 This can be done with the --prefix option.  For example:
 </p>
-<code>
+<pre>
 meson --prefix="${PWD}/build/install" build/
-</code>
+</pre>
 <p>
 will put the final libraries and drivers into the build/install/
 directory.
 Then you can set LD_LIBRARY_PATH and LIBGL_DRIVERS_PATH to that location
 to run/test the driver.
 </p>
+<p>
+Meson also honors <code>DESTDIR</code> for installs.
+</p>
 </dd>
 
-<dt>Environment Variables</dt>
-<dd><p>Meson supports the standard CC and CXX environment variables for
-changing the default compiler. Meson does support CFLAGS, CXXFLAGS, etc. But
-their use is discouraged because of the many caveats in using them. Instead it
-is recomended to use <code>-D${lang}_args</code> and
-<code>-D${lang}_link_args</code> instead. Among the benefits of these options
+<dt>Compiler Options</dt>
+<dd>
+<p>Meson supports the common CFLAGS, CXXFLAGS, etc. environment
+variables but their use is discouraged because of the many caveats
+in using them.
+</p>
+<p>Instead, it is recomended to use <code>-D${lang}_args</code> and
+<code>-D${lang}_link_args</code>. Among the benefits of these options
 is that they are guaranteed to persist across rebuilds and reconfigurations.
+</p>
+<p>
+This example sets -fmax-errors for compiling C sources and -DMAGIC=123
+for C++ sources:
+</p>
+<pre>
+meson builddir/ -Dc_args=-fmax-errors=10 -Dcpp_args=-DMAGIC=123
+</pre>
+</dd>
 
-Meson does not allow changing compiler in a configured builddir, you will need
+
+<dt>Compiler Specification</dt>
+<dd>
+<p>
+Meson supports the standard CC and CXX environment variables for
+changing the default compiler.  Note that Meson does not allow
+changing the compilers in a configured builddir so you will need
 to create a new build dir for a different compiler.
 </p>
-
+<p>
+This is an example of specifying the clang compilers and cleaning
+the build directory before reconfiguring with an extra C option:
+</p>
 <pre>
-    CC=clang CXX=clang++ meson build-clang
-    ninja -C build-clang
-    ninja -C build-clang clean
-    meson configure build -Dc_args="-Wno-typedef-redefinition"
-    ninja -C build-clang
+CC=clang CXX=clang++ meson build-clang
+ninja -C build-clang
+ninja -C build-clang clean
+meson configure build -Dc_args="-Wno-typedef-redefinition"
+ninja -C build-clang
 </pre>
-
 <p>
 The default compilers depends on your operating system. Meson supports most of
 the popular compilers, a complete list is available
 <a href="http://mesonbuild.com/Reference-tables.html#compiler-ids">here</a>.
 </p>
-
-<p>Meson also honors <code>DESTDIR</code> for installs</p>
 </dd>
 
-
 <dt>LLVM</dt>
 <dd><p>Meson includes upstream logic to wrap llvm-config using its standard
 dependency interface.
@@ -221,6 +239,7 @@ As of meson 0.49.0 meson also has the concept of a
 these files provide information about the native build environment (as opposed
 to a cross build environment). They are ini formatted and can override where to
 find llvm-config:
+</p>
 
 custom-llvm.ini
 <pre>
@@ -233,38 +252,36 @@ Then configure meson:
 <pre>
     meson builddir/ --native-file custom-llvm.ini
 </pre>
-</p></dd>
+</dd>
 
 <dd><p>
 For selecting llvm-config for cross compiling a
 <a href="https://mesonbuild.com/Cross-compilation.html#defining-the-environment">"cross file"</a>
 should be used. It uses the same format as the native file above:
+</p>
 
-cross-llvm.ini
+<p>cross-llvm.ini</p>
 <pre>
     [binaries]
     ...
     llvm-config = '/usr/lib/llvm-config-32'
 </pre>
 
-Then configure meson:
-
+<p>Then configure meson:</p>
 <pre>
     meson builddir/ --cross-file cross-llvm.ini
 </pre>
 
 See the <a href="#cross-compilation">Cross Compilation</a> section for more information.
-</dd></p>
+</dd>
 
 <dd><p>
 For older versions of meson <code>$PATH</code> (or <code>%PATH%</code> on
 windows) will be searched for llvm-config (and llvm-config$version and
 llvm-config-$version), you can override this environment variable to control
 the search: <code>PATH=/path/with/llvm-config:$PATH meson build</code>.
-</dd></p>
-</dl>
+</p></dd>
 
-<dl>
 <dt><code>PKG_CONFIG_PATH</code></dt>
 <dd><p>The
 <code>pkg-config</code> utility is a hard requirement for configuring and
@@ -300,9 +317,7 @@ with debugging as some code and validation will be optimized away.
 buildtype, which causes meson to inject no additional compiler arguments, only
 those in the C/CXXFLAGS and those that mesa itself defines.</p>
 </dd>
-</dl>
 
-<dl>
 <dt><code>-Db_ndebug</code></dt>
 <dd><p>This option controls assertions in meson projects. When set to <code>false</code>
 (the default) assertions are enabled, when set to true they are disabled. This
@@ -330,14 +345,15 @@ will likely have to alter them for your system.</p>
 <p>
 Those running on ArchLinux can use the AUR-maintained packages for some
 of those, as they'll have the right values for your system:
+</p>
 <ul>
   <li><a href="https://aur.archlinux.org/packages/meson-cross-x86-linux-gnu">meson-cross-x86-linux-gnu</a></li>
   <li><a href="https://aur.archlinux.org/packages/meson-cross-aarch64-linux-gnu">meson-cross-aarch64-linux-gnu</a></li>
 </ul>
-</p>
 
 <p>
 32-bit build on x86 linux:
+</p>
 <pre>
 [binaries]
 c = '/usr/bin/gcc'
@@ -359,10 +375,10 @@ cpu_family = 'x86'
 cpu = 'i686'
 endian = 'little'
 </pre>
-</p>
 
 <p>
 64-bit build on ARM linux:
+</p>
 <pre>
 [binaries]
 c = '/usr/bin/aarch64-linux-gnu-gcc'
@@ -378,10 +394,10 @@ cpu_family = 'aarch64'
 cpu = 'aarch64'
 endian = 'little'
 </pre>
-</p>
 
 <p>
 64-bit build on x86 windows:
+</p>
 <pre>
 [binaries]
 c = '/usr/bin/x86_64-w64-mingw32-gcc'
@@ -397,7 +413,6 @@ cpu_family = 'x86_64'
 cpu = 'i686'
 endian = 'little'
 </pre>
-</p>
 
 </div>
 </body>