octoleo/restic
2
2
Fork 0
mirror of https://github.com/octoleo/restic.git synced 2024-12-31 14:01:58 +00:00
Code Issues Releases Wiki Activity

archiver: Add high-level documentation

Browse Source
This commit is contained in:
Alexander Neumann 2018-05-12 21:59:38 +02:00
parent 581c62ee72
commit 21c83b1725
2 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
internal/archiver/archiver.go
View File

@ -293,7 +293,8 @@ func (fn *FutureNode) wait(ctx context.Context) {
}
// Save saves a target (file or directory) to the repo. If the item is
// excluded,this function returns a nil node and error.
// excluded,this function returns a nil node and error, with excluded set to
// true.
//
// Errors and completion is needs to be handled by the caller.
//

12
internal/archiver/doc.go Normal file
View File

@ -0,0 +1,12 @@
// Package archiver contains the code which reads files, splits them into
// chunks and saves the data to the repository.
//
// An Archiver has a number of worker goroutines handling saving the different
// data structures to the repository, the details are implemented by the
// FileSaver, BlobSaver, and TreeSaver types.
//
// The main goroutine (the one calling Snapshot()) traverses the directory tree
// and delegates all work to these worker pools. They return a type
// (FutureFile, FutureBlob, and FutureTree) which can be resolved later, by
// calling Wait() on it.
package archiver