Utilities/Release: Add deprecation fields to File Table v1

Provide a field for clients to check now so that we can deprecate
things later.

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.