Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify that CONSISTENT_SNAPSHOT is optional #162

Closed
wants to merge 1 commit into from
Closed

Clarify that CONSISTENT_SNAPSHOT is optional #162

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions tuf-spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Title: The Update Framework Specification
Shortname: TUF
Status: LS
Abstract: A framework for securing software update systems.
Date: 2020-12-11
Date: 2021-05-17
Editor: Justin Cappos, NYU
Editor: Trishank Karthik Kuppusamy, Datadog
Editor: Joshua Lock, VMware
Expand All @@ -16,7 +16,7 @@ Boilerplate: copyright no, conformance no
Local Boilerplate: header yes
Markup Shorthands: css no, markdown yes
Metadata Include: This version off, Abstract off
Text Macro: VERSION 1.0.17
Text Macro: VERSION 1.0.18
</pre>

Note: We strive to make the specification easy to implement, so if you come
Expand Down Expand Up @@ -688,9 +688,11 @@ The "signed" portion of <a>root.json</a> is as follows:

: <dfn>CONSISTENT_SNAPSHOT</dfn>
::
A boolean indicating whether the repository supports
consistent snapshots. Section 7 goes into more detail on the consequences
of enabling this setting on a repository.
An optional boolean indicating whether the repository supports
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
An optional boolean indicating whether the repository supports
An OPTIONAL boolean indicating whether the repository supports

consistent snapshots. This field is optional for backward compatibility with
old metadata that may exist without it. New implementations SHOULD include
Comment on lines +692 to +693
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
consistent snapshots. This field is optional for backward compatibility with
old metadata that may exist without it. New implementations SHOULD include
consistent snapshots. This field is OPTIONAL for backward compatibility with
old metadata. New implementations SHOULD include

it. Section 7 goes into more detail on the consequences of enabling
this setting on a repository.
Comment on lines +694 to +695
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's both ensure we are cross-linking and avoid referring to sections by their explicit numbering

Suggested change
it. Section 7 goes into more detail on the consequences of enabling
this setting on a repository.
it. [[consistent-snapshots]] goes into more detail on the consequences of enabling
this setting on a repository.


: <dfn for="role">VERSION</dfn>
::
Expand Down