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

Differences between 3.0.1 and 2.2.1 for ISO submission #1124

Closed
wants to merge 7 commits into from

Conversation

bact
Copy link
Collaborator

@bact bact commented Sep 26, 2024

Draft - Based on text in https://github.com/spdx/using/blob/main/docs/diffs-from-previous-editions.md

Difference from the base-text

  • "Properties Removed" and "Naming Differences" sections are converted to tables for easy comparison
  • Fixed typos and wrong property names, as listed in Fix typos in diffs-from-previous-editions.md using#18
  • Added new hash algorithms (from 2.3)
  • Added info about the change of License matching to XML format (from 2.3)

To resolve #999

To be added

  • Incorporate changes between 2.2.1 and 2.3 in
  • V2.3-V2.2.2:
    • License matching is now using License List XML format
    • Added hash algorithms (SHA3-256, SHA3-384, SHA3-512, BLAKE2b-256,
      BLAKE2b-384, BLAKE2b-512, BLAKE3, ADLER32 )
    • PrimaryPackagePurpose is new in 2.3

Issues to be resolved

  • In SPDX 2 File Type v SPDX 3 Content Type table, there's a mention of "text/spdx", it is tag:value SPDX file format which is not available in SPDX 3 yet.

Possible style

We may like to see examples from similar "diffs" in other ISO docs.

For example, ISO 13485:2016 - Medical devices - Quality management systems - Requirements for regulatory purposes has an "Annex A Comparison of content between ISO 13485:2003 and ISO 13485:2016" in a table format.

Clause in ISO 13485:2016 Comment on change compared with ISO 13485:2003
Foreword — Clarifies ...
Introduction
0.1 General
— Includes ...
— Explains ...
— Alerts ...

Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact bact added ISO publication Last minute publication (considerations for markdown to word) publishing labels Sep 26, 2024
@bact bact added this to the 3.0.1 milestone Sep 26, 2024
@bact bact marked this pull request as draft September 26, 2024 10:00
@bact bact self-assigned this Sep 26, 2024
Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
"Primary Package Purpose", "Build Date", "Release Date", "Valid Until Date" are from 2.3.

Removed as they not from 2.2.1

Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
@zvr zvr removed this from the 3.0.1 milestone Sep 27, 2024
@zvr
Copy link
Member

zvr commented Sep 27, 2024

I think the "changes" should start with much more general view, talking about how we went from SpdxDocument to general data, leaving behind the Package/File/Snippet types but introducing dozens of different elements, etc. etc.

I cleared the milestone because I don't think it's realistic to have this ready immediately.

Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact bact closed this Nov 20, 2024
@bact bact deleted the diff-221-301 branch November 20, 2024 14:23
@bact
Copy link
Collaborator Author

bact commented Nov 20, 2024

Close as looks like we don't want this for ISO.

@bact
Copy link
Collaborator Author

bact commented Nov 20, 2024

Do we still want to have a section of diffs between versions somewhere on the website just like we do have in the past?
If so, a diff between 3.0.1 and 3.0 is needed. These can be based on change logs in spdx-spec and spdx-3-model repos.

@goneall
Copy link
Member

goneall commented Nov 20, 2024

Do we still want to have a section of diffs between versions somewhere on the website just like we do have in the past? If so, a diff between 3.0.1 and 3.0 is needed. These can be based on change logs in spdx-spec and spdx-3-model repos.

We can update the diffs-from-previous-versions in the using repo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ISO publication Last minute publication (considerations for markdown to word) publishing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Annex A (diffs from previous) should be about the previous ISO version
3 participants