]> git.ipfire.org Git - thirdparty/dbus.git/commitdiff
README: update for meson build-sys
authorMarc-André Lureau <marcandre.lureau@redhat.com>
Wed, 25 May 2022 09:29:40 +0000 (11:29 +0200)
committerSimon McVittie <smcv@collabora.com>
Wed, 13 Jul 2022 19:36:13 +0000 (20:36 +0100)
README

diff --git a/README b/README
index fe16284bacb6b1fc0a8c6a89454355d5f462b1e4..183ee49a76d9300755d7f39d011f71ce5e59520c 100644 (file)
--- a/README
+++ b/README
@@ -80,28 +80,62 @@ Development snapshots make no ABI stability guarantees for new ABI
 introduced since the last stable release. Development snapshots are
 likely to have more bugs than stable releases, obviously.
 
-Configuration 
+Configuration
 ===
 
-dbus could be build by using autotools or cmake. 
+This branch of dbus can be built by using Autotools, CMake or Meson.
+The Meson build system is currently considered experimental, but is
+likely to become the recommended build system in future.
 
-When using autotools the configure step is initiated by running ./configure 
+Older versions of dbus required Autotools or CMake, with Autotools
+recommended for Unix systems and CMake recommended for Windows systems.
+
+When using Autotools, the configure step is initiated by running ./configure
 with or without additional configuration flags. dbus requires GNU Make
 (on BSD systems, this is typically called gmake) or a "make" implementation
 with compatible extensions.
 
-When using cmake the configure step is initiated by running the cmake 
-program with or without additional configuration flags. 
+When using CMake, the configure step is initiated by running the cmake
+program with or without additional configuration flags.
+
+Meson only supports out-of-tree builds, and must be passed a directory to put
+built and generated sources into. We'll call that directory "build" here. It's
+recommended to create a separate build directory for each configuration you
+might want to use.
+
+Basic configuration is done with:
+
+``` sh
+meson 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 configuration option
+(see below).
 
 Configuration flags
 ===
 
-When using autotools, run "./configure --help" to see the possible
+When using Autotools, run "./configure --help" to see the possible
 configuration options and environment variables.
 
-When using cmake, inspect README.cmake to see the possible
+When using CMake, inspect README.cmake to see the possible
 configuration options and environment variables.
-    
+
+When using Meson, to review the options which Meson chose, run:
+
+``` sh
+meson configure build/
+```
+
+With additional arguments meson configure can be used to change options for a
+previously configured build directory. All options passed to this command are in
+the form `-D "option"="value"`. For example:
+
+``` sh
+meson configure build/ -Dprefix=/tmp/install
+```
+
 API/ABI Policy
 ===