From 076e92da04ea5e3c052947bbc403812a92aad0c2 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Wed, 15 Sep 2021 08:38:05 +0300 Subject: refactor: move document metadata to top My Emacs' markdown-mode no longer gets confused by this and it's clearer tot have it at the top. Sponsored-by: author --- obnam.md | 66 +++++++++++++++++++++++++++++----------------------------------- 1 file changed, 30 insertions(+), 36 deletions(-) diff --git a/obnam.md b/obnam.md index 1a24d7a..e314e6d 100644 --- a/obnam.md +++ b/obnam.md @@ -1,3 +1,33 @@ +--- +title: "Obnam2—a backup system" +author: Lars Wirzenius +documentclass: report +bindings: + - subplot/server.yaml + - subplot/client.yaml + - subplot/data.yaml + - lib/files.yaml + - lib/runcmd.yaml +template: python +functions: + - subplot/server.py + - subplot/client.py + - subplot/data.py + - lib/daemon.py + - lib/files.py + - lib/runcmd.py +classes: + - json +abstract: | + Obnam is a backup system, consisting of a not very smart server for + storing chunks of backup data, and a client that splits the user's + data into chunks. They communicate via HTTP. + + This document describes the architecture and acceptance criteria for + Obnam, as well as how the acceptance criteria are verified. +... + + # Introduction Obnam2 is a backup system. @@ -1803,39 +1833,3 @@ made, the passphrase is not stored in cleartext on the server. Verify that the backup repository does not contain the backed up data in cleartext. - - - - -# Colophon - -This manual is edited in Markdown and typeset using [Subplot][]. - ---- -title: "Obnam2—a backup system" -author: Lars Wirzenius -documentclass: report -bindings: - - subplot/server.yaml - - subplot/client.yaml - - subplot/data.yaml - - lib/files.yaml - - lib/runcmd.yaml -template: python -functions: - - subplot/server.py - - subplot/client.py - - subplot/data.py - - lib/daemon.py - - lib/files.py - - lib/runcmd.py -classes: - - json -abstract: | - Obnam is a backup system, consisting of a not very smart server for - storing chunks of backup data, and a client that splits the user's - data into chunks. They communicate via HTTP. - - This document describes the architecture and acceptance criteria for - Obnam, as well as how the acceptance criteria are verified. -... -- cgit v1.2.1