# HG changeset patch
# User Jeff Hammel <jhammel@mozilla.com>
# Date 1307901140 25200
# Node ID c852ff04c940a2b20d8557a572e521a2d70865e2
# Parent  122e3eddcdeb1328283bdc1ca9b468f87a9c4a26
note formal syntax of section names

diff -r 122e3eddcdeb -r c852ff04c940 README.txt
--- a/README.txt	Sat Jun 11 14:56:43 2011 -0700
+++ b/README.txt	Sun Jun 12 10:52:20 2011 -0700
@@ -110,9 +110,26 @@
    the same as 3. but override the values in the ``bar`` section with
    ``app=%(object)s`` and ``value=1``
 
-* ``[name:path]``
-* ``[name:decorator:path]``
-* ``[name:decorator:overrides:path]``
+Section Name Syntax
+-------------------
+
+- *[name:resource]* : create an object named *name* , where resource
+  is either a section name or a *path* as described in `JSON Format`_ .
+  In the case where *resouce* is another section name, the options
+  will overide the options given in the *resource* section and a new
+  object named *name* will be created.  In the case where *section* is
+  a path, an object will be created as given by the *path* with the
+  given options.
+- *[name:decorator:resource]* : create an object named *name* where
+  the object given by *resource* is passed to *decorator*. Overrides
+  and loading is as described for *[name:reource]* . An anonymous
+  object is created of the whole section name for the wrapped
+  object. So this form results in two sections for the `JSON Format`_ .
+  *decorator* is a section in the same namespace as *name*.
+- *[name:decorator:overrides:resource]* : similar to
+  *[name:decorator:resource]* , but apply *overides* to the
+  *decorator* section.  *overrides* is a string of the format
+  ``foo,bar,fleem=5``.
 
 ----