Add a summary() function for configuration summarization

Based on patch from Dylan Baker.

Fixes #757

1 files changed, 37 insertions, 0 deletions

diff --git a/docs/markdown/snippets/summary.md b/docs/markdown/snippets/summary.md
new file mode 100644
index 0000000..c5d64fd
--- /dev/null
+++ b/docs/markdown/snippets/summary.md
@@ -0,0 +1,37 @@
+## Add a new summary() function
+
+A new function [`summary()`](Reference-manual.md#summary) has been added to
+summarize build configuration at the end of the build process.
+
+Example:
+```meson
+project('My Project', version : '1.0')
+summary('Directories', {'bindir': get_option('bindir'),
+                        'libdir': get_option('libdir'),
+                        'datadir': get_option('datadir'),
+                        })
+summary('Configuration', {'Some boolean': false,
+                          'Another boolean': true,
+                          'Some string': 'Hello World',
+                          'A list': ['string', 1, true],
+                          })
+```
+
+Output:
+```
+My Project 1.0
+
+  Directories
+             prefix: /opt/gnome
+             bindir: bin
+             libdir: lib/x86_64-linux-gnu
+            datadir: share
+
+  Configuration
+       Some boolean: False
+    Another boolean: True
+        Some string: Hello World
+             A list: string
+                     1
+                     True
+```