diff options
author | Lars Wirzenius <liw@liw.fi> | 2015-12-25 13:06:49 +0100 |
---|---|---|
committer | Lars Wirzenius <liw@liw.fi> | 2015-12-26 16:44:58 +0100 |
commit | f097c61b1c1435d4849a33930cb75332dc7158dc (patch) | |
tree | f7632248ce5bb584ac11fe9de64dfba7e67a366f /yarns/100-intro.yarn | |
parent | da859589e5295e5d050abff73773c006cf81ead1 (diff) | |
download | obnam-benchmarks-f097c61b1c1435d4849a33930cb75332dc7158dc.tar.gz |
Rewrite obbench, adding yarns and Debian packaging
Diffstat (limited to 'yarns/100-intro.yarn')
-rw-r--r-- | yarns/100-intro.yarn | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/yarns/100-intro.yarn b/yarns/100-intro.yarn new file mode 100644 index 0000000..b59b142 --- /dev/null +++ b/yarns/100-intro.yarn @@ -0,0 +1,26 @@ +# Introduction + +This is the manual for `obbench`, a tool for benchmarking the +[Obnam][] backup program. The obbench program is at least the fifth +generation of the tool: the author seems to have a big difficulty +trying to figure out how benchmarking should be done. + +[Obnam]: http://obnam.org/ + +The obbench approach is that its operation is defined in a benchmark +specification file, rather than code. The code provides some primitive +operations, which can be combined in various ways in the specification +file. The goal is that new benchmarks can be specified easily, without +changing obbench itself. + +Additionally, obbench measures various aspects of running Obnam and +the resulting backup repository, and generates a static website to +report the results. + +## Installation + +Obbench can be run from its git source tree (`./obbench`), without any +build steps required. Additionally, the author will provide Debian +packages on [code.liw.fi][]. + +[code.liw.fi]: http://liw.fi/code/ |