From cbf1e45572daa101038ccb5d6b6dc6a20f10b0ea Mon Sep 17 00:00:00 2001 From: Jussi Kukkonen Date: Mon, 3 Jan 2022 11:55:23 +0200 Subject: [PATCH] docs: Make it clear what is hashed TUF uses file name hashes elsewhere so make it clear when hashes are for file _contents_. Fixes #1737. Signed-off-by: Jussi Kukkonen --- tuf/api/metadata.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/tuf/api/metadata.py b/tuf/api/metadata.py index f4bff953..cc2a43e2 100644 --- a/tuf/api/metadata.py +++ b/tuf/api/metadata.py @@ -891,7 +891,8 @@ class MetaFile(BaseFile): Args: version: Version of the metadata file. length: Length of the metadata file. - hashes: Dictionary of hash algorithm names to hash values. + hashes: Dictionary of hash algorithm names to hashes of the metadata + file content. unrecognized_fields: Dictionary of all unrecognized fields. """ @@ -1264,7 +1265,8 @@ class TargetFile(BaseFile): Args: length: Length in bytes. - hashes: A dictionary of hash algorithm names to hash values. + hashes: A dictionary of hash algorithm names to hashes of the target + file content. path: URL path to a target file, relative to a base targets URL. unrecognized_fields: Dictionary of all unrecognized fields. """