Skip to content

Commit 036656a

Browse files
committed
Add warning about reference interop for build numbers
1 parent 03b212a commit 036656a

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

source/specifications/binary-distribution-format.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,18 @@ build tag
134134
the first item being the initial digits as an ``int``, and the
135135
second item being the remainder of the tag as a ``str``.
136136

137+
.. warning::
138+
139+
Build numbers are not a part of the distribution version and thus are difficult
140+
to reference externally, especially so outside the Python ecosystem of tools and standards.
141+
A common case where a distribution would need to referenced externally is when
142+
resolving a security vulnerability.
143+
144+
Due to this limitation new distributions which need to be referenced externally
145+
**should not** use build numbers when building the new distribution.
146+
Instead a **new distribution version** should be created for such cases.
147+
148+
137149
language implementation and version tag
138150
E.g. 'py27', 'py2', 'py3'.
139151

0 commit comments

Comments
 (0)