summaryrefslogtreecommitdiff
path: root/docs/userguide/datafiles.rst
diff options
context:
space:
mode:
authorMarco Weber <marco.weber@hotmail.de>2022-06-09 00:51:44 +0200
committerMarco Weber <marco.weber@hotmail.de>2022-06-09 00:51:44 +0200
commitec130dadb2f246e4b5e65669bd30221cfb4b3362 (patch)
tree967db37e0a2c7111af8b30a7c1942bd935e47807 /docs/userguide/datafiles.rst
parent6fb421140914bf4eac1e46f6da641370a909d1bf (diff)
downloadpython-setuptools-git-ec130dadb2f246e4b5e65669bd30221cfb4b3362.tar.gz
Clarify glob pattern matching for dotfiles in User's Guide (#3350)
Diffstat (limited to 'docs/userguide/datafiles.rst')
-rw-r--r--docs/userguide/datafiles.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/userguide/datafiles.rst b/docs/userguide/datafiles.rst
index e706617c..3a2ffbdf 100644
--- a/docs/userguide/datafiles.rst
+++ b/docs/userguide/datafiles.rst
@@ -157,6 +157,11 @@ require to be added by a revision control system plugin.
the path separator, even if you are on Windows. Setuptools automatically
converts slashes to appropriate platform-specific separators at build time.
+.. note::
+ Glob patterns do not automatically match dotfiles (directory or file names
+ starting with a dot (``.``)). To include such files, you must explicitly start
+ the pattern with a dot, e.g. ``.*`` to match ``.gitignore``.
+
If you have multiple top-level packages and a common pattern of data files for all these
packages, for example::