Merge "add clarifying doc-comments on {get,create}NixStateDir()" into main
This commit is contained in:
commit
5756be19f6
|
@ -240,11 +240,15 @@ std::optional<Path> getSelfExe();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return $XDG_STATE_HOME or $HOME/.local/state.
|
* @return $XDG_STATE_HOME or $HOME/.local/state.
|
||||||
|
*
|
||||||
|
* @note Not to be confused with settings.nixStateDir.
|
||||||
*/
|
*/
|
||||||
Path getStateDir();
|
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();
|
Path createNixStateDir();
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue