aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown
diff options
context:
space:
mode:
authorMarc-André Lureau <marcandre.lureau@redhat.com>2020-07-13 12:52:39 +0400
committerJussi Pakkanen <jpakkane@gmail.com>2020-07-19 17:53:32 +0300
commitaa0d75deaee925b9ceb3d98ef8f5de0167587c71 (patch)
treee5363513b287a0b80eef279499981f0eda762bfe /docs/markdown
parent998c78fb0a404f34512414d93b08cf45166be357 (diff)
downloadmeson-aa0d75deaee925b9ceb3d98ef8f5de0167587c71.zip
meson-aa0d75deaee925b9ceb3d98ef8f5de0167587c71.tar.gz
meson-aa0d75deaee925b9ceb3d98ef8f5de0167587c71.tar.bz2
Stabilize keyval module
We have experimented with the module for about a year in a qemu branch (https://wiki.qemu.org/Features/Meson), and we would like to start moving the build system to meson. For that, keyval should have the stability guarantees. Cc: Paolo Bonzini <pbonzini@redhat.com>
Diffstat (limited to 'docs/markdown')
-rw-r--r--docs/markdown/Keyval-module.md4
-rw-r--r--docs/markdown/snippets/keyval.md7
2 files changed, 9 insertions, 2 deletions
diff --git a/docs/markdown/Keyval-module.md b/docs/markdown/Keyval-module.md
index 643265e..afc48fa 100644
--- a/docs/markdown/Keyval-module.md
+++ b/docs/markdown/Keyval-module.md
@@ -1,5 +1,5 @@
---
-short-description: Unstable keyval module
+short-description: Keyval module
authors:
- name: Mark Schulte, Paolo Bonzini
years: [2017, 2019]
@@ -23,7 +23,7 @@ chosen the configuration options), output a ".config" file.
The module may be imported as follows:
``` meson
-keyval = import('unstable-keyval')
+keyval = import('keyval')
```
The following functions will then be available as methods on the object
diff --git a/docs/markdown/snippets/keyval.md b/docs/markdown/snippets/keyval.md
new file mode 100644
index 0000000..895de9b
--- /dev/null
+++ b/docs/markdown/snippets/keyval.md
@@ -0,0 +1,7 @@
+## `unstable-keyval` is now stable `keyval`
+
+The `unstable-keyval` has been renamed to `keyval` and now promises stability
+guarantees.
+
+Meson will print a warning when you load an `unstable-` module that has been
+stabilised (so `unstable-keyval` is still accepted for example).