aboutsummaryrefslogtreecommitdiff
path: root/src/libutil
diff options
context:
space:
mode:
authorQyriad <qyriad@qyriad.me>2024-05-17 00:10:38 +0000
committerGerrit Code Review <gerrit@lix-systems>2024-05-17 00:10:38 +0000
commit5756be19f65f125276e6f36ec6e624b06001bc70 (patch)
treef6b18e39b8bc57637c0417b9b0aad612c277a6df /src/libutil
parent9322a1cbe775a32c7019a91236d9e37037b9241a (diff)
parent88d9b70f6723026eec127612b181e5a7a7381971 (diff)
Merge "add clarifying doc-comments on {get,create}NixStateDir()" into main
Diffstat (limited to 'src/libutil')
-rw-r--r--src/libutil/util.hh6
1 files changed, 5 insertions, 1 deletions
diff --git a/src/libutil/util.hh b/src/libutil/util.hh
index 5adabae28..914d6cce0 100644
--- a/src/libutil/util.hh
+++ b/src/libutil/util.hh
@@ -240,11 +240,15 @@ std::optional<Path> getSelfExe();
/**
* @return $XDG_STATE_HOME or $HOME/.local/state.
+ *
+ * @note Not to be confused with settings.nixStateDir.
*/
Path getStateDir();
/**
- * Create the Nix state directory and return the path to it.
+ * Create $XDG_STATE_HOME/nix or $HOME/.local/state/nix, and return
+ * the path to it.
+ * @note Not to be confused with settings.nixStateDir.
*/
Path createNixStateDir();