From 8a2721289c8f93f232a7f235a9c7f46d056c2f8d Mon Sep 17 00:00:00 2001 From: "brian m. carlson" Date: Sun, 23 Nov 2014 21:16:11 +0000 Subject: [PATCH] manual: document schema file format. Signed-off-by: brian m. carlson --- doc/manual.adoc | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/manual.adoc b/doc/manual.adoc index 6224658..6780bb5 100644 --- a/doc/manual.adoc +++ b/doc/manual.adoc @@ -42,3 +42,14 @@ accidentally corrupt each other. Schema File ~~~~~~~~~~~ + +The schema file is a CSV (colon-separated values) file. The first entry in the +file consist of the values `fmt`, the format version number, and `newfol schema +file`. + +newfol automatically upgrades schema files to the latest version, which at the +time of this writing, was 3. If no schema file exists, newfol will +automatically create a version 0 schema file and upgrade it to the latest +version on start. newfol does not accept schema files that have a newer version +than it currently supports, but it ignores directives it does not understand, +and so can be manually downgraded by editing the `fmt` directive.