From f4da502c4fabeee719c5b829744cf872ba956e91 Mon Sep 17 00:00:00 2001 From: Snir Sheriber Date: Mon, 23 Aug 2021 15:19:57 +0300 Subject: [PATCH] shimv2: add information to method comment add a comment to explicitly mentioned method is a binary call Signed-off-by: Snir Sheriber Backport from commit 72e3538e363ef570ef73839c2d9c3f138a950c7d Signed-off-by: Christophe de Dinechin --- src/runtime/containerd-shim-v2/service.go | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/runtime/containerd-shim-v2/service.go b/src/runtime/containerd-shim-v2/service.go index 6c386482e8..40a9ecb85f 100644 --- a/src/runtime/containerd-shim-v2/service.go +++ b/src/runtime/containerd-shim-v2/service.go @@ -181,8 +181,8 @@ func newCommand(ctx context.Context, id, containerdBinary, containerdAddress str return cmd, nil } -// StartShim willl start a kata shimv2 daemon which will implemented the -// ShimV2 APIs such as create/start/update etc containers. +// StartShim is a binary call that starts a kata shimv2 service which will +// implement the ShimV2 APIs such as create/start/update etc containers. func (s *service) StartShim(ctx context.Context, opts cdshim.StartOpts) (_ string, retErr error) { bundlePath, err := os.Getwd() if err != nil { @@ -310,6 +310,7 @@ func getTopic(e interface{}) string { return cdruntime.TaskUnknownTopic } +// Cleanup is a binary call that cleans up resources used by the shim func (s *service) Cleanup(ctx context.Context) (_ *taskAPI.DeleteResponse, err error) { span, spanCtx := katatrace.Trace(s.rootCtx, shimLog, "Cleanup", shimTracingTags) defer span.End()