lix-project/lix-releng-staging
0
0
Fork 0
Code Packages Activity

add docstring to lookupFileArg

Browse source 
Change-Id: Ifc149764f5a15725d3d630677c6da29def4b0f3e
This commit is contained in:
Qyriad 2024-05-20 13:16:09 -06:00
parent 0565f97e78
commit 3a597f1d0b
1 changed files with 21 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
src/libcmd/common-eval-args.hh
View file

@ -28,6 +28,26 @@ private:
std::map<std::string, std::string> autoArgs;
};
SourcePath lookupFileArg(EvalState & state, std::string_view s);
/** @brief Resolve an argument that is generally a file, but could be something that
* is easy to resolve to a file, like a <lookup path> or a tarball URL.
*
* In particular, this will resolve and fetch pseudo-URLs starting with
* @c channel:, flakerefs starting with @c flake:, and anything that
* @ref nix::fetchers::downloadTarball() can take.
*
* Non-absolute files are looked up relative to the current directory(?)
* FIXME: the process's current directory or EvalState's current directory?
*
* @param state The nix::EvalState to base settings, store, and nixPath from.
*
* @param fileArg The the path-ish to resolve.
*
* @return A nix::SourcePath to the resolved and fetched file.
*
* @exception nix::FileTransferError from nix::fetchers::downloadTarball(). Probably others.
*
* @exception nix::ThrownError for failed search path lookup. Probably others.
*/
SourcePath lookupFileArg(EvalState & state, std::string_view fileArg);
}