matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

State that modules can store data in the "imag" part of the header

Browse source
This commit is contained in:
Matthias Beyer 2016-01-11 09:29:13 +01:00
parent a377a9a031
commit e92cd8d558
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/src/02000-store.md
View file

@ -22,6 +22,11 @@ The contents of the header contain
data goes to. data goes to.
The contents of these sections are edited via commandline calls or by the The contents of these sections are edited via commandline calls or by the
program implicitely and SHOULD NOT be edited by the user. program implicitely and SHOULD NOT be edited by the user.
Modules of the program are free to store arbitrary data here.
If a module stores data in the header of a file it MUST do that in a
sub-section of the "imag" section, as TOML supports it.
The name of the subsection MUST BE the name of the module in lowercase
letters.
The section MAY BE empty. The section MAY BE empty.
1. Other OPTIONAL sections which are named and edited by the user. The program 1. Other OPTIONAL sections which are named and edited by the user. The program
MUST NOT touch the contents of these sections, except explicitely asked by MUST NOT touch the contents of these sections, except explicitely asked by