diff options
| author | Qyriad <qyriad@qyriad.me> | 2024-05-11 15:34:09 -0600 |
|---|---|---|
| committer | Qyriad <qyriad@qyriad.me> | 2024-05-11 15:40:00 -0600 |
| commit | 88d9b70f6723026eec127612b181e5a7a7381971 (patch) | |
| tree | 1b54446fe5c970111d5843470f66afa1bed2d3d8 /src/libutil/util.hh | |
| parent | a30c5673367533aec48faa59dd0d76b283dda1ba (diff) | |
add clarifying doc-comments on {get,create}NixStateDir()
NixStateDir() != NIX_STATE_DIR. These functions should honestly probably
be renamed.
Change-Id: I00f54b742bba6188bbc7f2410956d956780b99d3
Diffstat (limited to 'src/libutil/util.hh')
| -rw-r--r-- | src/libutil/util.hh | 6 |
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(); |