aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown
diff options
context:
space:
mode:
authorXavier Claessens <xavier.claessens@collabora.com>2019-12-11 21:00:46 -0500
committerXavier Claessens <xavier.claessens@collabora.com>2019-12-12 18:30:17 -0500
commit49082f96698fbb74b587ca774dae45b7b5943a16 (patch)
treec85a47d74c5f6e6ba7e0a7388c1479e6a8938ad4 /docs/markdown
parent6e865a233099a00e9ea08f6a2f911ede3c7b4215 (diff)
downloadmeson-49082f96698fbb74b587ca774dae45b7b5943a16.zip
meson-49082f96698fbb74b587ca774dae45b7b5943a16.tar.gz
meson-49082f96698fbb74b587ca774dae45b7b5943a16.tar.bz2
summary: Allow section with no title, and passing key/value separately
Diffstat (limited to 'docs/markdown')
-rw-r--r--docs/markdown/Reference-manual.md17
1 files changed, 12 insertions, 5 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index e4c18a1..cf5585b 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -1209,6 +1209,9 @@ This function prints its argument to stdout prefixed with WARNING:.
### summary()
``` meson
+ void summary(key, value)
+ void summary(dictionary)
+ void summary(section_name, key, value)
void summary(section_name, dictionary)
```
@@ -1216,12 +1219,16 @@ This function is used to summarize build configuration at the end of the build
process. This function provides a way for projects (and subprojects) to report
this information in a clear way.
-The first argument is a section name, the second argument is a dictionary.
-`summary()` can be called multiple times as long as the same dict key doesn't
-appear twice in the same section. All sections will be collected and printed at
-the end of the configuration in the same order as they have been called.
+The content is a serie of key/value pairs grouped into sections. If the section
+argument is omitted, those key/value pairs are implicitly grouped into a section
+with no title. key/value pairs can optionally be grouped into a dictionary,
+but keep in mind that dictionaries does not guarantee ordering.
+`section_name` and `key` must be strings, `value` can only be lists, integers,
+booleans or strings.
-Dictionary values can only be lists, integers, booleans or strings.
+`summary()` can be called multiple times as long as the same section_name/key
+pair doesn't appear twice. All sections will be collected and printed at
+the end of the configuration in the same order as they have been called.
Example:
```meson