mdoc: use //license/@expression, not //licenseUrl #578
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonpryor
force-pushed
the
jonp-add-license-expression
branch
from
e06465f to
8e181b6
Compare
Context: https://docs.microsoft.com/en-us/nuget/reference/nuspec#licenseurl Context: https://docs.microsoft.com/en-us/nuget/reference/nuspec#license Context: https://docs.microsoft.com/en-us/dotnet/standard/library-guidance/nuget#important-nuget-package-metadata Context: https://docs.clearlydefined.io/curation-guidelines Certain internal Microsoft tools check NuGet license information by using [ClearlyDefined curated data][0] to determine verified license information for packages which don't "clearly define" their license. Unfortunately, a license URL is *not* considered "clearly defined", likely because it isn't *really* machine readable. (Just because the URL contains "MIT" doesn't mean it's *actually* MIT.) As part of this effort, [NuGet deprecated][1] the [`<licenseUrl/>`][2] element, preferring instead the new [`<license/>`][3] element. Replace `<licenseUrl/>` with `<license/>`, and provide a `//license/@type` value of `expression`. The value of the `<license/>` element is `MIT`, which is an [SPDX identifier][4], which is a "clearly defined" value, and thus satisfies ClearlyDefined. [0]: https://github.com/clearlydefined/curated-data/ [1]: NuGet/Home#7509 [2]: https://docs.microsoft.com/en-us/nuget/reference/nuspec#licenseurl [3]: https://docs.microsoft.com/en-us/nuget/reference/nuspec#license [4]: https://spdx.org/licenses/
jonpryor
force-pushed
the
jonp-add-license-expression
branch
from
8e181b6 to
2cb605a
Compare
akoeplinger
approved these changes
Feb 17, 2022
Collaborator
|
@jonpryor @akoeplinger please target on |
huangmin-ms
added a commit
that referenced
this pull request
Feb 21, 2022
This reverts commit d40ae84.
huangmin-ms
added a commit
that referenced
this pull request
Feb 23, 2022
Context: https://docs.microsoft.com/en-us/nuget/reference/nuspec#licenseurl Context: https://docs.microsoft.com/en-us/nuget/reference/nuspec#license Context: https://docs.microsoft.com/en-us/dotnet/standard/library-guidance/nuget#important-nuget-package-metadata Context: https://docs.clearlydefined.io/curation-guidelines Certain internal Microsoft tools check NuGet license information by using [ClearlyDefined curated data][0] to determine verified license information for packages which don't "clearly define" their license. Unfortunately, a license URL is *not* considered "clearly defined", likely because it isn't *really* machine readable. (Just because the URL contains "MIT" doesn't mean it's *actually* MIT.) As part of this effort, [NuGet deprecated][1] the [`<licenseUrl/>`][2] element, preferring instead the new [`<license/>`][3] element. Replace `<licenseUrl/>` with `<license/>`, and provide a `//license/@type` value of `expression`. The value of the `<license/>` element is `MIT`, which is an [SPDX identifier][4], which is a "clearly defined" value, and thus satisfies ClearlyDefined. [0]: https://github.com/clearlydefined/curated-data/ [1]: NuGet/Home#7509 [2]: https://docs.microsoft.com/en-us/nuget/reference/nuspec#licenseurl [3]: https://docs.microsoft.com/en-us/nuget/reference/nuspec#license [4]: https://spdx.org/licenses/ Co-authored-by: Min Huang <huangmin@microsoft.com> Co-authored-by: Jonathan Pryor <jonpryor@vt.edu>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context: https://docs.microsoft.com/en-us/nuget/reference/nuspec#licenseurl
Context: https://docs.microsoft.com/en-us/nuget/reference/nuspec#license
Context: https://docs.microsoft.com/en-us/dotnet/standard/library-guidance/nuget#important-nuget-package-metadata
Context: https://docs.clearlydefined.io/curation-guidelines
Certain internal Microsoft tools check NuGet license information by
using ClearlyDefined curated data to determine verified license
information for packages which don't "clearly define" their license.
Unfortunately, a license URL is not considered "clearly defined",
likely because it isn't really machine readable. (Just because the
URL contains "MIT" doesn't mean it's actually MIT.)
As part of this effort, NuGet deprecated the
<licenseUrl/>element, preferring instead the new
<license/>element.Replace
<licenseUrl/>with<license/>, and provide a//license/@typevalue ofexpression. The value of the<license/>element isMIT, which is an SPDX identifier,which is a "clearly defined" value, and thus satisfies ClearlyDefined.