From a5e8dfec43399c54bf6148591bfd4a166b5aa1c2 Mon Sep 17 00:00:00 2001
From: Achilleas Koutsou <achilleas@koutsou.net>
Date: Wed, 31 May 2023 18:28:34 +0200
Subject: [PATCH] image: document the two ostree options on OSTreeArchive

---
 internal/image/ostree_archive.go | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

diff --git a/internal/image/ostree_archive.go b/internal/image/ostree_archive.go
index 10208872f..39d367117 100644
--- a/internal/image/ostree_archive.go
+++ b/internal/image/ostree_archive.go
@@ -19,10 +19,16 @@ type OSTreeArchive struct {
 	OSCustomizations manifest.OSCustomizations
 	Environment      environment.Environment
 	Workload         workload.Workload
-	OSTreeParent     *ostree.CommitSpec
-	OSTreeRef        string
-	OSVersion        string
-	Filename         string
+
+	// OSTreeParent specifies an optional parent commit for the new commit
+	// being built.
+	OSTreeParent *ostree.CommitSpec
+
+	// OSTreeRef is the ref of the commit that will be built.
+	OSTreeRef string
+
+	OSVersion string
+	Filename  string
 }
 
 func NewOSTreeArchive(ref string) *OSTreeArchive {