diff --git a/src/backup.rs b/src/backup.rs index a9d03e01..232a9330 100644 --- a/src/backup.rs +++ b/src/backup.rs @@ -1,15 +1,16 @@ -//! This module implements the proxmox backup chunked data storage +//! This module implements the proxmox backup data storage //! -//! A chunk is simply defined as binary blob. We store them inside a -//! `ChunkStore`, addressed by the SHA256 digest of the binary -//! blob. This technology is also known as content-addressable -//! storage. +//! Proxmox backup splits large files into chunks, and stores them +//! deduplicated using a content addressable storage format. //! -//! We store larger files by splitting them into chunks. The resulting -//! SHA256 digest list is stored as separate index file. The -//! `DynamicIndex*` format is able to deal with dynamic chunk sizes, -//! whereas the `FixedIndex*` format is an optimization to store a -//! list of equal sized chunks. +//! A chunk is simply defined as binary blob, which is stored inside a +//! `ChunkStore`, addressed by the SHA256 digest of the binary blob. +//! +//! Index files are used to reconstruct the original file. They +//! basically contain a list of SHA256 checksums. The `DynamicIndex*` +//! format is able to deal with dynamic chunk sizes, whereas the +//! `FixedIndex*` format is an optimization to store a list of equal +//! sized chunks. //! //! # ChunkStore Locking //! diff --git a/src/backup/data_blob.rs b/src/backup/data_blob.rs index 29337d98..1f9e3642 100644 --- a/src/backup/data_blob.rs +++ b/src/backup/data_blob.rs @@ -11,8 +11,10 @@ use super::*; /// /// Data blobs store arbitrary binary data (< 128MB), and can be /// compressed and encrypted. A simply binary format is used to store -/// them on disk or transfer them over the network. Please use index -/// files to store large data files (".fidx" of ".didx"). +/// them on disk or transfer them over the network. +/// +/// Please use index files to store large data files (".fidx" of +/// ".didx"). /// pub struct DataBlob { raw_data: Vec, // tagged, compressed, encryped data