mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-27 18:59:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

Fix incorrect nesting of sections in setup.cfg specification

Browse source
This commit is contained in:
Éric Araujo 2011-06-09 08:15:47 +02:00
parent 0a975f957d
commit a462a80722
1 changed files with 18 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

36
Doc/packaging/setupcfg.rst
View file

@ -147,7 +147,7 @@ command sections
Global options Global options
============== --------------
Contains global options for Packaging. This section is shared with Distutils. Contains global options for Packaging. This section is shared with Distutils.
@ -185,7 +185,7 @@ setup_hook
Metadata Metadata
======== --------
The metadata section contains the metadata for the project as described in The metadata section contains the metadata for the project as described in
:PEP:`345`. Field names are case-insensitive. :PEP:`345`. Field names are case-insensitive.
@ -308,7 +308,7 @@ from the fields present in the file.
Files Files
===== -----
This section describes the files included in the project. This section describes the files included in the project.
@ -352,7 +352,7 @@ Example::
Resources Resources
--------- ^^^^^^^^^
This section describes the files used by the project which must not be installed This section describes the files used by the project which must not be installed
in the same place that python modules or libraries, they are called in the same place that python modules or libraries, they are called
@ -448,10 +448,10 @@ Where {datafir} category will be platform-dependent.
More control on source part More control on source part
^^^^^^^^^^^^^^^^^^^^^^^^^^^ """""""""""""""""""""""""""
Glob syntax Glob syntax
""""""""""" '''''''''''
When you declare source file, you can use a glob-like syntax to match multiples file, for example:: When you declare source file, you can use a glob-like syntax to match multiples file, for example::
@ -469,7 +469,7 @@ Glob tokens are:
.. TODO Add examples .. TODO Add examples
Order of declaration Order of declaration
"""""""""""""""""""" ''''''''''''''''''''
The order of declaration is important if one file match multiple rules. The last The order of declaration is important if one file match multiple rules. The last
rules matched by file is used, this is useful if you have this source tree:: rules matched by file is used, this is useful if you have this source tree::
@ -492,7 +492,7 @@ one by one, you can declare them in this way::
doc/README = {help} doc/README = {help}
Exclude Exclude
""""""" '''''''
You can exclude some files of resources declaration by giving no destination, it You can exclude some files of resources declaration by giving no destination, it
can be useful if you have a non-resources file in the same directory of can be useful if you have a non-resources file in the same directory of
@ -513,12 +513,12 @@ Your **files** section will be::
doc/RELEASES = doc/RELEASES =
More control on destination part More control on destination part
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ """"""""""""""""""""""""""""""""
.. _setupcfg-resources-base-prefix: .. _setupcfg-resources-base-prefix:
Defining a base prefix Defining a base prefix
"""""""""""""""""""""" ''''''''''''''''''''''
When you define your resources, you can have more control of how the final path When you define your resources, you can have more control of how the final path
is computed. is computed.
@ -577,7 +577,7 @@ path will be::
Overwriting paths for categories Overwriting paths for categories
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ """"""""""""""""""""""""""""""""
This part is intended for system administrators or downstream OS packagers. This part is intended for system administrators or downstream OS packagers.
@ -614,18 +614,18 @@ The platform-dependent categories are:
Defining extra categories Defining extra categories
^^^^^^^^^^^^^^^^^^^^^^^^^ """""""""""""""""""""""""
.. TODO .. TODO
Examples Examples
^^^^^^^^ """"""""
These examples are incremental but work unitarily. These examples are incremental but work unitarily.
Resources in root dir Resources in root dir
""""""""""""""""""""" '''''''''''''''''''''
Source tree:: Source tree::
@ -647,7 +647,7 @@ So babar.sh and launch.sh will be placed in {scripts} directory.
Now let's move all the scripts into a scripts directory. Now let's move all the scripts into a scripts directory.
Resources in sub-directory Resources in sub-directory
"""""""""""""""""""""""""" ''''''''''''''''''''''''''
Source tree:: Source tree::
@ -673,7 +673,7 @@ scripts into {scripts} instead of {scripts}/scripts.
Now let's add some docs. Now let's add some docs.
Resources in multiple sub-directories Resources in multiple sub-directories
""""""""""""""""""""""""""""""""""""" '''''''''''''''''''''''''''''''''''''
Source tree:: Source tree::
@ -706,7 +706,7 @@ file is used.
Now let's add some scripts for windows users. Now let's add some scripts for windows users.
Complete example Complete example
"""""""""""""""" ''''''''''''''''
Source tree:: Source tree::
@ -737,7 +737,7 @@ We use brace expansion syntax to place all the shell and batch scripts into
Command sections Command sections
================ ----------------
To pass options to commands without having to type them on the command line To pass options to commands without having to type them on the command line
for each invocation, you can write them in the :file:`setup.cfg` file, in a for each invocation, you can write them in the :file:`setup.cfg` file, in a