aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMarvin Scholz <epirat07@gmail.com>2022-03-29 23:59:44 +0200
committerXavier Claessens <xclaesse@gmail.com>2022-03-30 06:57:30 -0400
commit2cdddbab56ffdbca6accfc626521968fbe2c917e (patch)
tree16a0fd27f509d7a4ae0dd41fdd8eeaaa1a679a76 /docs
parent969ae6e0e1ffe3d1acb6ef0ef93c809b566a3ea1 (diff)
downloadmeson-2cdddbab56ffdbca6accfc626521968fbe2c917e.zip
meson-2cdddbab56ffdbca6accfc626521968fbe2c917e.tar.gz
meson-2cdddbab56ffdbca6accfc626521968fbe2c917e.tar.bz2
Add new debug() function
Adds a new debug() function that can be used in the meson.build to log messages to the meson-log.txt that will not be printed to stdout when configuring the project.
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/snippets/new-debug-function.md5
-rw-r--r--docs/yaml/functions/debug.yaml14
2 files changed, 19 insertions, 0 deletions
diff --git a/docs/markdown/snippets/new-debug-function.md b/docs/markdown/snippets/new-debug-function.md
new file mode 100644
index 0000000..c900827
--- /dev/null
+++ b/docs/markdown/snippets/new-debug-function.md
@@ -0,0 +1,5 @@
+## Added `debug` function
+
+In addition to the `message()`, `warning()` and `error()` functions there is now the
+`debug()` function to log messages that only end up in the `meson-log.txt` logfile
+and are not printed to stdout at configure time.
diff --git a/docs/yaml/functions/debug.yaml b/docs/yaml/functions/debug.yaml
new file mode 100644
index 0000000..a64bd92
--- /dev/null
+++ b/docs/yaml/functions/debug.yaml
@@ -0,0 +1,14 @@
+name: debug
+returns: void
+since: 0.63.0
+description: Write the argument string to the meson build log.
+
+posargs:
+ message:
+ type: str | int | bool | list[str | int | bool] | dict[str | int | bool]
+ description: The message to print
+
+varargs:
+ name: msg
+ type: str | int | bool | list[str | int | bool] | dict[str | int | bool]
+ description: Additional parameters will be separated by spaces