summaryrefslogtreecommitdiff
path: root/src/lib.rs
blob: 87c57d19ee2f2f65723bbe2d395c7fd61877c266 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
//! Run benchmarks for the Obnam backup program.
//!
//! Obnam is a backup system. This crate a way to specifying
//! benchmarks in YAML and running them. A specification file looks
//! like:
//!
//! ```yaml
//! benchmarks:
//!   - benchmark: maildir
//!     backups:
//!       - changes:
//!           - create:
//!               files: 100
//!               file_size: 0
//!       - changes:
//!           - rename:
//!               files: 10
//!           - delete:
//!               files: 10
//!           - create:
//!               files: 10
//!               file_size: 0
//! ```
//!
//! A [specification][] is broken down into a sequence of
//! [steps](step). Steps, if executed in order, perform the benchmark.
//!
//! This crate only collects data from a set of benchmarks. It does
//! not analyze the data. The data can be stored for later analysis.

pub mod daemon;
pub mod obnam;
pub mod result;
pub mod specification;
pub mod step;
pub mod suite;