Skip to content

Commit a2ab197

Browse files
committed
Re-add some of Hidde's comments.
Signed-off-by: Felix Fontein <felix@fontein.de>
1 parent 9061d01 commit a2ab197

1 file changed

Lines changed: 8 additions & 1 deletion

File tree

stores/metadata.go

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,14 @@ import (
1515
type MetadataFlatten int
1616

1717
const (
18+
// MetadataFlattenNone keeps the metadata under a single nested `sops`
19+
// key in the first tree branch.
1820
MetadataFlattenNone MetadataFlatten = iota
21+
// MetadataFlattenBelowTop keeps the metadata under a top-level `sops`
22+
// key in the first tree branch, with its values flattened beneath it.
1923
MetadataFlattenBelowTop
24+
// MetadataFlattenFull flattens the metadata fully into the first tree
25+
// branch, prefixing each key with `SopsPrefix`.
2026
MetadataFlattenFull
2127
)
2228

@@ -90,7 +96,7 @@ func treeBranchToMetadata(meta sops.TreeBranch) (metadata, error) {
9096
return md, err
9197
}
9298

93-
// Extract SOPS metadata from tree branches.
99+
// ExtractMetadata extracts SOPS metadata from the supplied tree branches.
94100
func ExtractMetadata(branches sops.TreeBranches, opts MetadataOpts) (sops.TreeBranches, sops.Metadata, error) {
95101
var metadataTree sops.TreeBranch
96102
if opts.Flatten != MetadataFlattenFull {
@@ -238,6 +244,7 @@ func metadataToTreeBranch(md metadata) (sops.TreeBranch, error) {
238244
return nil, fmt.Errorf("Internal error: unexpected metadata conversion result %T", metadata)
239245
}
240246

247+
// SerializeMetadata embeds the metadata of `data` into its tree branches.
241248
func SerializeMetadata(data sops.Tree, opts MetadataOpts) (sops.TreeBranches, error) {
242249
md, err := metadataToTreeBranch(metadataFromInternal(data.Metadata))
243250
if err != nil {

0 commit comments

Comments
 (0)