Clarify two functions are meant to be used by desaster recovery

[python-delta-tar] / deltatar / crypto.py

diff --git a/deltatar/crypto.py b/deltatar/crypto.py
index 80850b3..4142808 100755 (executable)
--- a/deltatar/crypto.py
+++ b/deltatar/crypto.py
@@ -529,7 +529,7 @@ def locate_hdr_candidates (fd):
     """
     Walk over instances of the magic string in the payload, collecting their
     positions. If the offset of the first found instance is not zero, the file
-    begins with leading garbage.
+    begins with leading garbage. Used by desaster recovery.
 
     :return:    The list of offsets in the file.
     """
@@ -615,7 +615,7 @@ def try_decrypt (ifd, off, hdr, secret, ofd=-1):
     Always creates a fresh decryptor, so validation steps across objects don’t
     apply.
 
-    Errors during GCM tag validation are ignored.
+    Errors during GCM tag validation are ignored. Used by desaster recovery.
     """
     ctleft = hdr ["ctsize"]
     pos    = off