]> mj.ucw.cz Git - moe.git/commitdiff
Status file docs: A couple of minor improvements
authorMartin Mares <mj@ucw.cz>
Sat, 27 Nov 2010 14:05:19 +0000 (15:05 +0100)
committerMartin Mares <mj@ucw.cz>
Sat, 27 Nov 2010 14:05:19 +0000 (15:05 +0100)
t/doc/status.rst

index 873824a7332ebbb95e7de6df608c2c4321ff6435..c6baba484c847f4b586c00d083bd63c2c71213f6 100644 (file)
@@ -13,15 +13,15 @@ Moe status files
 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.
@@ -36,7 +36,7 @@ Multi-line values continue on following lines, prefixed by a single semicolon.
 
 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
 ^^^^^^^^^^^^^^^^^^^