make vet and lint happy

2 files changed, 20 insertions, 15 deletions

diff --git a/logger/logger.go b/logger/logger.go
index 782a47629d..1201dbc9bf 100644
--- a/logger/logger.go
+++ b/logger/logger.go
@@ -26,6 +26,7 @@ import (
	"sync"
 )
 
+// A Logger is a fairly minimal logging tool.
 type Logger interface {
	// Notice is for messages that the user should see
	Notice(msg string)
@@ -34,8 +35,11 @@ type Logger interface {
 }
 
 const (
-	DefaultFlags = log.Ldate | log.Ltime | log.Lmicroseconds | log.Lshortfile
-	SyslogFlags = log.Lshortfile
+	// DefaultFlags are passed to the default console log.Logger
+	DefaultFlags = log.Ldate | log.Ltime | log.Lmicroseconds | log.Lshortfile
+	// SyslogFlags are passed to the default syslog log.Logger
+	SyslogFlags = log.Lshortfile
+	// SyslogPriority for the default syslog log.Logger
	SyslogPriority = syslog.LOG_DEBUG | syslog.LOG_USER
 )
 
@@ -52,8 +56,8 @@ var (
	lock sync.Mutex
 )
 
-// Panic notifies the user and then panics
-func Panic(format string, v ...interface{}) {
+// Panicf notifies the user and then panics
+func Panicf(format string, v ...interface{}) {
	msg := fmt.Sprintf(format, v...)
 
	lock.Lock()
@@ -63,8 +67,8 @@ func Panic(format string, v ...interface{}) {
	panic(msg)
 }
 
-// Notice notifies the user of something
-func Notice(format string, v ...interface{}) {
+// Noticef notifies the user of something
+func Noticef(format string, v ...interface{}) {
	msg := fmt.Sprintf(format, v...)
 
	lock.Lock()
@@ -73,8 +77,8 @@ func Notice(format string, v ...interface{}) {
	logger.Notice(msg)
 }
 
-// Debug records something in the debug log
-func Debug(format string, v ...interface{}) {
+// Debugf records something in the debug log
+func Debugf(format string, v ...interface{}) {
	msg := fmt.Sprintf(format, v...)
 
	lock.Lock()
@@ -83,7 +87,7 @@ func Debug(format string, v ...interface{}) {
	logger.Debug(msg)
 }
 
-// Set the global logger to the given one
+// SetLogger sets the global logger to the given one
 func SetLogger(l Logger) {
	lock.Lock()
	defer lock.Unlock()
@@ -122,6 +126,7 @@ func NewConsoleLog(w io.Writer, flag int) (*ConsoleLog, error) {
	}, nil
 }
 
+// SimpleSetup creates the default (console) logger
 func SimpleSetup() error {
	l, err := NewConsoleLog(os.Stderr, DefaultFlags)
	if err != nil {
diff --git a/logger/logger_test.go b/logger/logger_test.go
index 4865982215..f24ccdfa90 100644
--- a/logger/logger_test.go
+++ b/logger/logger_test.go
@@ -61,7 +61,7 @@ func (s *LogSuite) TestNew(c *C) {
	c.Check(l.log, NotNil)
 }
 
-func (s *LogSuite) TestDebug(c *C) {
+func (s *LogSuite) TestDebugf(c *C) {
	var logbuf bytes.Buffer
	var sysbuf bytes.Buffer
	l, err := NewConsoleLog(&logbuf, DefaultFlags)
@@ -70,12 +70,12 @@ func (s *LogSuite) TestDebug(c *C) {
	l.sys = log.New(&sysbuf, "", SyslogFlags)
	SetLogger(l)
 
-	Debug("xyzzy")
+	Debugf("xyzzy")
	c.Check(sysbuf.String(), Matches, `(?m).*logger_test\.go:\d+: DEBUG: xyzzy`)
	c.Check(logbuf.String(), Equals, "")
 }
 
-func (s *LogSuite) TestNotice(c *C) {
+func (s *LogSuite) TestNoticef(c *C) {
	var logbuf bytes.Buffer
	var sysbuf bytes.Buffer
	l, err := NewConsoleLog(&logbuf, DefaultFlags)
@@ -84,12 +84,12 @@ func (s *LogSuite) TestNotice(c *C) {
	l.sys = log.New(&sysbuf, "", SyslogFlags)
	SetLogger(l)
 
-	Notice("xyzzy")
+	Noticef("xyzzy")
	c.Check(sysbuf.String(), Matches, `(?m).*logger_test\.go:\d+: xyzzy`)
	c.Check(logbuf.String(), Matches, `(?m).*logger_test\.go:\d+: xyzzy`)
 }
 
-func (s *LogSuite) TestPanic(c *C) {
+func (s *LogSuite) TestPanicf(c *C) {
	var logbuf bytes.Buffer
	var sysbuf bytes.Buffer
	l, err := NewConsoleLog(&logbuf, DefaultFlags)
@@ -98,7 +98,7 @@ func (s *LogSuite) TestPanic(c *C) {
	l.sys = log.New(&sysbuf, "", SyslogFlags)
	SetLogger(l)
 
-	c.Check(func() { Panic("xyzzy") }, Panics, "xyzzy")
+	c.Check(func() { Panicf("xyzzy") }, Panics, "xyzzy")
	c.Check(sysbuf.String(), Matches, `(?m).*logger_test\.go:\d+: PANIC xyzzy`)
	c.Check(logbuf.String(), Matches, `(?m).*logger_test\.go:\d+: PANIC xyzzy`)
 }