Skip to content

Commit fe5f85c

Browse files
committed
Fix incorrect comment about ordering of parent layers
The ParentIDs array in the Snapshot type is populated in the reverse order i.e the immediate parent is at the 0th index and the oldest parent is at the last index. It can be seen here: https://github.com/containerd/containerd/blob/main/core/snapshots/storage/bolt.go#L492 When applying these layers, the parent layer at the last index should be applied first and the parent layer at the 0th index should be applied last. However, the comment above the Snapshot type says the exact opposite thing. This commit fixes that comment. Signed-off-by: Amit Barve <[email protected]>
1 parent 4d48204 commit fe5f85c

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

core/snapshots/storage/metastore.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,10 @@ type Transactor interface {
4848

4949
// Snapshot hold the metadata for an active or view snapshot transaction. The
5050
// ParentIDs hold the snapshot identifiers for the committed snapshots this
51-
// active or view is based on. The ParentIDs are ordered from the lowest base
52-
// to highest, meaning they should be applied in order from the first index to
53-
// the last index. The last index should always be considered the active
54-
// snapshots immediate parent.
51+
// active or view is based on. The ParentIDs are ordered from the highest to the
52+
// lowest base, meaning they should be applied in order from the last index to
53+
// the first index. The first index should always be considered the active
54+
// snapshot's immediate parent.
5555
type Snapshot struct {
5656
Kind snapshots.Kind
5757
ID string

0 commit comments

Comments
 (0)