summaryrefslogtreecommitdiffstats
path: root/Utilities
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2021-04-01 15:12:00 (GMT)
committerBrad King <brad.king@kitware.com>2021-04-05 17:47:20 (GMT)
commite17006c497acc3c8d37a9cd854c6ef451db7df9e (patch)
tree0ab22d4109d56eaea1c8fd0b0950c45b0fc4aebe /Utilities
parent89ab6132480df326fed311449245433ea0836b7a (diff)
downloadCMake-e17006c497acc3c8d37a9cd854c6ef451db7df9e.zip
CMake-e17006c497acc3c8d37a9cd854c6ef451db7df9e.tar.gz
CMake-e17006c497acc3c8d37a9cd854c6ef451db7df9e.tar.bz2
Utilities/Release: Add deprecation fields to File Table v1
Provide a field for clients to check now so that we can deprecate things later.
Diffstat (limited to 'Utilities')
-rw-r--r--Utilities/Release/files-v1.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/Utilities/Release/files-v1.rst b/Utilities/Release/files-v1.rst
index 9586668..ceebecc 100644
--- a/Utilities/Release/files-v1.rst
+++ b/Utilities/Release/files-v1.rst
@@ -102,6 +102,13 @@ The members are:
The value is a JSON string specifying the minimum version of macOS
required to run the binary, e.g. ``"10.13"``.
+ ``deprecated``
+ Optional member that is present when the package file is deprecated
+ and may be removed from the set of package files in later versions.
+ The value is a string containing a deprecation message.
+ Clients should check this field to warn users when they are using
+ a deprecated package file.
+
``hashFiles``
A JSON array of entries corresponding to files containing cryptographic
hashes of the package file contents. Each entry is a JSON object
@@ -120,6 +127,19 @@ The members are:
signature of the hash file specified by ``name``, e.g.
``["cmake-<version>-SHA-256.txt.asc"]``.
+ ``deprecated``
+ Optional member that is present when the hash algorithm is deprecated
+ and may be removed from the set of hash files in later versions.
+ The value is a string containing a deprecation message.
+ Clients that rely on a specific hash algorithm should check this
+ field to determine whether an update is needed.
+
+``deprecated``
+ Optional member that is present when `File Table v1`_ has been
+ deprecated in favor of a newer alternative. The value is a string
+ containing a deprecation message. Clients should check this field
+ to determine whether they need an update to use a newer alternative.
+
The table and hash files are generated by `files.bash`_ from
the `files-v1.json.in`_ template and the package files themselves.