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

Snippets support in Annex H, but with more structure #719

Merged
merged 5 commits into from
Jun 22, 2022

Conversation

silverhook
Copy link
Contributor

The main difference to #718 is in structure:

  • “H.2 Format” gets renamed to “H.2 File tag format”, but content stays the same as in existing spec.
  • all snippet-level specifics are now in new “H.3 Snippet tag format”
  • consequently, current H.3 gets bumped to “H.4 Caveats”
  • title of the annex is renamed to “Annex H SPDX File and Snippet Tags (Informative)” to reflect the changes

Copy link
Member

@zvr zvr left a comment

Choose a reason for hiding this comment

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

Much better than #718; thanks @silverhook

chapters/file-tags.md Outdated Show resolved Hide resolved
@silverhook silverhook requested a review from zvr June 16, 2022 10:44
@zvr
Copy link
Member

zvr commented Jun 16, 2022

The text looks good to me, but @silverhook you missed the DCO in all 4 commits.

@silverhook
Copy link
Contributor Author

Hmm, will try to rebase and rectify this.

Signed-off-by: Matija Šuklje <matija@suklje.name>
Signed-off-by: Matija Šuklje <matija@suklje.name>
- fixed an occurance of a wrong closing tag
- fixed section case
- expanded file info to include snippet info
- introduced snippet nesting, incl. example

Signed-off-by: Matija Šuklje <matija@suklje.name>
A more structured way to include snippets in Annex H.

Signed-off-by: Matija Šuklje <matija@suklje.name>
Thanks to Alexios Zavras for the suggestion (and many others when
adding snippet support to Annex H)

Signed-off-by: Matija Šuklje <matija@suklje.name>
Copy link
Member

@goneall goneall left a comment

Choose a reason for hiding this comment

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

@silverhook Looks really good to me. Thanks!

@goneall
Copy link
Member

goneall commented Jun 16, 2022

@kestewart We should be able to get this merged in before the release candidate. If you're comfortable with the PR, please go ahead and merge.

@goneall goneall added this to the 2.3 milestone Jun 22, 2022
Copy link
Contributor

@kestewart kestewart left a comment

Choose a reason for hiding this comment

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

Extra context helps. +1 on approving.

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.

4 participants