summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2021-09-15 08:38:05 +0300
committerLars Wirzenius <liw@liw.fi>2021-09-15 08:38:05 +0300
commit076e92da04ea5e3c052947bbc403812a92aad0c2 (patch)
treeafefbe66fb79dff154f6152ab0865eae8665a504
parent2107fccc5a82216263e5b2d90b40b0e1db0e5430 (diff)
downloadobnam2-076e92da04ea5e3c052947bbc403812a92aad0c2.tar.gz
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
-rw-r--r--obnam.md66
1 files 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&mdash;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&mdash;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.
-...