Julien Jehannet avatar Julien Jehannet committed b9fb0d0

update setupcfg

Comments (0)

Files changed (3)

+^\.hg
+^\.mq
+syntax: glob
+status
+guards
+setupcfg.diff
+# HG changeset patch
+# Parent edda0a74267ab32e26e3d1cd4cd40ef4e2e31c76
+# User Julien Jehannet <julien@smaf.org>
+# Date 1296314379 -3600
+update setupcfg documentation with some notes and new examples
+
+- replace underscore by dash in fields
+- new section information
+
+Notes:
+- field names are case-insensitive
+- some metadata fields are automatically generated
+
+New examples:
+- setup_hook
+- use-2to3
+
+diff --git a/docs/source/setupcfg.rst b/docs/source/setupcfg.rst
+--- a/docs/source/setupcfg.rst
++++ b/docs/source/setupcfg.rst
+@@ -10,21 +10,32 @@ Each section contains a description of i
+ - Options that are marked *\*multi* can have multiple values, one value
+   per line.
+ - Options that are marked *\*optional* can be omited.
+-- Options that are marked *\*environ* can use environement markes, as described
+-  in PEP 345.
++- Options that are marked *\*environ* can use environment markers, as described
++  in :PEP:`345`.
++
+ 
+ The sections are:
+ 
+-- global
+-- metadata
+-- files
+-- command sections
++global
++    Global options for Distutils2.
++
++metadata
++    The metadata section contains the metadata for the project as described in
++    :PEP:`345`.
++
++files
++    Declaration of package files included in the project.
++
++`command` sections
++    Redefinition of user options for Distutils2 commands.
+ 
+ 
+ global
+ ======
+ 
+-Contains global options for Distutils2. This section is shared with Distutils1.
++Contains global options for Distutils2. This section is shared with Distutils1
++(legacy version distributed in python 2.X standard library).
++
+ 
+ - **commands**: Defined Distutils2 command. A command is defined by its fully
+   qualified name.
+@@ -44,7 +55,7 @@ Contains global options for Distutils2. 
+ 
+     [global]
+     compiler =
+-        package.compilers.CustomCCompiler
++        package.compiler.CustomCCompiler
+ 
+   *\*optional* *\*multi*
+ 
+@@ -52,21 +63,28 @@ Contains global options for Distutils2. 
+   :file:`setup.cfg` file is read. The callable receives the configuration
+   in form of a mapping and can make some changes to it. *\*optional*
+ 
++  Example::
++
++    [global]
++    setup_hook = distutils2.tests.test_config.hook
++
+ 
+ metadata
+ ========
+ 
+ The metadata section contains the metadata for the project as described in
+-PEP 345.
++:PEP:`345`.
+ 
++.. Note::
++    Field names are case-insensitive.
+ 
+ Fields:
+ 
+ - **name**: Name of the project.
+-- **version**: Version of the project. Must comply with PEP 386.
++- **version**: Version of the project. Must comply with :PEP:`386`.
+ - **platform**: Platform specification describing an operating system supported
+   by the distribution which is not listed in the "Operating System" Trove
+-  classifiers. *\*multi* *\*optional*
++  classifiers (:PEP:`301`). *\*multi* *\*optional*
+ - **supported-platform**: Binary distributions containing a PKG-INFO file will
+   use the Supported-Platform field in their metadata to specify the OS and
+   CPU for which the binary distribution was compiled.  The semantics of
+@@ -113,14 +131,18 @@ Example::
+     name = pypi2rpm
+     version = 0.1
+     author = Tarek Ziade
+-    author_email = tarek@ziade.org
++    author-email = tarek@ziade.org
+     summary = Script that transforms a sdist archive into a rpm archive
+     description-file = README
+-    home_page = http://bitbucket.org/tarek/pypi2rpm
++    home-page = http://bitbucket.org/tarek/pypi2rpm
++    project-url: RSS feed, https://bitbucket.org/tarek/pypi2rpm/rss
+ 
+     classifier = Development Status :: 3 - Alpha
+         License :: OSI Approved :: Mozilla Public License 1.1 (MPL 1.1)
+ 
++.. Note::
++    Some metadata fields seen in :PEP:`345` are automatically generated
++    as the Metadata-Version value for instance.
+ 
+ 
+ files
+@@ -147,15 +169,20 @@ Example::
+             setup.py
+ 
+ 
+-command sections
+-================
++`command` sections
++==================
+ 
+-Each command can have its options described in :file:`setup.cfg`
+-
++Each Distutils2 command can have its own user options defined in :file:`setup.cfg`
+ 
+ Example::
+ 
+     [sdist]
+-    manifest_makers = package.module.Maker
++    manifest-builders = package.module.Maker
+ 
+ 
++To override the building class in order to compile your python2 files to python3::
++
++    [build_py]
++    use-2to3 = True
++
++
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.