Status files syntax
-------------------
-The status files hold and transmit status information of a single task (submission).
+A status file records all status information on a single submission.
-A status is an (unordered) dictionary of **key:value** entries and named subtrees.
+It is an (unordered) dictionary of **key:value** entries and named subtrees.
Keys of both the entries and subtrees may consist only of letters, numbers, ``-`` and ``_``
-(must match ``[a-zA-Z0-9-_]+``). The keys are case-sensitive.
+(must match ``[a-zA-Z0-9_-]+``). The keys are case-sensitive.
The values are arbitrary byte-strings not containing character ``\0`` (ASCII char. 0).
Note that this permits almost any encoding that can avoid the character ``\0``, such as UTF-8.
-When processing the values as strings, Moe decodes the strings as UTF-8 (unless stated otherwise).
+When processing the values as strings, Moe always uses UTF-8 (unless stated otherwise).
The format is line oriented (delimited by ``\n``),
whitespace characters (`` \t\r``) at the beginning of a line are ignored.
A subtree consists of a key followed by ``(``, the subtree is closed by ``)`` on a single line.
-Keys of entries and subtrees must be unique in every subtree, including the top-level of a status file.
+Keys of entries and of subtrees must be unique in every subtree, including the top level of the status file.
Status file grammar
^^^^^^^^^^^^^^^^^^^