]> granicus.if.org Git - python/commitdiff
Make example of file inclusion in setupcfg more obvious
authorÉric Araujo <merwok@netwok.org>
Sun, 5 Jun 2011 23:58:25 +0000 (01:58 +0200)
committerÉric Araujo <merwok@netwok.org>
Sun, 5 Jun 2011 23:58:25 +0000 (01:58 +0200)
Doc/packaging/setupcfg.rst

index 0d820d982201973a3947ca8cd774ee7d4ba82866..1999f1813446ce10dad82d573c71ee907146cac8 100644 (file)
@@ -77,38 +77,37 @@ or more files which will be merged into the current files by adding new sections
 and fields.  If a file loaded by ``extends`` contains sections or keys that
 already exist in the original file, they will not override the previous values.
 
-
-file_one.ini::
+Contents of :file:`one.cfg`::
 
     [section1]
-    name2 = "other value"
+    name = value
 
     [section2]
-    foo = baz
-    bas = bar
+    foo = foo from one.cfg
 
-file_two.ini::
+Contents of :file:`two.cfg`::
 
     [DEFAULT]
-    extends = file_one.ini
+    extends = one.cfg
 
     [section2]
-    foo = bar
+    foo = foo from two.cfg
+    baz = baz from two.cfg
 
-Result::
+The result of parsing :file:`two.cfg` is equivalent to this file::
 
     [section1]
-    name2 = "other value"
+    name = value
 
     [section2]
-    foo = bar
-    bas = bar
+    foo = foo from one.cfg
+    baz = baz from two.cfg
 
-To point several files, the multi-line notation can be used::
+Example use of multi-line notation to include more than one file::
 
     [DEFAULT]
-    extends = file_one.ini
-              file_two.ini
+    extends = one.cfg
+              two.cfg
 
 When several files are provided, they are processed sequentially, following the
 precedence rules explained above.  This means that the list of files should go