From 7a1489e8db92c462f82a9ea223ff23ec44816f17 Mon Sep 17 00:00:00 2001 From: Piotr Skamruk Date: Fri, 11 Aug 2017 11:16:37 +0200 Subject: [PATCH] gc: Add docstring to exported func --- pkg/libvirttools/gc.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/pkg/libvirttools/gc.go b/pkg/libvirttools/gc.go index 1c3aba43b..cba16ff9c 100644 --- a/pkg/libvirttools/gc.go +++ b/pkg/libvirttools/gc.go @@ -27,6 +27,9 @@ const ( nocloudFilenameTemplate = "nocloud-*.iso" ) +// GarbageCollect retrieves from metadata store list of container ids, +// passes it to all GC submodules, collecting from them list of +// possible errors, which is returned to outer scope func (v *VirtualizationTool) GarbageCollect() (allErrors []error) { ids, fatal, errors := v.retrieveListOfContainerIDs() if errors != nil {