aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon Ser <contact@emersion.fr>2022-12-06 11:42:03 +0100
committerSimon Ser <contact@emersion.fr>2022-12-06 16:14:16 +0100
commitdc09585d14b53f186d4be78126824faf27da55b8 (patch)
treefe8048fe8f6dfae9cf0af331c1530beebda94f96
parent1bd0ba3949605c1fe382bbdb62b8a9aa2e462573 (diff)
util/env: add docs
I always forget what env_parse_switch() does on error.
-rw-r--r--include/util/env.h12
1 files changed, 12 insertions, 0 deletions
diff --git a/include/util/env.h b/include/util/env.h
index 6720fa89..1edae0dd 100644
--- a/include/util/env.h
+++ b/include/util/env.h
@@ -4,8 +4,20 @@
#include <stdbool.h>
#include <unistd.h>
+/**
+ * Parse a bool from an environment variable.
+ *
+ * On success, the parsed value is returned. On error, false is returned.
+ */
bool env_parse_bool(const char *option);
+/**
+ * Pick a choice from an environment variable.
+ *
+ * On success, the choice index is returned. On error, zero is returned.
+ *
+ * switches is a NULL-terminated array.
+ */
ssize_t env_parse_switch(const char *option, const char **switches);
#endif