summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorMarc-André Lureau <marcandre.lureau@redhat.com>2022-05-25 11:29:40 +0200
committerSimon McVittie <smcv@collabora.com>2022-07-13 20:36:13 +0100
commite7c1646661100ee46821cfbb55fc264fed85a8b5 (patch)
treebb2ce2f96407bc509a7a35c6835c2d9e47d2faa3 /README
parentcd2e38261058f552fc51e14e0ac5af93411b3de5 (diff)
downloaddbus-e7c1646661100ee46821cfbb55fc264fed85a8b5.tar.gz
README: update for meson build-sys
Diffstat (limited to 'README')
-rw-r--r--README50
1 files changed, 42 insertions, 8 deletions
diff --git a/README b/README
index fe16284b..183ee49a 100644
--- 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
===