Fix lint errors

Author: op

backend.go

@@ -13,7 +13,7 @@ type Backend interface {
 	Log(Level, int, *Record) error
 }
 
-// Set backend replaces the backend currently set with the given new logging
+// SetBackend replaces the backend currently set with the given new logging
 // backend.
 func SetBackend(backends ...Backend) LeveledBackend {
 	var backend Backend

format.go

@@ -28,7 +28,7 @@ type fmtVerb int
 const (
 	fmtVerbTime fmtVerb = iota
 	fmtVerbLevel
-	fmtVerbId
+	fmtVerbID
 	fmtVerbPid
 	fmtVerbProgram
 	fmtVerbModule
@@ -115,10 +115,10 @@ func getFormatter() Formatter {
 
 var (
 	// DefaultFormatter is the default formatter used and is only the message.
-	DefaultFormatter Formatter = MustStringFormatter("%{message}")
+	DefaultFormatter = MustStringFormatter("%{message}")
 
-	// Glog format
-	GlogFormatter Formatter = MustStringFormatter("%{level:.1s}%{time:0102 15:04:05.999999} %{pid} %{shortfile}] %{message}")
+	// GlogFormatter mimics the glog format
+	GlogFormatter = MustStringFormatter("%{level:.1s}%{time:0102 15:04:05.999999} %{pid} %{shortfile}] %{message}")
 )
 
 // SetFormatter sets the default formatter for all new backends. A backend will
@@ -131,7 +131,7 @@ func SetFormatter(f Formatter) {
 	formatter.def = f
 }
 
-var formatRe *regexp.Regexp = regexp.MustCompile(`%{([a-z]+)(?::(.*?[^\\]))?}`)
+var formatRe = regexp.MustCompile(`%{([a-z]+)(?::(.*?[^\\]))?}`)
 
 type part struct {
 	verb   fmtVerb
@@ -184,7 +184,7 @@ type stringFormatter struct {
 //     %{shortpkg}  Base package path, eg. go-logging
 //     %{longfunc}  Full function name, eg. littleEndian.PutUint32
 //     %{shortfunc} Base function name, eg. PutUint32
-func NewStringFormatter(format string) (*stringFormatter, error) {
+func NewStringFormatter(format string) (Formatter, error) {
 	var fmter = &stringFormatter{}
 
 	// Find the boundaries of all %{vars}
@@ -246,7 +246,7 @@ func NewStringFormatter(format string) (*stringFormatter, error) {
 
 // MustStringFormatter is equivalent to NewStringFormatter with a call to panic
 // on error.
-func MustStringFormatter(format string) *stringFormatter {
+func MustStringFormatter(format string) Formatter {
 	f, err := NewStringFormatter(format)
 	if err != nil {
 		panic("Failed to initialized string formatter: " + err.Error())
@@ -272,7 +272,7 @@ func (f *stringFormatter) Format(calldepth int, r *Record, output io.Writer) err
 			case fmtVerbLevel:
 				v = r.Level
 				break
-			case fmtVerbId:
+			case fmtVerbID:
 				v = r.Id
 				break
 			case fmtVerbPid:
@@ -349,7 +349,7 @@ type backendFormatter struct {
 
 // NewBackendFormatter creates a new backend which makes all records that
 // passes through it beeing formatted by the specific formatter.
-func NewBackendFormatter(b Backend, f Formatter) *backendFormatter {
+func NewBackendFormatter(b Backend, f Formatter) Backend {
 	return &backendFormatter{b, f}
 }
 

level.go

@@ -10,11 +10,13 @@ import (
 	"sync"
 )
 
+// ErrInvalidLogLevel is used when an invalid log level has been used.
 var ErrInvalidLogLevel = errors.New("logger: invalid log level")
 
 // Level defines all available log levels for log messages.
 type Level int
 
+// Log levels.
 const (
 	CRITICAL Level = iota
 	ERROR
@@ -48,6 +50,8 @@ func LogLevel(level string) (Level, error) {
 	return ERROR, ErrInvalidLogLevel
 }
 
+// Leveled interface is the interface required to be able to add leveled
+// logging.
 type Leveled interface {
 	GetLevel(string) Level
 	SetLevel(Level, string)

log_nix.go

@@ -41,6 +41,7 @@ func NewLogBackend(out io.Writer, prefix string, flag int) *LogBackend {
 	return &LogBackend{Logger: log.New(out, prefix, flag)}
 }
 
+// Log implements the Backend interface.
 func (b *LogBackend) Log(level Level, calldepth int, rec *Record) error {
 	if b.Color {
 		buf := &bytes.Buffer{}
@@ -50,9 +51,9 @@ func (b *LogBackend) Log(level Level, calldepth int, rec *Record) error {
 		// For some reason, the Go logger arbitrarily decided "2" was the correct
 		// call depth...
 		return b.Logger.Output(calldepth+2, buf.String())
-	} else {
-		return b.Logger.Output(calldepth+2, rec.Formatted(calldepth+1))
 	}
+
+	return b.Logger.Output(calldepth+2, rec.Formatted(calldepth+1))
 }
 
 func colorSeq(color color) string {

logger.go

@@ -55,6 +55,7 @@ type Record struct {
 	formatted string
 }
 
+// Formatted returns the formatted log record string.
 func (r *Record) Formatted(calldepth int) string {
 	if r.formatted == "" {
 		var buf bytes.Buffer
@@ -64,6 +65,7 @@ func (r *Record) Formatted(calldepth int) string {
 	return r.formatted
 }
 
+// Message returns the log record message.
 func (r *Record) Message() string {
 	if r.message == nil {
 		// Redact the arguments that implements the Redactor interface
@@ -78,6 +80,8 @@ func (r *Record) Message() string {
 	return *r.message
 }
 
+// Logger is the actual logger which creates log records based on the functions
+// called and passes them to the underlying logging backend.
 type Logger struct {
 	Module      string
 	backend     LeveledBackend
@@ -88,12 +92,14 @@ type Logger struct {
 	ExtraCalldepth int
 }
 
+// SetBackend overrides any previously defined backend for this logger.
 func (l *Logger) SetBackend(backend LeveledBackend) {
 	l.backend = backend
 	l.haveBackend = true
 }
 
 // TODO call NewLogger and remove MustGetLogger?
+
 // GetLogger creates and returns a Logger object based on the module name.
 func GetLogger(module string) (*Logger, error) {
 	return &Logger{Module: module}, nil

memory.go

@@ -199,7 +199,7 @@ func (b *ChannelMemoryBackend) insertRecord(rec *Record) {
 	if b.maxSize > 0 && b.size >= b.maxSize {
 		b.head = b.head.next
 	} else {
-		b.size += 1
+		b.size++
 	}
 }
 

syslog.go

@@ -31,6 +31,7 @@ func NewSyslogBackendPriority(prefix string, priority syslog.Priority) (b *Syslo
 	return &SyslogBackend{w}, err
 }
 
+// Log implements the Backend interface.
 func (b *SyslogBackend) Log(level Level, calldepth int, rec *Record) error {
 	line := rec.Formatted(calldepth + 1)
 	switch level {