add comment to UnsafeSetRefTime

Signed-off-by: Adam Korczynski <[email protected]>
theupdateframework · Jun 18, 2024 · faf9792 · faf9792
1 parent de4dcfc
commit faf9792
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/metadata/updater/updater.go b/metadata/updater/updater.go
@@ -662,6 +662,9 @@ func (update *Updater) GetTrustedMetadataSet() trustedmetadata.TrustedMetadata {
 	return *update.trusted
 }
 
+// Sets the reference time that the updater uses.
+// This should only be done in tests.
+// UnsafeSetRefTime is useful when testing time-related behavior in go-tuf.
 func (update *Updater) UnsafeSetRefTime(t time.Time) {
 	update.trusted.RefTime = t
 }