From 2a1f7b647b156cb23ab85da5a843d9e6d31823f3 Mon Sep 17 00:00:00 2001 From: Stephen J Day Date: Thu, 17 Aug 2017 14:31:35 -0700 Subject: [PATCH] images: document config utility function Signed-off-by: Stephen J Day --- images/image.go | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/images/image.go b/images/image.go index 4df6e9dd2..ce7189822 100644 --- a/images/image.go +++ b/images/image.go @@ -67,6 +67,11 @@ func (image *Image) Size(ctx context.Context, provider content.Provider) (int64, }), ChildrenHandler(provider)), image.Target) } +// Config resolves the image configuration descriptor using a content provided +// to resolve child resources on the image. +// +// The caller can then use the descriptor to resolve and process the +// configuration of the image. func Config(ctx context.Context, provider content.Provider, image ocispec.Descriptor) (ocispec.Descriptor, error) { var configDesc ocispec.Descriptor return configDesc, Walk(ctx, HandlerFunc(func(ctx context.Context, desc ocispec.Descriptor) ([]ocispec.Descriptor, error) {