Skip to content

Commit

Permalink
docs: more detail in IndirectRef::resolve
Browse files Browse the repository at this point in the history
  • Loading branch information
zmitchell committed Aug 8, 2023
1 parent d06e071 commit d5f2d7e
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions crates/runix/src/flake_ref/indirect.rs
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,10 @@ impl IndirectRef {
}

/// Resolves an indirect flake reference to a concrete reference
///
/// Note that this method calls `parser-util`, which relies on the `NIX_USER_CONF_FILES`
/// environment variable to be set and contain conf files that point to custom registries
/// that you want to use for resolution, otherwise only the user's local registry is used.
pub fn resolve(&self) -> Result<FlakeRef, UrlParseError> {
let json = serde_json::to_string(&self.attributes)?;
let resolved = resolve_flake_ref(json, PARSER_UTIL_BIN_PATH)?;
Expand Down

0 comments on commit d5f2d7e

Please sign in to comment.