diff --git a/backend/doc.go b/backend/doc.go index 99661c0bc..e85cef355 100644 --- a/backend/doc.go +++ b/backend/doc.go @@ -1,2 +1,2 @@ -// Package backend provides local and remote storage for restic backups. +// Package backend provides local and remote storage for restic repositories. package backend diff --git a/backend/local/doc.go b/backend/local/doc.go new file mode 100644 index 000000000..a2b160c4c --- /dev/null +++ b/backend/local/doc.go @@ -0,0 +1,2 @@ +// Package local implements repository storage in a local directory. +package local diff --git a/backend/sftp/doc.go b/backend/sftp/doc.go new file mode 100644 index 000000000..cd4a3a99b --- /dev/null +++ b/backend/sftp/doc.go @@ -0,0 +1,3 @@ +// Package sftp implements repository storage in a directory on a remote server +// via the sftp protocol. +package sftp diff --git a/cmd/restic/doc.go b/cmd/restic/doc.go new file mode 100644 index 000000000..19b609b8d --- /dev/null +++ b/cmd/restic/doc.go @@ -0,0 +1,2 @@ +// This package contains the code for the restic executable. +package main diff --git a/crypto/doc.go b/crypto/doc.go new file mode 100644 index 000000000..abbce210a --- /dev/null +++ b/crypto/doc.go @@ -0,0 +1,2 @@ +// Package crypto provides all cryptographic operations needed in restic. +package crypto diff --git a/debug/doc.go b/debug/doc.go new file mode 100644 index 000000000..a5a62e29b --- /dev/null +++ b/debug/doc.go @@ -0,0 +1,2 @@ +// Package debug provides an infrastructure for logging debug information and breakpoints. +package debug diff --git a/doc.go b/doc.go new file mode 100644 index 000000000..358dca240 --- /dev/null +++ b/doc.go @@ -0,0 +1,6 @@ +// Package restic is the top level package for the restic backup program, +// please see https://github.com/restic/restic for more information. +// +// This package exposes the main components needed to create and restore a +// backup as well as handling things like a local cache of objects. +package restic diff --git a/pack/doc.go b/pack/doc.go new file mode 100644 index 000000000..025e84737 --- /dev/null +++ b/pack/doc.go @@ -0,0 +1,2 @@ +// Package pack provides functions for combining and parsing pack files. +package pack diff --git a/pipe/doc.go b/pipe/doc.go new file mode 100644 index 000000000..ba5fc04ae --- /dev/null +++ b/pipe/doc.go @@ -0,0 +1,2 @@ +// Package pipe implements walking a directory in a deterministic order. +package pipe diff --git a/server/doc.go b/server/doc.go new file mode 100644 index 000000000..9e1f227a2 --- /dev/null +++ b/server/doc.go @@ -0,0 +1,2 @@ +// Package server implements a restic repository on top of a backend. +package server diff --git a/test/doc.go b/test/doc.go new file mode 100644 index 000000000..44183c141 --- /dev/null +++ b/test/doc.go @@ -0,0 +1,2 @@ +// Package test_helper provides helper functions for writing tests for restic. +package test_helper