Lint on pkg/* packages

- pkg/useragent
- pkg/units
- pkg/ulimit
- pkg/truncindex
- pkg/timeoutconn
- pkg/term
- pkg/tarsum
- pkg/tailfile
- pkg/systemd
- pkg/stringutils
- pkg/stringid
- pkg/streamformatter
- pkg/sockets
- pkg/signal
- pkg/proxy
- pkg/progressreader
- pkg/pools
- pkg/plugins
- pkg/pidfile
- pkg/parsers
- pkg/parsers/filters
- pkg/parsers/kernel
- pkg/parsers/operatingsystem

Signed-off-by: Vincent Demeester <vincent@sbr.pm>

signal/signal.go

@@ -1,3 +1,5 @@
+// Package signal provides helper functions for dealing with signals across
+// various operating systems.
 package signal
 
 import (
@@ -5,6 +7,7 @@ import (
 	"os/signal"
 )
 
+// CatchAll catches all signals and relays them to the specified channel.
 func CatchAll(sigc chan os.Signal) {
 	handledSigs := []os.Signal{}
 	for _, s := range SignalMap {
@@ -13,6 +16,7 @@ func CatchAll(sigc chan os.Signal) {
 	signal.Notify(sigc, handledSigs...)
 }
 
+// StopCatch stops catching the signals and closes the specified channel.
 func StopCatch(sigc chan os.Signal) {
 	signal.Stop(sigc)
 	close(sigc)

signal/signal_darwin.go

@@ -4,6 +4,7 @@ import (
 	"syscall"
 )
 
+// SignalMap is a map of Darwin signals.
 var SignalMap = map[string]syscall.Signal{
 	"ABRT":   syscall.SIGABRT,
 	"ALRM":   syscall.SIGALRM,

signal/signal_freebsd.go

@@ -4,6 +4,7 @@ import (
 	"syscall"
 )
 
+// SignalMap is a map of FreeBSD signals.
 var SignalMap = map[string]syscall.Signal{
 	"ABRT":   syscall.SIGABRT,
 	"ALRM":   syscall.SIGALRM,

signal/signal_linux.go

@@ -4,6 +4,7 @@ import (
 	"syscall"
 )
 
+// SignalMap is a map of Linux signals.
 var SignalMap = map[string]syscall.Signal{
 	"ABRT":   syscall.SIGABRT,
 	"ALRM":   syscall.SIGALRM,

signal/signal_unix.go

@@ -8,5 +8,9 @@ import (
 
 // Signals used in api/client (no windows equivalent, use
 // invalid signals so they don't get handled)
+
+// SIGCHLD is a signal sent to a process when a child process terminates, is interrupted, or resumes after being interrupted.
 const SIGCHLD = syscall.SIGCHLD
+
+// SIGWINCH is a signal sent to a process when its controlling terminal changes its size
 const SIGWINCH = syscall.SIGWINCH

signal/signal_unsupported.go

@@ -6,4 +6,5 @@ import (
 	"syscall"
 )
 
+// SignalMap is an empty map of signals for unsupported platform.
 var SignalMap = map[string]syscall.Signal{}

signal/signal_windows.go

@@ -8,5 +8,7 @@ import (
 
 // Signals used in api/client (no windows equivalent, use
 // invalid signals so they don't get handled)
-const SIGCHLD = syscall.Signal(0xff)
-const SIGWINCH = syscall.Signal(0xff)
+const (
+	SIGCHLD  = syscall.Signal(0xff)
+	SIGWINCH = syscall.Signal(0xff)
+)

signal/trap.go

@@ -55,6 +55,7 @@ func Trap(cleanup func()) {
 	}()
 }
 
+// DumpStacks dumps the runtime stack.
 func DumpStacks() {
 	buf := make([]byte, 16384)
 	buf = buf[:runtime.Stack(buf, true)]