[gtkmm-documentation] README files: meson is the recommended build system



commit 283298b4366f78e86a6c7ff51c89a9001c3bb8ca
Author: Kjell Ahlstedt <kjellahlstedt gmail com>
Date:   Mon May 20 13:07:48 2019 +0200

    README files: meson is the recommended build system
    
    * examples/book/buildapp/README:
    * README: meson, not autotools, is now the recommended build system.

 README                        | 28 +++++++++++++++++-----------
 examples/book/buildapp/README | 28 ++++++++++++++--------------
 2 files changed, 31 insertions(+), 25 deletions(-)
---
diff --git a/README b/README
index 7b80315..9328bea 100644
--- a/README
+++ b/README
@@ -3,34 +3,37 @@ See http://www.gtkmm.org/
 
 Building with meson
 -------------------
-This is experimental, but it's believed to work correctly.
-You're encouraged to test it.
-
 Create a build directory:
   $ cd gtkmm-documentation
-  $ meson <build-dir>
+  $ meson [options] <build-dir>
 Do not call the build-dir gtkmm-documentation/build. There is already such a
 directory, used when building with autotools.
 
+Print a list of configuration options:
+  $ cd <build-dir>
+  $ meson configure
+
+Example of changing options:
+  $ cd <build-dir>
+  $ meson configure --prefix=/opt/gnome -Dbuild-translations=true
+
 Create the html files of the tutorial:
   $ cd <build-dir>
   $ ninja
 
 Install them:
   $ ninja install
+If you have chosen to build translated XML files (build-translations=true),
+installation can take some time, because the translations are built
+by 'ninja install'. This may change in the future.
+See https://github.com/mesonbuild/meson/issues/2775
 
 Build the example programs:
   $ ninja examples
 or (probably slower)
   $ ninja test
 
-Print a list of configuration options:
-  $ meson configure
-
-Example of changing options:
-  $ meson configure --prefix=/opt/gnome -Dwarnings=fatal
-
-Create a PDF file
+Create a PDF file:
   $ meson -Dbuild-pdf=true
   $ ninja
 This requires that you have either the dblatex or the xmllint and docbook2pdf
@@ -38,6 +41,9 @@ commands installed.
 
 Make a tarball:
   $ ninja dist
+In addition to the files in the git repository, the tarball will contain some
+built files. These files must already exist. 'ninja dist' will fail, unless you
+have previously run 'ninja' and 'ninja install' with build-translations=true.
 
 This tarball is not identical to one made with "make dist" or "make distcheck".
 There is e.g. no "configure" file. If you want to use a tarball made with
diff --git a/examples/book/buildapp/README b/examples/book/buildapp/README
index f3da867..1040eeb 100644
--- a/examples/book/buildapp/README
+++ b/examples/book/buildapp/README
@@ -2,37 +2,37 @@
 
 == Building the examples ==
 
-The examples in this directory are built with 'make check' alongside the rest of
-the examples in gtkmm-documentation.
+The examples in this directory are built with 'ninja examples' or 'ninja test'
+alongside the rest of the examples in gtkmm-documentation.
 
 The examples in the step[1-9] directories can also be built separately.
-You can then choose to build with make or with meson and ninja.
+You can then choose to build with meson and ninja or with make.
 
-  $ cd step1  # or step2, step3, etc.
-  $ make -f Makefile.example
-or
   $ cd step1  # or step2, step3, etc.
   $ meson build  # or another name for the build directory
   $ cd build
   $ ninja
+or
+  $ cd step1  # or step2, step3, etc.
+  $ make -f Makefile.example
 
 To make gnome-shell use the desktop file and icon for one of the examples
 while running it uninstalled, do the following:
 
-  $ cd step1  # or step2, step3, etc.
-  $ make -f Makefile.example install-desktop-file
-or
   $ cd step1/build  # or step2/build, step3/build, etc.
   $ ninja install-desktop-file
+or
+  $ cd step1  # or step2, step3, etc.
+  $ make -f Makefile.example install-desktop-file
 
 To make Gio::Settings find the preferences in step[5-9], they must be stored
 where they can be found via one of the environment variables XDG_DATA_DIRS,
 XDG_DATA_HOME or GSETTINGS_SCHEMA_DIR. One way to achieve this is:
 
-  $ cd step5  # or step6, step7, etc.
+  $ cd step5/build  # or step6/build, step7/build, etc.
   $ export GSETTINGS_SCHEMA_DIR=.
 or
-  $ cd step5/build  # or step6/build, step7/build, etc.
+  $ cd step5  # or step6, step7, etc.
   $ export GSETTINGS_SCHEMA_DIR=.
 
 But then the program can only be run from that directory. Alternatively,
@@ -42,8 +42,8 @@ set GSETTINGS_SCHEMA_DIR to an absolute path, such as
 
 and do the following:
 
-  $ cd step5  # or step6, step7, etc.
-  $ make -f Makefile.example install-gschema-file
-or
   $ cd step5/build  # or step6/build, step7/build, etc.
   $ ninja install-gschema-file
+or
+  $ cd step5  # or step6, step7, etc.
+  $ make -f Makefile.example install-gschema-file


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]