pestctrl/newfol
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

manual: document schema file format.

Browse source 
Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
This commit is contained in:
brian m. carlson 2014-11-23 21:16:11 +00:00
parent 358efbab51
commit 8a2721289c
No known key found for this signature in database
GPG key ID: BF535D811F52F68B
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
doc/manual.adoc
View file

@ -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.