Update comments

bfe_balance/backend/health_check.go

@@ -180,7 +180,7 @@ func checkHTTPConnect(backend *BfeBackend, checkConf *cluster_conf.BackendCheck)
 	return cluster_conf.MatchStatusCode(statusCode, *checkConf.StatusCode)
 }
 
-// CheckRedirect check whether backend server become available.
+// CheckConnect checks whether backend server become available.
 func CheckConnect(backend *BfeBackend, checkConf *cluster_conf.BackendCheck) (bool, error) {
 	switch *checkConf.Schem {
 	case "http":

bfe_balance/bal_table.go

@@ -125,12 +125,11 @@ func (t *BalTable) gslbInit(gslbConfs gslb_conf.GslbConf) error {
 	t.versions.GslbConfTimeStamp = *gslbConfs.Ts
 	t.versions.GslbConfSrc = *gslbConfs.Hostname
 
-	if len(fails) == 0 {
-		return nil
-	} else {
+	if len(fails) != 0 {
 		return fmt.Errorf("error in ClusterTable.gslbInit() for [%s]",
 			strings.Join(fails, ","))
 	}
+	return nil
 }
 
 func (t *BalTable) backendInit(backendConfs cluster_table_conf.ClusterTableConf) error {
@@ -159,12 +158,11 @@ func (t *BalTable) backendInit(backendConfs cluster_table_conf.ClusterTableConf)
 	// update versions
 	t.versions.ClusterTableConfVer = *backendConfs.Version
 
-	if len(fails) == 0 {
-		return nil
-	} else {
+	if len(fails) != 0 {
 		return fmt.Errorf("error in ClusterTable.backendInit() for [%s]",
 			strings.Join(fails, ","))
 	}
+	return nil
 }
 
 // SetGslbBasic sets gslb basic conf (from server data conf) for BalTable.
@@ -244,11 +242,10 @@ func (t *BalTable) BalTableReload(gslbConfs gslb_conf.GslbConf,
 
 	t.lock.Unlock()
 
-	if len(fails) == 0 {
-		return nil
-	} else {
+	if len(fails) != 0 {
 		return fmt.Errorf("error in BalTableReload() for [%s]", strings.Join(fails, ","))
 	}
+	return nil
 }
 
 func (t *BalTable) lookup(clusterName string) (*bal_gslb.BalanceGslb, error) {

bfe_basic/action/action.go

@@ -62,7 +62,7 @@ type Action struct {
 	Params []string // params of action
 }
 
-// UnmarshalJson decodes given data in json format
+// UnmarshalJSON decodes given data in json format
 func (ac *Action) UnmarshalJSON(data []byte) error {
 	var actionFile ActionFile
 

bfe_basic/action/action_query.go

@@ -115,7 +115,7 @@ func ReqQueryRename(req *bfe_basic.Request, oldName string, newName string) {
 	req.HttpRequest.URL.RawQuery = rawQuery[1:]
 }
 
-// ReqQueryRename deletes some keys from query
+// ReqQueryDel deletes some keys from query
 func ReqQueryDel(req *bfe_basic.Request, keys []string) {
 	// add "&" prefix and suffix to simplify process
 	rawQuery := "&" + req.HttpRequest.URL.RawQuery + "&"

bfe_basic/common.go

@@ -47,7 +47,7 @@ func CreateInternalSrvErrResp(request *Request) *bfe_http.Response {
 	return CreateInternalResp(request, bfe_http.StatusInternalServerError)
 }
 
-// CreateInternalSrvErrResp returns a HTTP 403 response
+// CreateForbiddenResp returns a HTTP 403 response
 func CreateForbiddenResp(request *Request) *bfe_http.Response {
 	return CreateInternalResp(request, bfe_http.StatusForbidden)
 }

bfe_basic/condition/parser/walk.go

@@ -16,7 +16,7 @@
 
 package parser
 
-// A Visitor's Visit method is invoked for each node encountered by Walk.
+// Visitor wraps the Visit method which is invoked for each node encountered by Walk.
 // If the result visitor w is not nil, Walk visits each of the children
 // of node with the visitor w, followed by a call of w.Visit(nil).
 type Visitor interface {

bfe_basic/request.go

@@ -156,9 +156,8 @@ func (req *Request) SetRequestTransport(backend *backend.BfeBackend,
 func (req *Request) Protocol() string {
 	if req.Session.IsSecure {
 		return req.Session.Proto
-	} else {
-		return req.HttpRequest.Proto
 	}
+	return req.HttpRequest.Proto
 }
 
 func (r *Request) AddTags(name string, ntags []string) {

bfe_config/bfe_cluster_conf/cluster_conf/cluster_conf_load.go

@@ -90,7 +90,7 @@ type HashConf struct {
 	SessionSticky *bool
 }
 
-// Cluster conf for Gslb
+// GslbBasicConf is basic conf for Gslb
 type GslbBasicConf struct {
 	CrossRetry *int // retry cross sub clusters
 	RetryMax   *int // inner cluster retry
@@ -111,7 +111,7 @@ type ClusterBasicConf struct {
 	CancelOnClientClose *bool // cancel blocking operation on server if client connection disconnected
 }
 
-// ClusterBasicConf is conf of cluster.
+// ClusterConf is conf of cluster.
 type ClusterConf struct {
 	BackendConf  *BackendBasic     // backend's basic conf
 	CheckConf    *BackendCheck     // how to check backend
@@ -222,7 +222,7 @@ func MatchStatusCode(statusCodeGet int, statusCodeExpect int) (bool, error) {
 		statusCodeGet, convertStatusCode(statusCodeExpect))
 }
 
-// BackendBasicCheck check BackendCheck config.
+// BackendCheckCheck check BackendCheck config.
 func BackendCheckCheck(conf *BackendCheck) error {
 	if conf.Schem == nil {
 		// set default schem to http
@@ -337,7 +337,7 @@ func HashConfCheck(conf *HashConf) error {
 	return nil
 }
 
-// ClusterToConf check ClusterBasicConf.
+// ClusterBasicConfCheck check ClusterBasicConf.
 func ClusterBasicConfCheck(conf *ClusterBasicConf) error {
 	if conf.TimeoutReadClientAgain == nil ||
 		conf.TimeoutReadClient == nil ||
@@ -365,7 +365,7 @@ func ClusterBasicConfCheck(conf *ClusterBasicConf) error {
 	return nil
 }
 
-// ClusterBasicConfCheck check ClusterConf.
+// ClusterConfCheck check ClusterConf.
 func ClusterConfCheck(conf *ClusterConf) error {
 	var err error
 

bfe_config/bfe_route_conf/route_rule_conf/route_table_load.go

@@ -42,7 +42,7 @@ type RouteRuleFile struct {
 type RouteRules []RouteRule
 type RouteRuleFiles []RouteRuleFile
 
-// ProductRule holds mapping from product to rules.
+// ProductRouteRule holds mapping from product to rules.
 type ProductRouteRule map[string]RouteRules
 type ProductRouteRuleFile map[string]RouteRuleFiles
 

bfe_config/bfe_tls_conf/session_ticket_key_conf/session_ticket_key_conf.go

@@ -31,7 +31,7 @@ const (
 	RAW_SESSION_TICKET_KEY_SIZE = 48 // bytes
 )
 
-// config for session ticket key
+// SessionTicketKeyConf is session ticket key config.
 type SessionTicketKeyConf struct {
 	Version          string // version of config
 	SessionTicketKey string // session ticket key (hex encode)

bfe_http/cookie.go

@@ -57,7 +57,7 @@ type Cookie struct {
 
 type CookieMap map[string]*Cookie
 
-// parse cookies(slice) to req.Route.CookieMap(map)
+// CookieMapGet parse cookies(slice) to req.Route.CookieMap(map)
 func CookieMapGet(cookies []*Cookie) CookieMap {
 	cookieMap := make(CookieMap, len(cookies))
 

bfe_http/eof_reader.go

@@ -24,7 +24,7 @@ import (
 	"strings"
 )
 
-// eofReader is a non-nil io.ReadCloser that always returns EOF.
+// EofReader is a non-nil io.ReadCloser that always returns EOF.
 // It embeds a *strings.Reader so it still has a WriteTo method
 // and io.Copy won't need a buffer.
 var EofReader = &struct {

bfe_http/header.go

@@ -59,7 +59,8 @@ func (h Header) Get(key string) string {
 	return textproto.MIMEHeader(h).Get(key)
 }
 
-// get is like Get, but key must already be in CanonicalHeaderKey form.
+// GetDirect gets the value associated with the given key
+// in CanonicalHeaderKey form.
 func (h Header) GetDirect(key string) string {
 	if v := h[key]; len(v) > 0 {
 		return v[0]
@@ -233,7 +234,7 @@ func (h Header) writeSubsetWithoutSort(w io.Writer, exclude map[string]bool) err
 // canonical key for "accept-encoding" is "Accept-Encoding".
 func CanonicalHeaderKey(s string) string { return textproto.CanonicalMIMEHeaderKey(s) }
 
-// hasToken reports whether token appears with v, ASCII
+// HasToken reports whether token appears with v, ASCII
 // case-insensitive, with space or comma boundaries.
 // token must be all lowercase.
 // v may contain mixed cased.

bfe_http/httputil/persist.go

@@ -163,10 +163,9 @@ func (sc *ServerConn) Read() (req *http.Request, err error) {
 			// data before the close.
 			sc.re = ErrPersistEOF
 			return nil, sc.re
-		} else {
-			sc.re = err
-			return req, err
 		}
+		sc.re = err
+		return req, err
 	}
 	sc.lastbody = req.Body
 	sc.nread++

bfe_http/status.go

@@ -127,7 +127,7 @@ var StatusText = map[int]string{
 	statusNetworkAuthenticationRequired: "Network Authentication Required",
 }
 
-// StatusText returns a text for the HTTP status code. It returns the empty
+// StatusTextGet returns a text for the HTTP status code. It returns the empty
 // string if the code is unknown.
 func StatusTextGet(code int) string {
 	return StatusText[code]

bfe_http2/frame_test.go

@@ -1030,9 +1030,8 @@ func TestMetaFrameHeader(t *testing.T) {
 			str := func(v interface{}) string {
 				if _, ok := v.(error); ok {
 					return fmt.Sprintf("error %v", v)
-				} else {
-					return fmt.Sprintf("value %#v", v)
 				}
+				return fmt.Sprintf("value %#v", v)
 			}
 			t.Errorf("%s:\n got: %v\nwant: %s", name, str(got), str(tt.want))
 		}

bfe_http2/http2.go

@@ -279,7 +279,7 @@ func httpCodeString(code int) string {
 	return strconv.Itoa(code)
 }
 
-// connection-specific header fields which should be removed
+// HopHeaders are connection-specific header fields which should be removed
 // when endpoint generates an http/2 message
 var HopHeaders = map[string]bool{
 	"Connection":          true,
@@ -522,7 +522,7 @@ func strSliceContains(ss []string, s string) bool {
 	return false
 }
 
-// close underlying connection for request
+// CloseConn closes underlying connection for request
 func CloseConn(body io.ReadCloser) {
 	if b, ok := body.(*RequestBody); ok {
 		if b.conn != nil {
@@ -533,7 +533,7 @@ func CloseConn(body io.ReadCloser) {
 
 var http2Limiter http.FlowLimiter
 
-// init flow limiter for http2
+// SetFlowLimiter init flow limiter for http2
 func SetFlowLimiter(limiter http.FlowLimiter) {
 	http2Limiter = limiter
 }

bfe_http2/server.go

@@ -2501,9 +2501,8 @@ func (w *responseWriter) write(lenData int, dataB []byte, dataS string) (n int,
 
 	if dataB != nil {
 		return rws.bw.Write(dataB)
-	} else {
-		return rws.bw.WriteString(dataS)
 	}
+	return rws.bw.WriteString(dataS)
 }
 
 func (w *responseWriter) handlerDone() {

bfe_module/bfe_filter.go

@@ -48,13 +48,13 @@ import (
 	"github.com/baidu/bfe/bfe_http"
 )
 
-// ResponseFilter filters incomming requests and return a response or nil.
+// RequestFilter filters incomming requests and return a response or nil.
 // Filters are chained together into a HandlerList.
 type RequestFilter interface {
 	FilterRequest(request *bfe_basic.Request) (int, *bfe_http.Response)
 }
 
-// NewResponseFilter create a Filter by passed func.
+// NewRequestFilter create a Filter by passed func.
 func NewRequestFilter(f func(request *bfe_basic.Request) (int, *bfe_http.Response)) RequestFilter {
 	rf := new(genericRequestFilter)
 	rf.f = f
@@ -75,7 +75,7 @@ type ResponseFilter interface {
 	FilterResponse(req *bfe_basic.Request, res *bfe_http.Response) int
 }
 
-// NewRequestFilter creates a Filter by passed func
+// NewResponseFilter creates a Filter by passed func
 func NewResponseFilter(f func(req *bfe_basic.Request, res *bfe_http.Response) int) ResponseFilter {
 	rf := new(genericResponseFilter)
 	rf.f = f
@@ -95,7 +95,7 @@ type AcceptFilter interface {
 	FilterAccept(*bfe_basic.Session) int
 }
 
-// NewResponseFilter creates a Filter by passed func
+// NewAcceptFilter creates a Filter by passed func
 func NewAcceptFilter(f func(session *bfe_basic.Session) int) AcceptFilter {
 	rf := new(genericAcceptFilter)
 	rf.f = f
@@ -115,7 +115,7 @@ type ForwardFilter interface {
 	FilterForward(*bfe_basic.Request) int
 }
 
-// NewFinishFilter create a Filter by passed func
+// NewForwardFilter create a Filter by passed func
 func NewForwardFilter(f func(req *bfe_basic.Request) int) ForwardFilter {
 	rf := new(genericForwardFilter)
 	rf.f = f

bfe_module/bfe_handler_list.go

@@ -53,7 +53,7 @@ type HandlerList struct {
 	handlers *list.List /* list of handlers */
 }
 
-// NewFinishFilter creates a HandlerList.
+// NewHandlerList creates a HandlerList.
 func NewHandlerList(h_type int) *HandlerList {
 	handlers := new(HandlerList)
 
@@ -63,7 +63,7 @@ func NewHandlerList(h_type int) *HandlerList {
 	return handlers
 }
 
-// FinishFilter filters accept with HandlerList.
+// FilterAccept filters accept with HandlerList.
 func (hl *HandlerList) FilterAccept(session *bfe_basic.Session) int {
 	retVal := BFE_HANDLER_GOON
 

bfe_modules/mod_trust_clientip/trustip_conf_load.go

@@ -85,18 +85,18 @@ func TrustIPConfCheck(conf *TrustIPConfFile) error {
 	return nil
 }
 
-// load config of trust-ip from file
+// TrustIPConfLoad loads config of trust-ip from file
 func TrustIPConfLoad(filename string) (TrustIPConf, error) {
 	var conf TrustIPConf
 
-	/* open the file    */
+	// open the file
 	file, err1 := os.Open(filename)
 
 	if err1 != nil {
 		return conf, err1
 	}
 
-	/* decode the file  */
+	// decode the file
 	decoder := json.NewDecoder(file)
 
 	config := TrustIPConfFile{}

bfe_net/textproto/header.go

@@ -18,11 +18,11 @@
 
 package textproto
 
-// A MIMEHeader represents a MIME-style header mapping
+// MIMEHeader represents a MIME-style header mapping
 // keys to sets of values.
 type MIMEHeader map[string][]string
 
-// A MIMEKyes represents keys of header in original order
+// MIMEKyes represents keys of header in original order
 type MIMEKeys []string
 
 // Add adds the key, value pair to the header.

bfe_route/host_table.go

@@ -93,7 +93,7 @@ func (t *HostTable) updateRouteTable(conf *route_rule_conf.RouteTableConf) {
 	t.productRouteTable = conf.RuleMap
 }
 
-// update all
+// Update updates host table
 func (t *HostTable) Update(hostConf host_rule_conf.HostConf,
 	vipConf vip_rule_conf.VipConf, routeConf *route_rule_conf.RouteTableConf) {
 

bfe_server/bfe_confdata_load.go

@@ -258,7 +258,7 @@ func (srv *BfeServer) enableTLSNextProto(proto string) {
 	}
 }
 
-// NameConfLoad reloads name conf data.
+// NameConfReload reloads name conf data.
 func (srv *BfeServer) NameConfReload(query url.Values) error {
 	nameConfFile := query.Get("path")
 	if nameConfFile == "" {

bfe_server/find_location.go

@@ -75,7 +75,7 @@ func (srv *BfeServer) FindLocation(request *bfe_basic.Request) (string, error) {
 	return clusterName, nil
 }
 
-// FindProEnd finds product for proxied conn (under tls proxy mode).
+// FindProduct finds product for proxied conn (under tls proxy mode).
 func (srv *BfeServer) FindProduct(conn net.Conn) string {
 	sc := srv.GetServerConf()