aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/Builtin-options.md2
-rw-r--r--docs/markdown/Gnome-module.md1
-rw-r--r--docs/markdown/Pkgconfig-module.md6
-rw-r--r--docs/markdown/Python-module.md4
-rw-r--r--docs/markdown/Reference-manual.md2
-rw-r--r--docs/markdown/Wrap-dependency-system-manual.md7
-rw-r--r--docs/markdown/images/buildtime.png (renamed from docs/images/buildtime.png)bin8764 -> 8764 bytes
-rw-r--r--docs/markdown/images/conftime.png (renamed from docs/images/conftime.png)bin10729 -> 10729 bytes
-rw-r--r--docs/markdown/images/emptytime.png (renamed from docs/images/emptytime.png)bin9960 -> 9960 bytes
-rw-r--r--docs/markdown/images/glib_build.png (renamed from docs/images/glib_build.png)bin10228 -> 10228 bytes
-rw-r--r--docs/markdown/images/glib_conf.png (renamed from docs/images/glib_conf.png)bin9186 -> 9186 bytes
-rw-r--r--docs/markdown/images/glib_empty.png (renamed from docs/images/glib_empty.png)bin8894 -> 8894 bytes
-rw-r--r--docs/markdown/images/glib_link.png (renamed from docs/images/glib_link.png)bin9057 -> 9057 bytes
-rw-r--r--docs/markdown/images/gtksample.png (renamed from docs/images/gtksample.png)bin3853 -> 3853 bytes
-rw-r--r--docs/markdown/images/py3-install-1.png (renamed from docs/images/py3-install-1.png)bin101763 -> 101763 bytes
-rw-r--r--docs/markdown/images/py3-install-2.png (renamed from docs/images/py3-install-2.png)bin99866 -> 99866 bytes
-rw-r--r--docs/markdown/images/py3-install-3.png (renamed from docs/images/py3-install-3.png)bin101063 -> 101063 bytes
-rw-r--r--docs/markdown/snippets/version_comparison.md15
-rw-r--r--docs/markdown/snippets/wrap_clone_recursive.md7
-rw-r--r--docs/meson.build5
20 files changed, 40 insertions, 9 deletions
diff --git a/docs/markdown/Builtin-options.md b/docs/markdown/Builtin-options.md
index 05578c7..55352aa 100644
--- a/docs/markdown/Builtin-options.md
+++ b/docs/markdown/Builtin-options.md
@@ -36,7 +36,7 @@ Installation options are all relative to the prefix, except:
| sysconfdir | etc | Sysconf data directory |
| localstatedir | var | Localstate data directory |
| sharedstatedir | com | Architecture-independent data directory |
-| werror | false | Treat warnings as erros |
+| werror | false | Treat warnings as errors |
| warnlevel {1, 2, 3} | 1 | Set the warning level. From 1 = lowest to 3 = highest |
| layout {mirror,flat} | mirror | Build directory layout. |
| default-library {shared, static, both} | shared | Default library type. |
diff --git a/docs/markdown/Gnome-module.md b/docs/markdown/Gnome-module.md
index cc85d87..8bf1b57 100644
--- a/docs/markdown/Gnome-module.md
+++ b/docs/markdown/Gnome-module.md
@@ -334,6 +334,7 @@ of the module.
* `mkdb_args`: a list of arguments to pass to `gtkdoc-mkdb`
* `scan_args`: a list of arguments to pass to `gtkdoc-scan`
* `scanobjs_args`: a list of arguments to pass to `gtkdoc-scangobj`
+* `c_args`: (*Added 0.48.0*) additional compile arguments to pass
* `src_dir`: include_directories to include
This creates a `$module-doc` target that can be ran to build docs and
diff --git a/docs/markdown/Pkgconfig-module.md b/docs/markdown/Pkgconfig-module.md
index 77db809..b727f1a 100644
--- a/docs/markdown/Pkgconfig-module.md
+++ b/docs/markdown/Pkgconfig-module.md
@@ -17,13 +17,13 @@ keyword arguments.
- `description` a string describing the library
- `extra_cflags` a list of extra compiler flags to be added to the
`Cflags` field after the header search path
-- `filebase`, the base name to use for the pkg-config file, as an
- example the value of `libfoo` would produce a pkg-config file called
+- `filebase` the base name to use for the pkg-config file; as an
+ example, the value of `libfoo` would produce a pkg-config file called
`libfoo.pc`
- `install_dir` the directory to install to, defaults to the value of
option `libdir` followed by `/pkgconfig`
- `libraries` a list of built libraries (usually results of
- shared_library) that the user needs to link against. Arbitraty strings can
+ shared_library) that the user needs to link against. Arbitrary strings can
also be provided and they will be added into the `Libs` field. Since 0.45.0
dependencies of built libraries will be automatically added to `Libs.private`
field. If a dependency is provided by pkg-config then it will be added in
diff --git a/docs/markdown/Python-module.md b/docs/markdown/Python-module.md
index 51721f0..2bcad78 100644
--- a/docs/markdown/Python-module.md
+++ b/docs/markdown/Python-module.md
@@ -45,7 +45,9 @@ Keyword arguments are the following:
abort if no python installation can be found. If `required` is set to `false`,
Meson will continue even if no python installation was found. You can
then use the `.found()` method on the returned object to check
- whether it was found or not.
+ whether it was found or not. Since *0.48.0* the value of a
+ [`feature`](Build-options.md#features) option can also be passed to the
+ `required` keyword argument.
**Returns**: a [python installation][`python_installation` object]
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index 907ceda..b616d3e 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -1094,7 +1094,7 @@ Project supports the following keyword arguments.
`meson.project_license()`.
- `meson_version` takes a string describing which Meson version the
- project requires. Usually something like `>0.28.0`.
+ project requires. Usually something like `>=0.28.0`.
- `subproject_dir` specifies the top level directory name that holds
Meson subprojects. This is only meant as a compatibility option
diff --git a/docs/markdown/Wrap-dependency-system-manual.md b/docs/markdown/Wrap-dependency-system-manual.md
index 38e1ab2..0977921 100644
--- a/docs/markdown/Wrap-dependency-system-manual.md
+++ b/docs/markdown/Wrap-dependency-system-manual.md
@@ -109,6 +109,13 @@ the end of your wrap file:
push-url=git@git.example.com:projects/someproject.git # Supported since version 0.37.0
```
+If the git repo contains submodules, you can tell Meson to clone them
+automatically by adding the following *(since 0.48.0)*:
+
+```ini
+clone-recursive=true
+```
+
## Using wrapped projects
To use a subproject simply do this in your top level `meson.build`.
diff --git a/docs/images/buildtime.png b/docs/markdown/images/buildtime.png
index 2a44422..2a44422 100644
--- a/docs/images/buildtime.png
+++ b/docs/markdown/images/buildtime.png
Binary files differ
diff --git a/docs/images/conftime.png b/docs/markdown/images/conftime.png
index 63754db..63754db 100644
--- a/docs/images/conftime.png
+++ b/docs/markdown/images/conftime.png
Binary files differ
diff --git a/docs/images/emptytime.png b/docs/markdown/images/emptytime.png
index d80eab9..d80eab9 100644
--- a/docs/images/emptytime.png
+++ b/docs/markdown/images/emptytime.png
Binary files differ
diff --git a/docs/images/glib_build.png b/docs/markdown/images/glib_build.png
index ddb9947..ddb9947 100644
--- a/docs/images/glib_build.png
+++ b/docs/markdown/images/glib_build.png
Binary files differ
diff --git a/docs/images/glib_conf.png b/docs/markdown/images/glib_conf.png
index 5de60d5..5de60d5 100644
--- a/docs/images/glib_conf.png
+++ b/docs/markdown/images/glib_conf.png
Binary files differ
diff --git a/docs/images/glib_empty.png b/docs/markdown/images/glib_empty.png
index 5976e7f..5976e7f 100644
--- a/docs/images/glib_empty.png
+++ b/docs/markdown/images/glib_empty.png
Binary files differ
diff --git a/docs/images/glib_link.png b/docs/markdown/images/glib_link.png
index 23d9044..23d9044 100644
--- a/docs/images/glib_link.png
+++ b/docs/markdown/images/glib_link.png
Binary files differ
diff --git a/docs/images/gtksample.png b/docs/markdown/images/gtksample.png
index b6557c4..b6557c4 100644
--- a/docs/images/gtksample.png
+++ b/docs/markdown/images/gtksample.png
Binary files differ
diff --git a/docs/images/py3-install-1.png b/docs/markdown/images/py3-install-1.png
index 74f0819..74f0819 100644
--- a/docs/images/py3-install-1.png
+++ b/docs/markdown/images/py3-install-1.png
Binary files differ
diff --git a/docs/images/py3-install-2.png b/docs/markdown/images/py3-install-2.png
index 9a8f1fe..9a8f1fe 100644
--- a/docs/images/py3-install-2.png
+++ b/docs/markdown/images/py3-install-2.png
Binary files differ
diff --git a/docs/images/py3-install-3.png b/docs/markdown/images/py3-install-3.png
index b702910..b702910 100644
--- a/docs/images/py3-install-3.png
+++ b/docs/markdown/images/py3-install-3.png
Binary files differ
diff --git a/docs/markdown/snippets/version_comparison.md b/docs/markdown/snippets/version_comparison.md
new file mode 100644
index 0000000..861a3ee
--- /dev/null
+++ b/docs/markdown/snippets/version_comparison.md
@@ -0,0 +1,15 @@
+## Version comparison
+
+`dependency(version:)` and other version constraints now handle versions
+containing non-numeric characters better, comparing versions using the rpmvercmp
+algorithm (as using the `pkg-config` autoconf macro `PKG_CHECK_MODULES` does).
+
+This is a breaking change for exact comparison constraints which rely on the
+previous comparison behaviour of extending the compared versions with `'0'`
+elements, up to the same length of `'.'`-separated elements.
+
+For example, a version of `'0.11.0'` would previously match a version constraint
+of `'==0.11'`, but no longer does, being instead considered strictly greater.
+
+Instead, use a version constraint which exactly compares with the precise
+version required, e.g. `'==0.11.0'`.
diff --git a/docs/markdown/snippets/wrap_clone_recursive.md b/docs/markdown/snippets/wrap_clone_recursive.md
new file mode 100644
index 0000000..7c1c0da
--- /dev/null
+++ b/docs/markdown/snippets/wrap_clone_recursive.md
@@ -0,0 +1,7 @@
+## Git wraps can now clone submodules automatically
+
+To enable this, the following needs to be added to the `.wrap` file:
+
+```ini
+clone-recursive=true
+``` \ No newline at end of file
diff --git a/docs/meson.build b/docs/meson.build
index c83d5f8..32aab07 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -17,6 +17,5 @@ documentation = hotdoc.generate_doc(meson.project_name(),
)
run_target('upload',
- command: [find_program('hotdoc'), 'run', '--conf-file', documentation.config_path(),
- '--git-upload']
-) \ No newline at end of file
+ command: [find_program('hotdoc'), 'run', '--conf-file', documentation.config_path()]
+)