From 861e1b9910a0108eebc7bb67363b7929b7628feb Mon Sep 17 00:00:00 2001 From: Alexander Neumann Date: Sat, 9 May 2015 13:00:01 +0200 Subject: [PATCH] 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