From 8b04c60b677026005618f51dda710ac080216965 Mon Sep 17 00:00:00 2001 From: Martin Mares Date: Sat, 27 Nov 2010 15:05:19 +0100 Subject: [PATCH] Status file docs: A couple of minor improvements --- t/doc/status.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/t/doc/status.rst b/t/doc/status.rst index 873824a..c6baba4 100644 --- a/t/doc/status.rst +++ b/t/doc/status.rst @@ -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 ^^^^^^^^^^^^^^^^^^^ -- 2.39.2