Clarify that CONSISTENT_SNAPSHOT is optional #162
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jku
reviewed
May 18, 2021
There was a problem hiding this comment.
Other descriptions of optional fields use the word "OPTIONAL" in capitals, maybe you want to do that too. Also, it seems the metadata examples use ( ) to signify optional parts so maybe we should have ("consistent_snapshot": <a>CONSISTENT_SNAPSHOT</a>,) in there as well.
There's an extra d in "include"
tuf-spec.md
Outdated
| of enabling this setting on a repository. | ||
| 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 included |
There was a problem hiding this comment.
Where do we discuss what we should do if it doesn't exist?
There was a problem hiding this comment.
The spec leaves this open. From chapter 7.1:
Finally, the root metadata should write the Boolean "consistent_snapshot"
attribute at the root level of its keys of attributes.
If consistent snapshots are not written by the repository,
then the attribute may either be left unspecified or be set to the False value.
Otherwise, it must be set to the True value.
From chapter 7 in the spec (version 1.0.17): "Finally, the root metadata should write the Boolean "consistent_snapshot" attribute at the root level of its keys of attributes. If consistent snapshots are not written by the repository, then the attribute may either be left unspecified or be set to the False value. Otherwise, it must be set to the True value." The above implies that there could be repositories with root metadata without CONSISTENT_SNAPSHOT. Clarify that, but phrase it to make it clear this should be included in new implementations. Signed-off-by: Martin Vrachev <[email protected]>
MVrachev
force-pushed
the
consistent-snapshot-optional
branch
from
7c0e7e9 to
c9c3437
Compare
joshuagl
requested changes
May 26, 2021
| 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 |
There was a problem hiding this comment.
Suggested change
| An optional boolean indicating whether the repository supports | |
| An OPTIONAL boolean indicating whether the repository supports |
Comment on lines
+692
to
+693
| consistent snapshots. This field is optional for backward compatibility with | ||
| old metadata that may exist without it. New implementations SHOULD include |
There was a problem hiding this comment.
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 |
Comment on lines
+694
to
+695
| it. Section 7 goes into more detail on the consequences of enabling | ||
| this setting on a repository. |
There was a problem hiding this comment.
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. |
|
Superseded by #165. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
From chapter 7 in the spec (version 1.0.17):
"Finally, the root metadata should write the Boolean
"consistent_snapshot" attribute at the root level of its keys of
attributes.
If consistent snapshots are not written by the repository,
then the attribute may either be left unspecified or be set to the
False value. Otherwise, it must be set to the True value."
The above implies that there could be repositories with root metadata
without CONSISTENT_SNAPSHOT.
Clarify that, but phrase it to make it clear this should be included
in new implementations.
Signed-off-by: Martin Vrachev [email protected]