aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Ericson <git@JohnEricson.me>2023-04-21 01:30:55 -0400
committerGitHub <noreply@github.com>2023-04-21 01:30:55 -0400
commit8eeaf591db2814d13921fffc290e278817dbae0c (patch)
tree4a0f893abb8e89c17b5eb8c26c47b34faf575fe8
parent969def696ae188113643925364799e419202cf4f (diff)
Add more docs to `TextIngestionMethod`
Thanks so much! Co-authored-by: Adam Joseph <54836058+amjoseph-nixpkgs@users.noreply.github.com>
-rw-r--r--src/libstore/content-address.hh6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/libstore/content-address.hh b/src/libstore/content-address.hh
index b25e6d49d..9986d387f 100644
--- a/src/libstore/content-address.hh
+++ b/src/libstore/content-address.hh
@@ -21,6 +21,12 @@ namespace nix {
*
* Somewhat obscure, used by \ref Derivation derivations and
* `builtins.toFile` currently.
+ *
+ * TextIngestionMethod is identical to FileIngestionMethod::Fixed except that
+ * the former may not have self-references and is tagged `text:${algo}:${hash}`
+ * rather than `fixed:${algo}:${hash}`. The contents of the store path are
+ * ingested and hashed identically, aside from the slightly different tag and
+ * restriction on self-references.
*/
struct TextIngestionMethod : std::monostate { };