Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-30 21:21:22 +00:00
Code Issues Projects Releases Packages Wiki Activity

bpo-25592: Improve documentation of distutils data_files (GH-9767)

Browse source
This commit is contained in:
jdemeyer 2019-01-30 16:49:39 +01:00 • committed by Antoine Pitrou
parent cfd735ea28
commit 598e15d4fe
1 changed files with 14 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

25
Doc/distutils/setupscript.rst
View file

@ -524,20 +524,23 @@ following way::
setup(..., setup(...,
data_files=[('bitmaps', ['bm/b1.gif', 'bm/b2.gif']), data_files=[('bitmaps', ['bm/b1.gif', 'bm/b2.gif']),
('config', ['cfg/data.cfg']), ('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 Each (*directory*, *files*) pair in the sequence specifies the installation
directory and the files to install there. If *directory* is a relative path, it directory and the files to install there.
is interpreted relative to the installation prefix (Python's ``sys.prefix`` for
pure-Python packages, ``sys.exec_prefix`` for packages that contain extension Each file name in *files* is interpreted relative to the :file:`setup.py`
modules). Each file name in *files* is interpreted relative to the script at the top of the package source distribution. Note that you can
:file:`setup.py` script at the top of the package source distribution. No specify the directory where the data files will be installed, but you cannot
directory information from *files* is used to determine the final location of rename the data files themselves.
the installed file; only the name of the file is used.
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 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 without specifying a target directory, but this is not recommended, and the