rustdoc: add crate level doc

Contains a link to the 'backup' module's doc, as that explains a lot
about the inner workings of PBS and probably marks a good entry point
for new readers.

Signed-off-by: Stefan Reiter <s.reiter@proxmox.com>
This commit is contained in:
Stefan Reiter 2020-10-15 12:49:15 +02:00 committed by Dietmar Maurer
parent 1a374fcfd6
commit 254b1f2213
1 changed files with 5 additions and 0 deletions

View File

@ -1,3 +1,8 @@
//! See the different modules for documentation on their usage.
//!
//! The [backup](backup/index.html) module contains some detailed information
//! on the inner workings of the backup server regarding data storage.
pub mod task; pub mod task;
#[macro_use] #[macro_use]