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 <ambarve@microsoft.com>
This commit is contained in:
Amit Barve 2024-06-14 11:39:03 -07:00
parent 4d48204a3d
commit fe5f85c7de

View File

@ -48,10 +48,10 @@ type Transactor interface {
// Snapshot hold the metadata for an active or view snapshot transaction. The // Snapshot hold the metadata for an active or view snapshot transaction. The
// ParentIDs hold the snapshot identifiers for the committed snapshots this // ParentIDs hold the snapshot identifiers for the committed snapshots this
// active or view is based on. The ParentIDs are ordered from the lowest base // active or view is based on. The ParentIDs are ordered from the highest to the
// to highest, meaning they should be applied in order from the first index to // lowest base, meaning they should be applied in order from the last index to
// the last index. The last index should always be considered the active // the first index. The first index should always be considered the active
// snapshots immediate parent. // snapshot's immediate parent.
type Snapshot struct { type Snapshot struct {
Kind snapshots.Kind Kind snapshots.Kind
ID string ID string