Skip to content

Commit 1b2b35e

Browse files
authored
Merge branch 'main' into pep-721
2 parents 1416a46 + f858ac8 commit 1b2b35e

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-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

source/specifications/core-metadata.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ to a new format.
4040
.. contents:: Contents
4141
:local:
4242

43+
.. _core-metadata-metadata-version:
44+
4345
Metadata-Version
4446
================
4547

@@ -133,6 +135,7 @@ project.
133135

134136
Full details of the semantics of ``Dynamic`` are described in :pep:`643`.
135137

138+
.. _core-metadata-platform:
136139

137140
Platform (multiple use)
138141
=======================
@@ -148,6 +151,7 @@ Examples::
148151
Platform: ObscureUnix
149152
Platform: RareDOS
150153

154+
.. _core-metadata-supported-platform:
151155

152156
Supported-Platform (multiple use)
153157
=================================
@@ -340,6 +344,7 @@ Example::
340344
easier to update the specification to match the de facto standard.
341345

342346
.. _home-page-optional:
347+
.. _core-metadata-home-page:
343348

344349
Home-page
345350
=========
@@ -352,6 +357,7 @@ Example::
352357

353358
Home-page: http://www.example.com/~cschultz/bvote/
354359

360+
.. _core-metadata-download-url:
355361

356362
Download-URL
357363
============
@@ -558,6 +564,7 @@ Examples::
558564
Requires-Python: >2.6,!=3.0.*,!=3.1.*
559565
Requires-Python: ~=2.6
560566

567+
.. _core-metadata-requires-external:
561568

562569
Requires-External (multiple use)
563570
================================
@@ -682,6 +689,7 @@ as they're still potentially useful for informational purposes, and can
682689
also be used for their originally intended purpose in combination with
683690
a curated package repository.
684691

692+
.. _core-metadata-provides-dist:
685693

686694
Provides-Dist (multiple use)
687695
----------------------------
@@ -723,6 +731,7 @@ Examples::
723731
Provides-Dist: AnotherProject (3.4)
724732
Provides-Dist: virtual_package; python_version >= "3.4"
725733

734+
.. _core-metadata-obsoletes-dist:
726735

727736
Obsoletes-Dist (multiple use)
728737
-----------------------------

0 commit comments

Comments
 (0)