Clarification in the description of the FlakeInput.

This commit is contained in:
Kevin Quick 2020-09-28 09:34:23 -07:00
parent 5ae164b7cf
commit 128c98ab09
No known key found for this signature in database
GPG key ID: E6D7733599CC0A21

View file

@ -17,15 +17,16 @@ struct FlakeInput;
typedef std::map<FlakeId, FlakeInput> FlakeInputs;
// FlakeInput is the flake-level parsed form of the "input" entries in
// FlakeInput is the 'Flake'-level parsed form of the "input" entries in
// the flake file.
//
// A FlakeInput is normally constructed by initially
// first constructing a FlakeRef (a fetcher, the fetcher-specific
// representation of the input specification, and the fetched local
// store path result) and then creating this FlakeInput to hold that
// FlakeRef, along with anything that might override that FlakeRef
// (like command-line overrides or "follows" specifications).
// A FlakeInput is normally constructed by the 'parseFlakeInput'
// function which parses the input specification in the '.flake' file
// to create a 'FlakeRef' (a fetcher, the fetcher-specific
// representation of the input specification, and possibly the fetched
// local store path result) and then creating this FlakeInput to hold
// that FlakeRef, along with anything that might override that
// FlakeRef (like command-line overrides or "follows" specifications).
//
// A FlakeInput is also sometimes constructed directly from a FlakeRef
// instead of starting at the flake-file input specification