build: add package comments to silence revive linter

backend/alias/alias.go

@@ -1,3 +1,4 @@
+// Package alias implements a virtual provider to rename existing remotes.
 package alias
 
 import (

backend/all/all.go

@@ -1,3 +1,4 @@
+// Package all imports all the backends
 package all
 
 import (

backend/azureblob/azureblob.go

@@ -1,8 +1,7 @@
-// Package azureblob provides an interface to the Microsoft Azure blob object storage system
-
 //go:build !plan9 && !solaris && !js
 // +build !plan9,!solaris,!js
 
+// Package azureblob provides an interface to the Microsoft Azure blob object storage system
 package azureblob
 
 import (

backend/b2/api/types.go

@@ -1,3 +1,4 @@
+// Package api provides types used by the Backblaze B2 API.
 package api
 
 import (

backend/b2/b2.go

@@ -1,4 +1,4 @@
-// Package b2 provides an interface to the Backblaze B2 object storage system
+// Package b2 provides an interface to the Backblaze B2 object storage system.
 package b2
 
 // FIXME should we remove sha1 checks from here as rclone now supports

backend/cache/cache.go

@@ -1,6 +1,7 @@
 //go:build !plan9 && !js
 // +build !plan9,!js
 
+// Package cache implements a virtual provider to cache existing remotes.
 package cache
 
 import (

backend/fichier/fichier.go

@@ -1,3 +1,4 @@
+// Package fichier provides an interface to the 1Fichier storage system.
 package fichier
 
 import (

backend/googlephotos/api/types.go

@@ -1,3 +1,4 @@
+// Package api provides types used by the Google Photos API.
 package api
 
 import (

backend/hdfs/hdfs.go

@@ -1,6 +1,7 @@
 //go:build !plan9
 // +build !plan9
 
+// Package hdfs provides an interface to the HDFS storage system.
 package hdfs
 
 import (

backend/hidrive/hidrivehash/internal/internal.go

@@ -1,3 +1,4 @@
+// Package internal provides utilities for HiDrive.
 package internal
 
 import (

backend/jottacloud/api/types.go

@@ -1,3 +1,4 @@
+// Package api provides types used by the Jottacloud API.
 package api
 
 import (

backend/jottacloud/jottacloud.go

@@ -1,3 +1,4 @@
+// Package jottacloud provides an interface to the Jottacloud storage system.
 package jottacloud
 
 import (

backend/koofr/koofr.go

@@ -1,3 +1,4 @@
+// Package koofr provides an interface to the Koofr storage system.
 package koofr
 
 import (

backend/mailru/api/m1.go

@@ -1,3 +1,4 @@
+// Package api provides types used by the Mail.ru API.
 package api
 
 import (

backend/mailru/mailru.go

@@ -1,3 +1,4 @@
+// Package mailru provides an interface to the Mail.ru Cloud storage system.
 package mailru
 
 import (

backend/onedrive/api/types.go

@@ -1,5 +1,4 @@
-// Types passed and returned to and from the API
-
+// Package api provides types used by the OneDrive API.
 package api
 
 import (

backend/opendrive/opendrive.go

@@ -1,3 +1,4 @@
+// Package opendrive provides an interface to the OpenDrive storage system.
 package opendrive
 
 import (

backend/putio/putio.go

@@ -1,3 +1,4 @@
+// Package putio provides an interface to the put.io storage system.
 package putio
 
 import (

backend/qingstor/qingstor.go

@@ -1,9 +1,8 @@
-// Package qingstor provides an interface to QingStor object storage
-// Home: https://www.qingcloud.com/
-
 //go:build !plan9 && !js
 // +build !plan9,!js
 
+// Package qingstor provides an interface to QingStor object storage
+// Home: https://www.qingcloud.com/
 package qingstor
 
 import (

backend/seafile/api/types.go

@@ -1,3 +1,4 @@
+// Package api provides types used by the Seafile API.
 package api
 
 // Some api objects are duplicated with only small differences,

backend/seafile/seafile.go

@@ -1,3 +1,4 @@
+// Package seafile provides an interface to the Seafile storage system.
 package seafile
 
 import (

backend/sftp/sftp.go

@@ -1,8 +1,7 @@
-// Package sftp provides a filesystem interface using github.com/pkg/sftp
-
 //go:build !plan9
 // +build !plan9
 
+// Package sftp provides a filesystem interface using github.com/pkg/sftp
 package sftp
 
 import (

backend/sia/api/types.go

@@ -1,3 +1,4 @@
+// Package api provides types used by the Sia API.
 package api
 
 import (

backend/sia/sia.go

@@ -1,3 +1,4 @@
+// Package sia provides an interface to the Sia storage system.
 package sia
 
 import (

backend/union/policy/all.go

@@ -1,3 +1,4 @@
+// Package policy provides utilities for the union implementation.
 package policy
 
 import (

backend/union/union.go

@@ -1,3 +1,4 @@
+// Package union implements a virtual provider to join existing remotes.
 package union
 
 import (

backend/union/upstream/upstream.go

@@ -1,3 +1,4 @@
+// Package upstream provides utility functionality to union.
 package upstream
 
 import (

backend/uptobox/api/types.go

@@ -1,3 +1,4 @@
+// Package api provides types used by the Uptobox API.
 package api
 
 import "fmt"

backend/uptobox/uptobox.go

@@ -1,3 +1,4 @@
+// Package uptobox provides an interface to the Uptobox storage system.
 package uptobox
 
 import (

backend/yandex/api/types.go

@@ -1,3 +1,4 @@
+// Package api provides types used by the Yandex API.
 package api
 
 import (

backend/yandex/yandex.go

@@ -1,3 +1,4 @@
+// Package yandex provides an interface to the Yandex storage system.
 package yandex
 
 import (

backend/zoho/api/types.go

@@ -1,3 +1,4 @@
+// Package api provides types used by the Zoho API.
 package api
 
 import (

cmd/about/about.go

@@ -1,3 +1,4 @@
+// Package about provides the about command.
 package about
 
 import (

cmd/authorize/authorize.go

@@ -1,3 +1,4 @@
+// Package authorize provides the authorize command.
 package authorize
 
 import (

cmd/backend/backend.go

@@ -1,3 +1,4 @@
+// Package backend provides the backend command.
 package backend
 
 import (

cmd/cachestats/cachestats.go

@@ -1,6 +1,7 @@
 //go:build !plan9 && !js
 // +build !plan9,!js
 
+// Package cachestats provides the cachestats command.
 package cachestats
 
 import (

cmd/cat/cat.go

@@ -1,3 +1,4 @@
+// Package cat provides the cat command.
 package cat
 
 import (

cmd/check/check.go

@@ -1,3 +1,4 @@
+// Package check provides the check command.
 package check
 
 import (

cmd/checksum/checksum.go

@@ -1,3 +1,4 @@
+// Package checksum provides the checksum command.
 package checksum
 
 import (

cmd/cleanup/cleanup.go

@@ -1,3 +1,4 @@
+// Package cleanup provides the cleanup command.
 package cleanup
 
 import (

cmd/cmount/mount.go

@@ -1,11 +1,10 @@
-// Package cmount implements a FUSE mounting system for rclone remotes.
-//
-// This uses the cgo based cgofuse library
-
 //go:build cmount && ((linux && cgo) || (darwin && cgo) || (freebsd && cgo) || windows)
 // +build cmount
 // +build linux,cgo darwin,cgo freebsd,cgo windows
 
+// Package cmount implements a FUSE mounting system for rclone remotes.
+//
+// This uses the cgo based cgofuse library
 package cmount
 
 import (

cmd/cmount/mount_brew.go

@@ -1,9 +1,10 @@
-// Build for macos with the brew tag to handle the absence
-// of fuse and print an appropriate error message
-
 //go:build brew && darwin
 // +build brew,darwin
 
+// Package cmount implements a FUSE mounting system for rclone remotes.
+//
+// Build for macos with the brew tag to handle the absence
+// of fuse and print an appropriate error message
 package cmount
 
 import (

cmd/cmount/mount_test.go

@@ -3,6 +3,8 @@
 // +build linux,cgo darwin,cgo freebsd,cgo windows
 // +build !race !windows
 
+// Package cmount implements a FUSE mounting system for rclone remotes.
+//
 // FIXME this doesn't work with the race detector under Windows either
 // hanging or producing lots of differences.
 

cmd/cmount/mount_unsupported.go

@@ -1,10 +1,11 @@
-// Build for cmount for unsupported platforms to stop go complaining
-// about "no buildable Go source files "
-
 //go:build !((linux && cgo && cmount) || (darwin && cgo && cmount) || (freebsd && cgo && cmount) || (windows && cmount))
 // +build !linux !cgo !cmount
 // +build !darwin !cgo !cmount
 // +build !freebsd !cgo !cmount
 // +build !windows !cmount
 
+// Package cmount implements a FUSE mounting system for rclone remotes.
+//
+// Build for cmount for unsupported platforms to stop go complaining
+// about "no buildable Go source files".
 package cmount

cmd/config/config.go

@@ -1,3 +1,4 @@
+// Package config provides the config command.
 package config
 
 import (

cmd/copy/copy.go

@@ -1,3 +1,4 @@
+// Package copy provides the copy command.
 package copy
 
 import (

cmd/copyto/copyto.go

@@ -1,3 +1,4 @@
+// Package copyto provides the copyto command.
 package copyto
 
 import (

cmd/copyurl/copyurl.go

@@ -1,3 +1,4 @@
+// Package copyurl provides the copyurl command.
 package copyurl
 
 import (

cmd/cryptcheck/cryptcheck.go

@@ -1,3 +1,4 @@
+// Package cryptcheck provides the cryptcheck command.
 package cryptcheck
 
 import (

cmd/cryptdecode/cryptdecode.go

@@ -1,3 +1,4 @@
+// Package cryptdecode provides the cryptdecode command.
 package cryptdecode
 
 import (

cmd/dedupe/dedupe.go

@@ -1,3 +1,4 @@
+// Package dedupe provides the dedupe command.
 package dedupe
 
 import (

cmd/delete/delete.go

@@ -1,3 +1,4 @@
+// Package delete provides the delete command.
 package delete
 
 import (

cmd/deletefile/deletefile.go

@@ -1,3 +1,4 @@
+// Package deletefile provides the deletefile command.
 package deletefile
 
 import (

cmd/genautocomplete/genautocomplete.go

@@ -1,3 +1,4 @@
+// Package genautocomplete provides the genautocomplete command.
 package genautocomplete
 
 import (

cmd/gendocs/gendocs.go

@@ -1,3 +1,4 @@
+// Package gendocs provides the gendocs command.
 package gendocs
 
 import (

cmd/hashsum/hashsum.go

@@ -1,3 +1,4 @@
+// Package hashsum provides the hashsum command.
 package hashsum
 
 import (

cmd/link/link.go

@@ -1,3 +1,4 @@
+// Package link provides the link command.
 package link
 
 import (

cmd/listremotes/listremotes.go

@@ -1,3 +1,4 @@
+// Package ls provides the ls command.
 package ls
 
 import (

cmd/ls/ls.go

@@ -1,3 +1,4 @@
+// Package ls provides the ls command.
 package ls
 
 import (

cmd/ls/lshelp/lshelp.go

@@ -1,3 +1,4 @@
+// Package lshelp provides common help for list commands.
 package lshelp
 
 import (

cmd/lsd/lsd.go

@@ -1,3 +1,4 @@
+// Package lsd provides the lsd command.
 package lsd
 
 import (

cmd/lsf/lsf.go

@@ -1,3 +1,4 @@
+// Package lsf provides the lsf command.
 package lsf
 
 import (

cmd/lsjson/lsjson.go

@@ -1,3 +1,4 @@
+// Package lsjson provides the lsjson command.
 package lsjson
 
 import (

cmd/lsl/lsl.go

@@ -1,3 +1,4 @@
+// Package lsl provides the lsl command.
 package lsl
 
 import (

cmd/md5sum/md5sum.go

@@ -1,3 +1,4 @@
+// Package md5sum provides the md5sum command.
 package md5sum
 
 import (

cmd/mkdir/mkdir.go

@@ -1,3 +1,4 @@
+// Package mkdir provides the mkdir command.
 package mkdir
 
 import (

cmd/mount/mount.go

@@ -1,8 +1,7 @@
-// Package mount implements a FUSE mounting system for rclone remotes.
-
 //go:build linux || freebsd
 // +build linux freebsd
 
+// Package mount implements a FUSE mounting system for rclone remotes.
 package mount
 
 import (

cmd/mount/mount_unsupported.go

@@ -1,9 +1,10 @@
-// Build for mount for unsupported platforms to stop go complaining
-// about "no buildable Go source files "
-
-// Invert the build constraint: linux freebsd
-
 //go:build !linux && !freebsd
 // +build !linux,!freebsd
 
+// Package mount implements a FUSE mounting system for rclone remotes.
+//
+// Build for mount for unsupported platforms to stop go complaining
+// about "no buildable Go source files".
+//
+// Invert the build constraint: linux freebsd
 package mount

cmd/mount2/mount.go

@@ -1,8 +1,7 @@
-// Package mount implements a FUSE mounting system for rclone remotes.
-
 //go:build linux || (darwin && amd64)
 // +build linux darwin,amd64
 
+// Package mount2 implements a FUSE mounting system for rclone remotes.
 package mount2
 
 import (

cmd/mount2/mount_unsupported.go

@@ -1,8 +1,9 @@
-// Build for mount for unsupported platforms to stop go complaining
-// about "no buildable Go source files "
-
 //go:build !linux && (!darwin || !amd64)
 // +build !linux
 // +build !darwin !amd64
 
+// Package mount2 implements a FUSE mounting system for rclone remotes.
+//
+// Build for mount for unsupported platforms to stop go complaining
+// about "no buildable Go source files".
 package mount2

cmd/mountlib/mount.go

@@ -1,3 +1,4 @@
+// Package mountlib provides the mount command.
 package mountlib
 
 import (

cmd/move/move.go

@@ -1,3 +1,4 @@
+// Package move provides the move command.
 package move
 
 import (

cmd/moveto/moveto.go

@@ -1,3 +1,4 @@
+// Package moveto provides the moveto command.
 package moveto
 
 import (

cmd/ncdu/ncdu.go

@@ -1,8 +1,7 @@
-// Package ncdu implements a text based user interface for exploring a remote
-
 //go:build !plan9 && !js
 // +build !plan9,!js
 
+// Package ncdu implements a text based user interface for exploring a remote
 package ncdu
 
 import (

cmd/obscure/obscure.go

@@ -1,3 +1,4 @@
+// Package obscure provides the obscure command.
 package obscure
 
 import (

cmd/purge/purge.go

@@ -1,3 +1,4 @@
+// Package purge provides the purge command.
 package purge
 
 import (

cmd/rc/rc.go

@@ -1,3 +1,4 @@
+// Package rc provides the rc command.
 package rc
 
 import (

cmd/rcat/rcat.go

@@ -1,3 +1,4 @@
+// Package rcat provides the rcat command.
 package rcat
 
 import (

cmd/rcd/rcd.go

@@ -1,3 +1,4 @@
+// Package rcd provides the rcd command.
 package rcd
 
 import (

cmd/reveal/reveal.go

@@ -1,3 +1,4 @@
+// Package reveal provides the reveal command.
 package reveal
 
 import (

cmd/rmdir/rmdir.go

@@ -1,3 +1,4 @@
+// Package rmdir provides the rmdir command.
 package rmdir
 
 import (

cmd/rmdirs/rmdirs.go

@@ -1,3 +1,4 @@
+// Package rmdir provides the rmdir command.
 package rmdir
 
 import (

cmd/selfupdate/selfupdate.go

@@ -1,6 +1,7 @@
 //go:build !noselfupdate
 // +build !noselfupdate
 
+// Package selfupdate provides the selfupdate command.
 package selfupdate
 
 import (

cmd/serve/dlna/data/data.go

@@ -1,6 +1,7 @@
-//go:generate go run assets_generate.go
+// Package data provides utilities for DLNA server.
 // The "go:generate" directive compiles static assets by running assets_generate.go
-
+//
+//go:generate go run assets_generate.go
 package data
 
 import (

cmd/serve/dlna/dlna.go

@@ -1,3 +1,4 @@
+// Package dlna provides DLNA server.
 package dlna
 
 import (

cmd/serve/dlna/dlnaflags/dlnaflags.go

@@ -1,3 +1,4 @@
+// Package dlnaflags provides utility functionality to DLNA.
 package dlnaflags
 
 import (

cmd/serve/dlna/upnpav/upnpav.go

@@ -1,3 +1,4 @@
+// Package upnpav provides utilities for DLNA server.
 package upnpav
 
 import (

cmd/serve/ftp/ftp.go

@@ -1,8 +1,7 @@
-// Package ftp implements an FTP server for rclone
-
 //go:build !plan9
 // +build !plan9
 
+// Package ftp implements an FTP server for rclone
 package ftp
 
 import (

cmd/serve/http/data/data.go

@@ -1,6 +1,7 @@
-//go:generate go run assets_generate.go
+// Package data provides common functionality for http servers
 // The "go:generate" directive compiles static assets by running assets_generate.go
-
+//
+//go:generate go run assets_generate.go
 package data
 
 import (

cmd/serve/http/http.go

@@ -1,3 +1,4 @@
+// Package http provides common functionality for http servers
 package http
 
 import (

cmd/serve/httplib/httpflags/httpflags.go

@@ -1,3 +1,4 @@
+// Package httpflags provides utility functionality to HTTP.
 package httpflags
 
 import (

cmd/serve/serve.go

@@ -1,3 +1,4 @@
+// Package serve provides the serve command.
 package serve
 
 import (

cmd/serve/sftp/sftp.go

@@ -1,8 +1,7 @@
-// Package sftp implements an SFTP server to serve an rclone VFS
-
 //go:build !plan9
 // +build !plan9
 
+// Package sftp implements an SFTP server to serve an rclone VFS
 package sftp
 
 import (

cmd/settier/settier.go

@@ -1,3 +1,4 @@
+// Package settier provides the settier command.
 package settier
 
 import (

cmd/sha1sum/sha1sum.go

@@ -1,3 +1,4 @@
+// Package sha1sum provides the sha1sum command.
 package sha1sum
 
 import (

cmd/size/size.go

@@ -1,3 +1,4 @@
+// Package size provides the size command.
 package size
 
 import (

cmd/sync/sync.go

@@ -1,3 +1,4 @@
+// Package sync provides the sync command.
 package sync
 
 import (

cmd/test/histogram/histogram.go

@@ -1,3 +1,4 @@
+// Package histogram provides the histogram test command.
 package histogram
 
 import (

cmd/test/info/info.go

@@ -1,3 +1,4 @@
+// Package info provides the info test command.
 package info
 
 // FIXME once translations are implemented will need a no-escape

cmd/test/info/internal/build_csv/main.go

@@ -1,3 +1,4 @@
+// Package main provides utilities for the info test command.
 package main
 
 import (