From 8eeaf591db2814d13921fffc290e278817dbae0c Mon Sep 17 00:00:00 2001
From: John Ericson <git@JohnEricson.me>
Date: Fri, 21 Apr 2023 01:30:55 -0400
Subject: [PATCH] Add more docs to `TextIngestionMethod`

Thanks so much!

Co-authored-by: Adam Joseph <54836058+amjoseph-nixpkgs@users.noreply.github.com>
---
 src/libstore/content-address.hh | 6 ++++++
 1 file changed, 6 insertions(+)

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 { };