build: add package comments to silence revive linter

This commit is contained in:
albertony 2022-08-28 13:21:57 +02:00
parent 02b7613104
commit 555def2da7
132 changed files with 164 additions and 68 deletions

View File

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

View File

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

View File

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

View File

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

View File

@ -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 package b2
// FIXME should we remove sha1 checks from here as rclone now supports // FIXME should we remove sha1 checks from here as rclone now supports

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -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) //go:build cmount && ((linux && cgo) || (darwin && cgo) || (freebsd && cgo) || windows)
// +build cmount // +build cmount
// +build linux,cgo darwin,cgo freebsd,cgo windows // +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 package cmount
import ( import (

View File

@ -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 //go:build brew && darwin
// +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 package cmount
import ( import (

View File

@ -3,6 +3,8 @@
// +build linux,cgo darwin,cgo freebsd,cgo windows // +build linux,cgo darwin,cgo freebsd,cgo windows
// +build !race !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 // FIXME this doesn't work with the race detector under Windows either
// hanging or producing lots of differences. // hanging or producing lots of differences.

View File

@ -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)) //go:build !((linux && cgo && cmount) || (darwin && cgo && cmount) || (freebsd && cgo && cmount) || (windows && cmount))
// +build !linux !cgo !cmount // +build !linux !cgo !cmount
// +build !darwin !cgo !cmount // +build !darwin !cgo !cmount
// +build !freebsd !cgo !cmount // +build !freebsd !cgo !cmount
// +build !windows !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 package cmount

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -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 //go:build !linux && !freebsd
// +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 package mount

View File

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

View File

@ -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) //go:build !linux && (!darwin || !amd64)
// +build !linux // +build !linux
// +build !darwin !amd64 // +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 package mount2

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -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 // The "go:generate" directive compiles static assets by running assets_generate.go
//
//go:generate go run assets_generate.go
package data package data
import ( import (

View File

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

View File

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

View File

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

View File

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

View File

@ -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 // The "go:generate" directive compiles static assets by running assets_generate.go
//
//go:generate go run assets_generate.go
package data package data
import ( import (

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

Some files were not shown because too many files have changed in this diff Show More