lix-project/lix
18
37
Fork 14
Code Issues 286 Code Review (Gerrit) Projects 1 Releases Wiki Activity

add clarifying doc-comments on {get,create}NixStateDir()

Browse source 
NixStateDir() != NIX_STATE_DIR. These functions should honestly probably
be renamed.

Change-Id: I00f54b742bba6188bbc7f2410956d956780b99d3
This commit is contained in:
Qyriad 2024-05-11 15:34:09 -06:00
parent a30c567336
commit 88d9b70f67
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/libutil/util.hh
View file

@ -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();