From b68e9bc1e54de0aafe573994902de977fc7efc48 Mon Sep 17 00:00:00 2001 From: James Braza Date: Mon, 20 Nov 2023 13:39:50 -0800 Subject: [PATCH] Clarified docs on SETUPTOOLS_SCM_PRETEND_VERSION_FOR_{NORMALIZED_DIST_NAME} --- docs/config.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/config.md b/docs/config.md index 0acdf6fe..1fcb2612 100644 --- a/docs/config.md +++ b/docs/config.md @@ -108,17 +108,22 @@ Callables or other Python objects have to be passed in `setup.py` (via the `use_ : used as the primary source for the version number in which case it will be an unparsed string - !!! warning "it is strongly recommended to use use distribution name specific pretend versions" + !!! warning "" + it is strongly recommended to use distribution-specific pretend versions + (see below). `SETUPTOOLS_SCM_PRETEND_VERSION_FOR_${NORMALIZED_DIST_NAME}` -: used as the primary source for the version number - in which case it will be an unparsed string +: used as the primary source for the version number, + in which case it will be an unparsed string. + Specifying distribution-specific pretend versions will + avoid possible collisions with third party distributions + also using ``setuptools_scm`` the dist name normalization follows adapted PEP 503 semantics, with one or more of ".-_" being replaced by a single "_", and the name being upper-cased - it takes precedence over ``SETUPTOOLS_SCM_PRETEND_VERSION`` + this will take precedence over ``SETUPTOOLS_SCM_PRETEND_VERSION`` `SETUPTOOLS_SCM_DEBUG` : enable the debug logging