aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPaolo Bonzini <pbonzini@redhat.com>2021-01-21 12:33:27 +0100
committerXavier Claessens <xclaesse@gmail.com>2021-01-21 08:54:35 -0500
commitadb1b2f3f6ad54b346348ec6e5b8d96f2f7ba0a6 (patch)
treee18fe1b3cfb0f32b76ecaa456fdd3b0a2599b53d /docs
parent021068a8b7461a62ed4ce68ab558bc94786e0550 (diff)
downloadmeson-adb1b2f3f6ad54b346348ec6e5b8d96f2f7ba0a6.zip
meson-adb1b2f3f6ad54b346348ec6e5b8d96f2f7ba0a6.tar.gz
meson-adb1b2f3f6ad54b346348ec6e5b8d96f2f7ba0a6.tar.bz2
interpreter: accept external programs and dependencies for summary
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/Reference-manual.md6
-rw-r--r--docs/markdown/snippets/summary_prog_dep.md4
2 files changed, 9 insertions, 1 deletions
diff --git a/docs/markdown/Reference-manual.md b/docs/markdown/Reference-manual.md
index 802002b..cb8347a 100644
--- a/docs/markdown/Reference-manual.md
+++ b/docs/markdown/Reference-manual.md
@@ -1313,7 +1313,11 @@ The content is a series of key/value pairs grouped into sections. If the section
keyword 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. `key` must be string,
-`value` can only be integer, boolean, string, or a list of those.
+`value` can be:
+
+- an integer, boolean or string
+- *since 0.57.0* an external program or a dependency
+- a list of those.
`summary()` can be called multiple times as long as the same section/key
pair doesn't appear twice. All sections will be collected and printed at
diff --git a/docs/markdown/snippets/summary_prog_dep.md b/docs/markdown/snippets/summary_prog_dep.md
new file mode 100644
index 0000000..6f0262f
--- /dev/null
+++ b/docs/markdown/snippets/summary_prog_dep.md
@@ -0,0 +1,4 @@
+## `summary()` accepts external programs or dependencies
+
+External program objects and dependency objects can be passed to
+`summary()` as the value to be printed.