summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'guide/_sources/distutils.rst.txt')
-rw-r--r--guide/_sources/distutils.rst.txt18
1 files changed, 15 insertions, 3 deletions
diff --git a/guide/_sources/distutils.rst.txt b/guide/_sources/distutils.rst.txt
index e415192..39932d8 100644
--- a/guide/_sources/distutils.rst.txt
+++ b/guide/_sources/distutils.rst.txt
@@ -117,7 +117,8 @@ files. This has some implications, notably:
1. If the package uses setuptools_scm or a similar package, the version
string needs to be provided explicitly,
- cf. `setuptools_scm (flit_scm, hatch-vcs) and snapshots`_.
+ cf. `setuptools_scm (flit_scm, hatch-vcs, pdm-backend)
+ and snapshots`_.
2. If the package uses Cython, the C files need to be generated
and an explicit ``BDEPEND`` on ``dev-python/cython`` needs to
@@ -261,6 +262,7 @@ meson-python dev-python/meson-python mesonpy
no (none) (none, see below)
pbr dev-python/pbr pbr
pdm dev-python/pdm-pep517 pdm.pep517.api
+pdm-backend dev-python/pdm-backend pdm.backend
poetry dev-python/poetry-core poetry.core.masonry.api
setuptools dev-python/setuptools setuptools.build_meta
setuptools.__legacy__.build_meta
@@ -283,12 +285,13 @@ for them.
.. index:: SETUPTOOLS_SCM_PRETEND_VERSION
+.. index:: PDM_BUILD_SCM_VERSION
.. index:: flit_scm
.. index:: hatch-vcs
.. index:: setuptools_scm
-setuptools_scm (flit_scm, hatch-vcs) and snapshots
-==================================================
+setuptools_scm (flit_scm, hatch-vcs, pdm-backend) and snapshots
+===============================================================
setuptools_scm_ is a package providing additional features for running
inside a VCS checkout, in particular the ability to determine version
from VCS tags. However, this works correctly only when the package
@@ -336,9 +339,18 @@ of setuptools_scm. The same approach applies to both of them.
data files. Please take special care to verify that all files are
installed.
+The pdm-backend_ package reinvents its own SCM version support,
+and unlike setuptools_scm, it uses ``0.0.0`` rather than throwing
+an error when the version cannot be determined. The override for this
+backend can be set using a similarly purposed environment variable::
+
+ export PDM_BUILD_SCM_VERSION=${PV}
+
+
.. _setuptools_scm: https://pypi.org/project/setuptools-scm/
.. _flit_scm: https://pypi.org/project/flit_scm/
.. _hatch-vcs: https://pypi.org/project/hatch-vcs/
+.. _pdm-backend: https://pypi.org/project/pdm-backend/
.. index:: DISTUTILS_EXT