Skip to content

Commit

Permalink
Merge pull request #4202 from goller/docs/note-nil-return
Browse files Browse the repository at this point in the history
docs(source): mention successful snapshots can be nil
  • Loading branch information
tonistiigi authored Sep 6, 2023
2 parents e743530 + 4968e97 commit 3d44ec2
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion source/manager.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ type SourceInstance interface {
// CacheKey returns the cache key for the instance.
CacheKey(ctx context.Context, g session.Group, index int) (key, pin string, opts solver.CacheOpts, done bool, err error)

// Snapshot creates a cache ref for the instance.
// Snapshot creates a cache ref for the instance. May return a nil ref if source points to empty content, e.g. image without any layers.
Snapshot(ctx context.Context, g session.Group) (cache.ImmutableRef, error)
}

Expand Down

0 comments on commit 3d44ec2

Please sign in to comment.