Skip to content

Commit 48df293

Browse files
committed
Be explicit that 'custom' is an object
Clarify that the custom field of TARGETPATH objects is itself an opaque object with format and contents defined by the application. Fixes: #50 Signed-off-by: Joshua Lock <[email protected]>
1 parent 7d18e2e commit 48df293

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

tuf-spec.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# <p align="center">The Update Framework Specification
22

3-
Last modified: **06 October 2020**
3+
Last modified: **07 October 2020**
44

5-
Version: **1.0.11**
5+
Version: **1.0.12**
66

77
We strive to make the specification easy to implement, so if you come across
88
any inconsistencies or experience any difficulty, do let us know by sending an
@@ -811,7 +811,7 @@ repo](https://github.com/theupdateframework/specification/issues).
811811
{ TARGETPATH : {
812812
"length" : LENGTH,
813813
"hashes" : HASHES,
814-
("custom" : { ... }) }
814+
("custom" : CUSTOM) }
815815
, ...
816816
}
817817

@@ -833,12 +833,13 @@ repo](https://github.com/theupdateframework/specification/issues).
833833
cryptographic hash function. For example: { "sha256": HASH, ... }. HASH is
834834
the hexdigest of the cryptographic function computed on the target file.
835835

836-
If defined, the elements and values of "custom" will be made available to the
837-
client application. The information in "custom" is opaque to the framework
838-
and can include version numbers, dependencies, requirements, and any other
839-
data that the application wants to include to describe the file at
840-
TARGETPATH. The application may use this information to guide download
841-
decisions.
836+
If defined, the elements and values of the CUSTOM object will be made
837+
available to the client application. The format of the CUSTOM object is
838+
opaque to the framework, which only needs to know that the "custom"
839+
attribute maps to an object. The CUSTOM object may include version
840+
numbers, dependencies, requirements, or any other data that the application
841+
wants to include to describe the file at TARGETPATH. The application may
842+
use this information to guide download decisions.
842843

843844
DELEGATIONS is an object whose format is the following:
844845

0 commit comments

Comments
 (0)