From 87206769c9f09626232922c28bebb3e9ea78dc02 Mon Sep 17 00:00:00 2001
From: Alexander Neumann <alexander@bumpern.de>
Date: Sat, 9 May 2015 12:52:46 +0200
Subject: [PATCH 1/4] Add minimal documentatation to restic package

---
 doc.go | 6 ++++++
 1 file changed, 6 insertions(+)
 create mode 100644 doc.go

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

From e4e502959f486646d367be6fd96c580fc12183c4 Mon Sep 17 00:00:00 2001
From: Alexander Neumann <alexander@bumpern.de>
Date: Sat, 9 May 2015 12:53:04 +0200
Subject: [PATCH 2/4] Clarify documentation on backend

---
 backend/doc.go | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

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

From 9ac6a1d232995c572ecad2ee2f571ae76b28f528 Mon Sep 17 00:00:00 2001
From: Alexander Neumann <alexander@bumpern.de>
Date: Sat, 9 May 2015 12:54:45 +0200
Subject: [PATCH 3/4] Add minimal documentation for backend/{local,sftp}

---
 backend/local/doc.go | 2 ++
 backend/sftp/doc.go  | 3 +++
 2 files changed, 5 insertions(+)
 create mode 100644 backend/local/doc.go
 create mode 100644 backend/sftp/doc.go

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

From 861e1b9910a0108eebc7bb67363b7929b7628feb Mon Sep 17 00:00:00 2001
From: Alexander Neumann <alexander@bumpern.de>
Date: Sat, 9 May 2015 13:00:01 +0200
Subject: [PATCH 4/4] Add doc stubs to all the packages

---
 cmd/restic/doc.go | 2 ++
 crypto/doc.go     | 2 ++
 debug/doc.go      | 2 ++
 pack/doc.go       | 2 ++
 pipe/doc.go       | 2 ++
 server/doc.go     | 2 ++
 test/doc.go       | 2 ++
 7 files changed, 14 insertions(+)
 create mode 100644 cmd/restic/doc.go
 create mode 100644 crypto/doc.go
 create mode 100644 debug/doc.go
 create mode 100644 pack/doc.go
 create mode 100644 pipe/doc.go
 create mode 100644 server/doc.go
 create mode 100644 test/doc.go

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/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