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.

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

Clarify "paths" and "path_hash_prefixes" #158

Conversation

MVrachev
Copy link
Contributor

@MVrachev MVrachev commented Apr 21, 2021

Note!
The Text Macro: VERSION is bumped by two with the idea of merging #157 before this pr.

Fixes: #156

Clarify "paths" and "path_hash_prefixes" in delegations, because
currently, it's not properly defined which of these options can be used
to create a valid target file:

  • BOTH paths and path_hash_prefixes
  • ONLY ONE of paths and path_hash_prefixes
  • NONE of paths and path_hash_prefixes

With this change, I aim to define clearly that a valid target file will
contain ONLY ONE of them or NONE of them.

Signed-off-by: Martin Vrachev mvrachev@vmware.com

Clarify "paths" and "path_hash_prefixes" in delegations, because
currently, it's not properly defined which of these options can be used
to create a valid target file:
- BOTH paths and path_hash_prefixes
- ONLY ONE of paths and path_hash_prefixes
- NONE of paths and path_hash_prefixes

With this change, I aim to define clearly that a valid target file will
contain ONLY ONE of them or NONE of them.

Signed-off-by: Martin Vrachev <mvrachev@vmware.com>
<a>"path_hash_prefixes"</a> or <a for="delegation-role">"paths"</a> attributes, each of which we
discuss next.
The <a>"path_hash_prefixes"</a> and <a for="delegation-role">"paths"</a>
attributes are optional, if used, exactly one of them should be set.
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
attributes are optional, if used, exactly one of them should be set.
attributes are OPTIONAL, if used, exactly one of them should be set.

We use RFC 2119 keywords in the spec.

@MVrachev
Copy link
Contributor Author

Superseded by #165.

@MVrachev MVrachev closed this May 31, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarify "paths" and "path_hash_prefixes" in delegations
2 participants