philiptaron/lix
0
0
Fork 0
forked from lix-project/lix
Code Pull requests Activity

Update description of FlakeRef, incorporating suggestion.

Browse source
This commit is contained in:
Kevin Quick 2020-09-28 09:23:05 -07:00
parent bcb3da3b6b
commit 5ae164b7cf
No known key found for this signature in database
GPG key ID: E6D7733599CC0A21
1 changed files with 13 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
src/libexpr/flake/flakeref.hh
View file

@ -12,12 +12,19 @@ class Store;
typedef std::string FlakeId;
// The FlakeRef represents a local nix store reference to a flake
// input for a Flake (it may be helpful to think of this object by the
// alternate name of "InputRefForFlake"). It is constructed by
// starting with an input description (usually the attrs or a url from
// the flake file), locating a fetcher for that input, and then
// capturing the Input object that fetcher generates (usually via
// A flake reference specifies how to fetch a flake or raw source
// (e.g. from a Git repository). It is created from a URL-like syntax
// (e.g. 'github:NixOS/patchelf'), an attrset representation (e.g. '{
// type="github"; owner = "NixOS"; repo = "patchelf"; }'), or a local
// path.
//
// Each flake will have a number of FlakeRef objects: one for each
// input to the flake.
//
// The normal method of constructing a FlakeRef is by starting with an
// input description (usually the attrs or a url from the flake file),
// locating a fetcher for that input, and then capturing the Input
// object that fetcher generates (usually via
// FlakeRef::fromAttrs(attrs) or parseFlakeRef(url) calls).
//
// The actual fetch not have been performed yet (i.e. a FlakeRef may