Merge "add clarifying doc-comments on {get,create}NixStateDir()" into main

This commit is contained in:
Qyriad 2024-05-17 00:10:38 +00:00 committed by Gerrit Code Review
commit 5756be19f6

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