Skip to content

Commit

Permalink
Update description of FlakeRef, incorporating suggestion.
Browse files Browse the repository at this point in the history
  • Loading branch information
kquick committed Sep 28, 2020
1 parent bcb3da3 commit 5ae164b
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions src/libexpr/flake/flakeref.hh
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 5ae164b

Please sign in to comment.