Merge pull request #177 from restic/add-src-doc

Add code documentation

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

backend/local/doc.go

@@ -0,0 +1,2 @@
+// Package local implements repository storage in a local directory.
+package local

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

cmd/restic/doc.go

@@ -0,0 +1,2 @@
+// This package contains the code for the restic executable.
+package main

crypto/doc.go

@@ -0,0 +1,2 @@
+// Package crypto provides all cryptographic operations needed in restic.
+package crypto

debug/doc.go

@@ -0,0 +1,2 @@
+// Package debug provides an infrastructure for logging debug information and breakpoints.
+package debug

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

pack/doc.go

@@ -0,0 +1,2 @@
+// Package pack provides functions for combining and parsing pack files.
+package pack

pipe/doc.go

@@ -0,0 +1,2 @@
+// Package pipe implements walking a directory in a deterministic order.
+package pipe

server/doc.go

@@ -0,0 +1,2 @@
+// Package server implements a restic repository on top of a backend.
+package server

test/doc.go

@@ -0,0 +1,2 @@
+// Package test_helper provides helper functions for writing tests for restic.
+package test_helper