aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas Voss <mail@thomasvoss.com> 2024-07-02 00:19:45 +0200
committerThomas Voss <mail@thomasvoss.com> 2024-07-02 00:19:45 +0200
commit7ba2de9859296254b8cdbaf81aa8c27a2461e5d3 (patch)
tree9f75ca4c30cb5c1a67390b6ea6b0aa02f60091ce
parent730fb6b3ea0fbd79eed50d6dbc38787c3cc91412 (diff)
Update documentation
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index d2c96d8..20621b0 100644
--- a/README.md
+++ b/README.md
@@ -314,6 +314,15 @@ the provided environment variable doesn’t exist or has the value of the
empty string, then fallback to appending `n` strings from `ys` to the end
of `xs`.
+The value of the environment variable `ev` will undergo `sh`-style
+word-splitting so that usages such as the following are legal:
+
+```sh
+$ CC="zig cc -target x86_64-linux-musl" ./make
+```
+
+NOTE: This function leaks memory!
+
---
```c
@@ -325,6 +334,15 @@ the provided environment variable doesn’t exist or has the value of the
empty string, then fallback to appending the strings specified by the
provided variable-arguments to the end of `xs`.
+The value of the environment variable `ev` will undergo `sh`-style
+word-splitting so that usages such as the following are legal:
+
+```sh
+$ CC="zig cc -target x86_64-linux-musl" ./make
+```
+
+NOTE: This macro leaks memory!
+
### File Information Functions
The following functions are useful for performing common checks on files.
@@ -585,3 +603,5 @@ if (!pcquery(&cmd, "uriparser", PC_CFLAGS | PC_LIBS))
strspushl(&cmd, "-luriparser"); /* fallback */
strspushl(&cmd, "-o", "main", "main.c");
```
+
+NOTE: This function leaks memory!