add comment explaining the format

DataDog · Oct 10, 2024 · d18d748 · d18d748
1 parent 40bd89a
commit d18d748
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/pkg/security/resolvers/sbom/file_querier.go b/pkg/security/resolvers/sbom/file_querier.go
@@ -21,6 +21,16 @@ type fileQuerier struct {
 	pkgs  []*Package
 }
 
+/*
+files are stored in the following format:
+
+| partSize | hash1 | hash2 | ... | partSize | hash3 | hash4 | ... | partSize | hash5 | hash6 | ... |
+
+where partSize is the number of hashes in the part
+and each part group is at the index of the given package
+for example here hash5 would match pkgs[2]
+*/
+
 func newFileQuerier(report *trivy.Report) fileQuerier {
 	fileCount := 0
 	pkgCount := 0