summaryrefslogtreecommitdiff
path: root/docs/userguide
diff options
context:
space:
mode:
authorAnderson Bravalheri <andersonbravalheri@gmail.com>2022-06-13 09:20:52 +0100
committerAnderson Bravalheri <andersonbravalheri@gmail.com>2022-06-13 09:23:48 +0100
commit2e368572607c89759e35deb06dc2a07f37d3d2bf (patch)
tree6264a60fd4b12eb0e36f1942c65d0eadabd3a0aa /docs/userguide
parent3fa54e48a5141d5b21e4530f841992dc79703c4e (diff)
downloadpython-setuptools-git-2e368572607c89759e35deb06dc2a07f37d3d2bf.tar.gz
Add note about availability of entry-points
Diffstat (limited to 'docs/userguide')
-rw-r--r--docs/userguide/extension.rst12
1 files changed, 11 insertions, 1 deletions
diff --git a/docs/userguide/extension.rst b/docs/userguide/extension.rst
index 493075b4..f1dce94b 100644
--- a/docs/userguide/extension.rst
+++ b/docs/userguide/extension.rst
@@ -15,11 +15,21 @@ A simple way of doing that is to hook in new or existing
commands and ``setup()`` arguments just by defining "entry points". These
are mappings from command or argument names to a specification of where to
import a handler from. (See the section on :ref:`Dynamic Discovery of
-Services and Plugins` for some more background on entry points.)
+Services and Plugins` for some more background on entry points).
The following sections describe the most common procedures for extending
the ``distutils`` functionality used by ``setuptools``.
+.. important::
+ Any entry-point defined in your ``setup.cfg``, ``setup.py`` or
+ ``pyproject.toml`` files are not immediately available for use. Your
+ package needs to be installed first, then ``setuptools`` will be able to
+ access these entry points. For example consider a ``Project-A`` that
+ defines entry points. When building ``Project-A``, these will not be
+ available. If ``Project-B`` declares a :doc:`build system requirement
+ </userguide/dependency_management>` on ``Project-A``, then ``setuptools``
+ will be able to use ``Project-A``' customizations.
+
Customizing Commands
--------------------