Update pkg/sif/create.go

Co-authored-by: Adam Hughes <[email protected]> Signed-off-by: Dave Dykstra <[email protected]>
apptainer · Sep 18, 2023 · aebc0db · aebc0db
1 parent 963afff
commit aebc0db
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/pkg/sif/create.go b/pkg/sif/create.go
@@ -682,7 +682,11 @@ func (f *FileImage) SetPrimPart(id uint32, opts ...SetOpt) error {
 	return nil
 }
 
-// SetMetadata writes the mutated descriptors and returns an error if any.
+// SetMetadata the metadata of the data object with id to md, according to opts.
+//
+// By default, the image/object modification times are set to the current time for
+// non-deterministic images, and unset otherwise. To override this, consider using
+// OptSetDeterministic or OptSetWithTime.
 func (f *FileImage) SetMetadata(id uint32, md encoding.BinaryMarshaler, opts ...SetOpt) error {
 	so := setOpts{}