From fddd8e94ddb4a9004610fec2fe7f7122d4d6f4e6 Mon Sep 17 00:00:00 2001
From: shaoyue <shaoyue.chen@zilliz.com>
Date: Thu, 30 Dec 2021 10:46:03 +0800
Subject: [PATCH] [skip e2e] Add comment for embed etcd server singleton
 (#14572)

Signed-off-by: shaoyue.chen <shaoyue.chen@zilliz.com>
---
 internal/util/etcd/etcd_util.go | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/internal/util/etcd/etcd_util.go b/internal/util/etcd/etcd_util.go
index a3a57cc2b6..2b18fb7167 100644
--- a/internal/util/etcd/etcd_util.go
+++ b/internal/util/etcd/etcd_util.go
@@ -27,8 +27,10 @@ import (
 	"go.etcd.io/etcd/server/v3/etcdserver/api/v3client"
 )
 
+// EtcdServer is the singleton of embedded etcd server
 var EtcdServer *embed.Etcd
 
+// InitEtcdServer initializes embedded etcd server singleton.
 func InitEtcdServer(pt *paramtable.BaseParamTable) error {
 	if pt.UseEmbedEtcd {
 		path := pt.EtcdConfigPath
@@ -54,6 +56,7 @@ func InitEtcdServer(pt *paramtable.BaseParamTable) error {
 	return nil
 }
 
+// StopEtcdServer stops embedded etcd server singleton.
 func StopEtcdServer() {
 	if EtcdServer != nil {
 		EtcdServer.Close()