spdx/spdx-3-model

Where is the "Legacy Text Template format section"?

Closed this issue · 13 comments

vargenau commented

In standardLicenseTemplate, it says:

A standardLicenseTemplate contains a license template which describes sections of the License text which can be varied. See the Legacy Text Template format section of the SPDX specification for format information.

Where is the "Legacy Text Template format section"?

bact commented

They are available in v2.3 (part of the License Matching Guidelins discussed in #746) but I cannot find it in v3.0 as well.

https://spdx.github.io/spdx-spec/v2.3/license-matching-guidelines-and-templates/#b153-legacy-text-template-format

bact commented

Will be fixed by spdx/spdx-spec#968

bact commented
  • Note that the new Licensing Matching Guidelines in v3.0.1, added by spdx/spdx-spec#968 (merged), does not have a "Legacy Text Template format" subsection in the "C.15 SPDX License list" section.
swinslow commented

Thanks @vargenau for noting this.

I would be inclined to delete the following sentence from https://github.com/spdx/spdx-3-model/blob/main/model/ExpandedLicensing/Properties/standardLicenseTemplate.md:

See the Legacy Text Template format section of the SPDX specification for format information.

As well as, from the Summary part of that same file:

, in SPDX templating format

@goneall @zvr Let me know if you feel differently. If this should stay, then I assume we would need to re-insert the legacy text template formatting section into the spec and/or model. I don't have a preference either way, but agree that this should be consistent.

  • ❤️1
bact commented

@swinslow ExpandedLicensing/Properties/standardAdditionTemplate also made a reference to the Legacy Text Template. Do you feel to delete that reference as well?

bact commented

@swinslow I open PR #818 to made changes as you suggested (and also include standardAdditionTemplate).

Note that this is related to the release of 3.0.1 model, as it may introduce changes to these properties:

The PR can be close if we think we should keep it,
then another PR will be made to reinsert the Legacy Text Template formatting section into https://github.com/spdx/spdx-spec/blob/development/v3.0.1/docs/annexes/license-matching-guidelines-and-templates.md

goneall commented

Since we are moving towards using the licenseXml to describe the variable text, I am in favor of removing the references. In looking at the description for the licenseXml description, I did notice one problem - we reference the Github URL for the field definitions. @zvr - will this be a problem for ISO? I haven't checked to see if this is covered by another issue or pull request.

goneall commented

Since we are moving towards using the licenseXml to describe the variable text, I am in favor of removing the references. In looking at the description for the licenseXml description, I did notice one problem - we reference the Github URL for the field definitions. @zvr - will this be a problem for ISO? I haven't checked to see if this is covered by another issue or pull request.

After reviewing the PR, I changed my mind. I think we need to include the format description even though we are encouraging the XML format. Perhaps in the field we should mention that the licenseXml contains the same replacement information and should be used.

  • 👍1
bact commented

In looking at the description for the licenseXml description, I did notice one problem - we reference the Github URL for the field definitions. @zvr - will this be a problem for ISO? I haven't checked to see if this is covered by another issue or pull request.

I updated the links in licenseXml description to use a specific version in this PR #819

(btw, updates in spdx-3-model will not automatically show in the https://spdx.github.io/spdx-spec/v3.0.1-draft/, as the website build workflow will only get triggered by a PR from within spdx-spec)

bact commented

After reviewing the PR, I changed my mind. I think we need to include the format description even though we are encouraging the XML format. Perhaps in the field we should mention that the licenseXml contains the same replacement information and should be used.

I address this with PR #820

bact commented

Two options

  1. Remove Legacy Text Template, apply this PR

    1. #818

  2. Keep Legacy Text Template, apply this PR

    1. spdx/spdx-spec#1026
    2. #820

Option 1 is less likely, as it will make a string in standardLicenseTemplate and standardAdditionTemplate a free-form text.

kestewart commented

Based on discussion in call, we're going forward with "Keep Legacy Text Template", and apply the two PRs. Art will close #818

bact commented

spdx/spdx-spec#1026 still needs to be applied