summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorjdemeyer <J.Demeyer@UGent.be>2019-01-30 15:49:39 (GMT)
committerAntoine Pitrou <pitrou@free.fr>2019-01-30 15:49:39 (GMT)
commit598e15d4feaee3849a91d92c9ca51f17baafe19c (patch)
treef706f142f09bc7ec03b73d381fc17cbe4646a1c4 /Doc
parentcfd735ea28a2b985598236f955c72c3f0e82e01d (diff)
downloadcpython-598e15d4feaee3849a91d92c9ca51f17baafe19c.zip
cpython-598e15d4feaee3849a91d92c9ca51f17baafe19c.tar.gz
cpython-598e15d4feaee3849a91d92c9ca51f17baafe19c.tar.bz2
bpo-25592: Improve documentation of distutils data_files (GH-9767)
Diffstat (limited to 'Doc')
-rw-r--r--Doc/distutils/setupscript.rst25
1 files changed, 14 insertions, 11 deletions
diff --git a/Doc/distutils/setupscript.rst b/Doc/distutils/setupscript.rst
index c1051d2..54ed1ae 100644
--- a/Doc/distutils/setupscript.rst
+++ b/Doc/distutils/setupscript.rst
@@ -524,20 +524,23 @@ following way::
setup(...,
data_files=[('bitmaps', ['bm/b1.gif', 'bm/b2.gif']),
('config', ['cfg/data.cfg']),
- ('/etc/init.d', ['init-script'])]
)
-Note that you can specify the directory names where the data files will be
-installed, but you cannot rename the data files themselves.
-
Each (*directory*, *files*) pair in the sequence specifies the installation
-directory and the files to install there. If *directory* is a relative path, it
-is interpreted relative to the installation prefix (Python's ``sys.prefix`` for
-pure-Python packages, ``sys.exec_prefix`` for packages that contain extension
-modules). Each file name in *files* is interpreted relative to the
-:file:`setup.py` script at the top of the package source distribution. No
-directory information from *files* is used to determine the final location of
-the installed file; only the name of the file is used.
+directory and the files to install there.
+
+Each file name in *files* is interpreted relative to the :file:`setup.py`
+script at the top of the package source distribution. Note that you can
+specify the directory where the data files will be installed, but you cannot
+rename the data files themselves.
+
+The *directory* should be a relative path. It is interpreted relative to the
+installation prefix (Python's ``sys.prefix`` for system installations;
+``site.USER_BASE`` for user installations). Distutils allows *directory* to be
+an absolute installation path, but this is discouraged since it is
+incompatible with the wheel packaging format. No directory information from
+*files* is used to determine the final location of the installed file; only
+the name of the file is used.
You can specify the ``data_files`` options as a simple sequence of files
without specifying a target directory, but this is not recommended, and the