From 499a91dbb0e0448947660e6936949ec229e68890 Mon Sep 17 00:00:00 2001 From: Dustin Ingram Date: Tue, 14 Jan 2025 15:25:29 +0000 Subject: [PATCH 1/6] Update Dynamic specification to include deprecated fields --- source/specifications/core-metadata.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/specifications/core-metadata.rst b/source/specifications/core-metadata.rst index c1ce528e7..316736ff0 100644 --- a/source/specifications/core-metadata.rst +++ b/source/specifications/core-metadata.rst @@ -110,7 +110,7 @@ Dynamic (multiple use) A string containing the name of another core metadata field. The field names ``Name``, ``Version``, and ``Metadata-Version`` may not be specified -in this field. +in this field. Deprecated fields MAY be specified in this field. When found in the metadata of a source distribution, the following rules apply: From 8c9fb25dd07c41e0edb14e1fac40a3d1d5d56a57 Mon Sep 17 00:00:00 2001 From: Dustin Ingram Date: Tue, 14 Jan 2025 17:28:16 +0000 Subject: [PATCH 2/6] Revert "Update Dynamic specification to include deprecated fields" This reverts commit 499a91dbb0e0448947660e6936949ec229e68890. --- source/specifications/core-metadata.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/specifications/core-metadata.rst b/source/specifications/core-metadata.rst index 316736ff0..c1ce528e7 100644 --- a/source/specifications/core-metadata.rst +++ b/source/specifications/core-metadata.rst @@ -110,7 +110,7 @@ Dynamic (multiple use) A string containing the name of another core metadata field. The field names ``Name``, ``Version``, and ``Metadata-Version`` may not be specified -in this field. Deprecated fields MAY be specified in this field. +in this field. When found in the metadata of a source distribution, the following rules apply: From 8dfac8d1f0a811987f84966ce737a8f253de7da0 Mon Sep 17 00:00:00 2001 From: Dustin Ingram Date: Tue, 14 Jan 2025 17:29:14 +0000 Subject: [PATCH 3/6] Add a definition of 'deprecated' instead --- source/specifications/core-metadata.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/source/specifications/core-metadata.rst b/source/specifications/core-metadata.rst index c1ce528e7..422d30cd4 100644 --- a/source/specifications/core-metadata.rst +++ b/source/specifications/core-metadata.rst @@ -800,6 +800,10 @@ Deprecated Fields .. _home-page-optional: .. _core-metadata-home-page: +Deprecated fields are valid metadata fields for any metadata version. Tools +MUST attempt to convert deprecated fields to non-deprecated fields when +appropriate. Tools SHOULD warn users when deprecated fields are used. + Home-page --------- From f2904b3d752daba59b834c7005e3631285135ef9 Mon Sep 17 00:00:00 2001 From: Dustin Ingram Date: Tue, 14 Jan 2025 17:43:27 +0000 Subject: [PATCH 4/6] Don't require conversion --- source/specifications/core-metadata.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/source/specifications/core-metadata.rst b/source/specifications/core-metadata.rst index 422d30cd4..832c25bb4 100644 --- a/source/specifications/core-metadata.rst +++ b/source/specifications/core-metadata.rst @@ -801,8 +801,7 @@ Deprecated Fields .. _core-metadata-home-page: Deprecated fields are valid metadata fields for any metadata version. Tools -MUST attempt to convert deprecated fields to non-deprecated fields when -appropriate. Tools SHOULD warn users when deprecated fields are used. +SHOULD warn users when deprecated fields are used. Home-page --------- From 017f3d6995546d1dfd1c384e78d47c9d18170f45 Mon Sep 17 00:00:00 2001 From: Dustin Ingram Date: Tue, 14 Jan 2025 17:44:03 +0000 Subject: [PATCH 5/6] Move text before link targets --- source/specifications/core-metadata.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/specifications/core-metadata.rst b/source/specifications/core-metadata.rst index 832c25bb4..f410eca09 100644 --- a/source/specifications/core-metadata.rst +++ b/source/specifications/core-metadata.rst @@ -797,12 +797,12 @@ Examples:: Deprecated Fields ================= -.. _home-page-optional: -.. _core-metadata-home-page: - Deprecated fields are valid metadata fields for any metadata version. Tools SHOULD warn users when deprecated fields are used. +.. _home-page-optional: +.. _core-metadata-home-page: + Home-page --------- From 55f3ddeae1e91be40bf1ae4f50271b0e020cf840 Mon Sep 17 00:00:00 2001 From: Dustin Ingram Date: Tue, 14 Jan 2025 20:15:00 +0000 Subject: [PATCH 6/6] Commit suggestion --- source/specifications/core-metadata.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/source/specifications/core-metadata.rst b/source/specifications/core-metadata.rst index f410eca09..2129be541 100644 --- a/source/specifications/core-metadata.rst +++ b/source/specifications/core-metadata.rst @@ -797,8 +797,10 @@ Examples:: Deprecated Fields ================= -Deprecated fields are valid metadata fields for any metadata version. Tools -SHOULD warn users when deprecated fields are used. +Deprecated fields should be avoided, but they are valid metadata fields. They +may be removed in future versions of the core metadata standard (at which point +they will only be valid in files that specify a metadata version prior to the +removal). Tools SHOULD warn users when deprecated fields are used. .. _home-page-optional: .. _core-metadata-home-page: