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

Add Legacy Text Template format section back to the Matching Guidelines #1026

Conversation

bact
Copy link
Collaborator

@bact bact commented Aug 6, 2024

standardLicenseTemplate and standardAdditionTemplate still need the Legacy Text Template.

See discussion in spdx/spdx-3-model#747 (comment)

bact added 3 commits August 6, 2024 12:12
Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
Copy link
Member

@maxhbr maxhbr left a comment

Choose a reason for hiding this comment

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

LGTM, easy to review in the rich diff

@bact bact mentioned this pull request Aug 6, 2024
69 tasks
@kestewart kestewart requested review from swinslow, jlovejoy and zvr August 7, 2024 14:37
@kestewart kestewart added this to the 3.0.1 milestone Aug 7, 2024
@kestewart
Copy link
Contributor

@jlovejoy, @swinslow - here's the PR that is adding it back, that was referenced yesterday.

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.

The source where we copy the whole annex should be https://github.com/spdx/license-list-XML/blob/main/DOCS/license-matching-guidelines-and-templates.md and not some ancient version from SPDXv2.

Use the same word as other examples:

Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact
Copy link
Collaborator Author

bact commented Aug 7, 2024

@zvr I was using v2.3.1 only because it's the latest version before v3.0 (which doesn't has this file). I was not aware of license-list-XML, so thanks for the pointer.

I just have checked the Legacy Text Template format section from both sources (license-list-XML and v2.3.1), they are identical.

@bact bact requested a review from zvr August 7, 2024 16:10
Use `...` around special characters,
as `\` will be interpreted as an escaping symbol - which made `\<\<\>\>` being displayed as `<<>>`.

Signed-off-by: Arthit Suriyawongkul <[email protected]>
@zvr
Copy link
Member

zvr commented Aug 7, 2024

@bact have you checked that the complete file is identical (not only the last section) ?

@bact
Copy link
Collaborator Author

bact commented Aug 7, 2024

@zvr this PR is based on the existing file. The last section is added. Other sections are added by PR #968.

I haven't look very carefully all of them, only headings (that's how I spotted the missing "C.6.4" anchor). I can check them all again.

@bact
Copy link
Collaborator Author

bact commented Aug 7, 2024

Done. Every sections in the source of license-list-XML and v2.3.1 are identical.

Through the scan, found two spots in "HTTP Protocol" section that may need changes:

  • Protocol names (HTTP and HTTPS) should be in UPPERCASE
  • The URL schema names at the first part of URL ("http://" and "https://", which will be the actual texts to be compared) should be in lowercase
  • Open a PR Add missing anchors B.6.4, B.15.3; Swap HTTP cases license-list-XML#2537 there in license-list-XML repo for people there to decide. Text in this PR is unchanged.

Also one typo found (introduced be myself during the link format conversion), will fix that.

Signed-off-by: Arthit Suriyawongkul <[email protected]>
@jlovejoy
Copy link
Member

jlovejoy commented Aug 8, 2024

@zvr - now I'm confused... are we keeping the matching guidelines in the license list repo? we definitely should not have them in two places!

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.

LGTM

@goneall goneall merged commit e807882 into spdx:development/v3.0.1 Aug 9, 2024
3 checks passed
@bact bact deleted the add-back-legacy-text-template-format-section branch August 9, 2024 18:43
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.

6 participants