Add godoc comments and fix linter warnings

Author: muesli

filesystems_linux.go

@@ -5,6 +5,7 @@ package main
 
 import "strings"
 
+//nolint:revive,deadcode
 const (
 	// man statfs
 	ADFS_SUPER_MAGIC      = 0xadf5
@@ -210,6 +211,7 @@ var fsTypeMap = map[int64]string{
 	ZFS_SUPER_MAGIC:             "zfs",                 /* 0x2FC12FC1 local */
 }
 
+/*
 var localMap = map[int64]bool{
 	AFS_SUPER_MAGIC:      true,
 	BTRFS_SUPER_MAGIC:    true,
@@ -225,6 +227,7 @@ var localMap = map[int64]bool{
 	XFS_SUPER_MAGIC:      true,
 	ZFS_SUPER_MAGIC:      true,
 }
+*/
 
 var networkMap = map[int64]bool{
 	CIFS_MAGIC_NUMBER: true,
@@ -254,9 +257,11 @@ var specialMap = map[int64]bool{
 	TRACEFS_MAGIC:          true,
 }
 
+/*
 func isLocalFs(m Mount) bool {
 	return localMap[int64(m.Stat().Type)] //nolint:unconvert
 }
+*/
 
 func isFuseFs(m Mount) bool {
 	return m.Stat().Type == FUSEBLK_SUPER_MAGIC ||

groups.go

@@ -13,6 +13,7 @@ const (
 	bindsMount    = "binds"
 )
 
+// FilterOptions contains all filters.
 type FilterOptions struct {
 	HiddenDevices map[string]struct{}
 	OnlyDevices   map[string]struct{}

main.go

@@ -15,7 +15,12 @@ import (
 )
 
 var (
-	Version   = ""
+	// Version contains the application version number. It's set via ldflags
+	// when building.
+	Version = ""
+
+	// CommitSHA contains the SHA of the commit that this application was built
+	// against. It's set via ldflags when building.
 	CommitSHA = ""
 
 	env   = termenv.EnvColorProfile()

mounts.go

@@ -30,7 +30,7 @@ func readLines(filename string) ([]string, error) {
 	if err != nil {
 		return nil, err
 	}
-	defer file.Close()
+	defer file.Close() //nolint:errcheck // ignore error
 
 	scanner := bufio.NewScanner(file)
 	var s []string
@@ -49,6 +49,7 @@ func unescapeFstab(path string) string {
 	return escaped
 }
 
+//nolint:deadcode,unused // used on BSD
 func byteToString(orig []byte) string {
 	n := -1
 	l := -1
@@ -72,6 +73,7 @@ func byteToString(orig []byte) string {
 	return string(orig[l:n])
 }
 
+//nolint:deadcode,unused // used on OpenBSD
 func intToString(orig []int8) string {
 	ret := make([]byte, len(orig))
 	size := -1

mounts_linux.go

@@ -42,6 +42,7 @@ const (
 	//mountinfoSuperOptions = 10
 )
 
+// Stat returns the mountpoint's stat information.
 func (m *Mount) Stat() unix.Statfs_t {
 	return m.Metadata.(unix.Statfs_t)
 }

table.go

@@ -12,12 +12,14 @@ import (
 	"github.com/muesli/termenv"
 )
 
+// TableOptions contains all options for the table.
 type TableOptions struct {
 	Columns []int
 	SortBy  int
 	Style   table.Style
 }
 
+// Column defines a column.
 type Column struct {
 	ID        string
 	Name      string

themes.go

@@ -6,6 +6,7 @@ import (
 	"github.com/muesli/termenv"
 )
 
+// Theme defines a color theme used for printing tables.
 type Theme struct {
 	colorRed     termenv.Color
 	colorYellow  termenv.Color