Skip to content

Commit 94648bd

Browse files
authored
Merge pull request #1277 from sethmlarson/build-number-interop
2 parents c022989 + 67ea0ff commit 94648bd

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

source/specifications/binary-distribution-format.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,23 @@ 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+
A common use-case for build numbers is rebuilding a binary
138+
distribution due to a change in the build environment,
139+
like when using the manylinux image to build
140+
distributions using pre-release CPython versions.
141+
142+
.. warning::
143+
144+
Build numbers are not a part of the distribution version and thus are difficult
145+
to reference externally, especially so outside the Python ecosystem of tools and standards.
146+
A common case where a distribution would need to referenced externally is when
147+
resolving a security vulnerability.
148+
149+
Due to this limitation, new distributions which need to be referenced externally
150+
**should not** use build numbers when building the new distribution.
151+
Instead a **new distribution version** should be created for such cases.
152+
153+
137154
language implementation and version tag
138155
E.g. 'py27', 'py2', 'py3'.
139156

0 commit comments

Comments
 (0)