forked from lix-project/lix
add clarifying doc-comments on {get,create}NixStateDir()
NixStateDir() != NIX_STATE_DIR. These functions should honestly probably
be renamed.
Change-Id: I00f54b742bba6188bbc7f2410956d956780b99d3
This commit is contained in:
parent
a30c567336
commit
88d9b70f67
|
@ -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();
|
||||
|
||||
|
|
Loading…
Reference in a new issue