Add REUSE license checker and CI check to new glTF 2.0 branch #2029
Conversation
oddhack
commented
Sep 22, 2021
•
oddhack
commented
- Replaces old specification/2.0/README.md which contained the 2.0 specification document with a link to the new glTF Registry which will contain generated HTML / PDF outputs from the asciidoc version.
- Add license text of all licenses used under LICENSES/.
- Add copyright statements that are readable by REUSE where reasonably possible.
- Add .reuse/dep5 entry as fallback licenses for images etc. where explicit copyrights not possible.
- Add 'reuse lint' check to github Actions CI
- Use 'TBD' license on vendor extensions, none of which seem to have explicit licenses and may not be owned by Khronos.
- Some minor whitespace / EOL convention changes.
- Add boilerplate files missing from repo such as CONTRIBUTING and COPYING.
* Add license text of all licenses used under LICENSES/. * Add copyright statements that are readable by REUSE where reasonably possible. * Add .reuse/dep5 entry as fallback licenses for images etc. where explicit copyrights not possible. * Add 'reuse lint' check to github Actions CI * Use 'TBD' license on vendor extensions, none of which seem to have explicit licenses and may not be owned by Khronos. * Some minor whitespace / EOL convention changes. * Add boilerplate files missing from repo such as CONTRIBUTING and COPYING.
|
The replacement content in |
|
This looks good to me. Some questions:
|
Easiest way would be to define an attribute in the Makefile and use asciidoc ifndef::attribute[] to delimit github-only text.
For most of our APIs we've felt there's considerable value in having a single place to look for extensions, but YMMV of course. |
|
Yes - from https://asciidoctor.org/
AsciiDoc is the language.
Asciidoctor is the processor.
So I would say:
+**NOTE** as of September 23, 2021, the glTF 2.0 Specification has been moved to AsciiDoc format.
From: Alexey Knyazev ***@***.***>
Sent: Wednesday, September 22, 2021 5:20 PM
To: KhronosGroup/glTF ***@***.***>
Cc: Neil Trevett ***@***.***>; Review requested ***@***.***>
Subject: Re: [KhronosGroup/glTF] Add REUSE license checker and CI check to new glTF 2.0 branch (#2029)
@lexaknyazev commented on this pull request.
________________________________
In README.md<#2029 (comment)>:
@@ -9,8 +14,10 @@ glTF™ (GL Transmission Format) is a royalty-free specification for the efficie
## Specification
-* [glTF Specification, 2.0](https://github.com/KhronosGroup/glTF/blob/master/specification/2.0/README.md) (or [all specification versions](https://github.com/KhronosGroup/glTF/blob/master/specification/README.md))
-* [glTF Extension Registry](https://github.com/KhronosGroup/glTF/blob/master/extensions/README.md)
+**NOTE** as of September 23, 2021, the glTF 2.0 Specification has been moved to asciidoctor format.
Should the format be called AsciiDoc?
—
You are receiving this because your review was requested.
Reply to this email directly, view it on GitHub<#2029 (review)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AD36GKZBQFAPRVMUESODJ3DUDJXDNANCNFSM5ERAVIVA>.
Triage notifications on the go with GitHub Mobile for iOS<https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android<https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.
|
|
@oddhack |
It's not difficult in the PDF/HTML builds. See definition of SPECDATE / attribute revdate and SPECREMARK / attribute revremark in https://github.com/KhronosGroup/Vulkan-Docs/blob/129f6f69dcbc00184d771d2da969b4ed394ac80c/Makefile#L135-L162 and corresponding https://docs.asciidoctor.org/asciidoc/latest/document/revision-attribute-entries/ . With the proper document header setup the specified {revdate} and {revremark} attributes will get passed through to the output docs in the title section. |
