Jade LovelaceandJade Lovelace
fcea7379d3
Documenting fetchTree is an exercise in frustration because of the sheer amount of stringly typed everything in it. I do not know which fields exist without reading the entirety of libfetchers. However, we can write something slightly perfunctory but at least perhaps somewhat helpful documentation-wise. Fixes: https://git.lix.systems/lix-project/lix/issues/609 Change-Id: I991391b53fcd69172dbc7efb9d384e62bc847b91
931 B
931 B
name, args, experimentalFeature, renameInGlobalScope
| name | args | experimentalFeature | renameInGlobalScope | |
|---|---|---|---|---|
| fetchTree |
|
flakes | false |
Fetches the tree specified by the attribute set or URL spec.
The spec is in the form of a flake reference; flake references are a thin wrapper around fetchTree.
There are some efforts to document the behaviour of fetchTree independently of flakes, but they have not yet borne fruit as of 2025-03.
spec also accepts the following special attribute not documented there:
-
name
The name of the resulting store path to fetch to. Optional; defaults to the basename of the URL.Due to some vagaries of flake behaviour, naming the fetched input
sourcemay avoid some extra copying when using the resulting store path as a path input for a flake. See https://git.lix.systems/lix-project/lix/issues/630.