gc: Add docstring to exported func

Mirantis · Aug 11, 2017 · 7a1489e · 7a1489e
1 parent 08f756d
commit 7a1489e
Showing 1 changed file with 3 additions and 0 deletions.
diff --git 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 {