readme: add list of licenses - not Apache 2.0 #9502

0xc0170 · 2019-01-25T08:13:50Z

Description

Add paragraph to readme with all folders containing non Apache 2.0. I would like all teams to verify this and approve.

I am still identifying targets licenses, we might extend that list to be more accurate.

Pull request type

[X] Fix
[ ] Refactor
[ ] Target update
[ ] Functionality change
[ ] Docs update
[ ] Test update
[ ] Breaking change

Reviewers

@SeppoTakalo @AnttiKauppila @donatieng @dannybenor @SenRamakri

Name all folders containing different liceses. Any new file not Apache 2.0 should be captured here.

0xc0170 · 2019-01-25T08:21:56Z

As soon as this is approved, will add docs team to review and make sure this is also mentioned in our docs (license page). This list will need to be kept up to date.

0xc0170 · 2019-01-25T08:24:24Z

@SeppoTakalo @AnttiKauppila @donatieng @dannybenor @SenRamakri

Added you as reviewers based on the code areas - please look at them, if we have it correctly specified.

SeppoTakalo

I think the idea of having this list if good, it clarifies things, but the list itself is inaccurate.

Provided some feedback of what should be changed.

SeppoTakalo · 2019-01-25T09:38:11Z

README.md

+- features/FEATURE_BLE/targets - BSD-style/PBL/MIT
+- features/lorawan - Revised BSD
+- features/lwipstack - BSD-3-Clause/MIT
+- features/nanostack/sal-stack-nanostack - BSD-3-Clause


This is only partially true..
Most of the Nanostack itself is Apache 2.0, but there are Thread related code which is BSD.
https://github.com/ARMmbed/mbed-os/tree/master/features/nanostack/sal-stack-nanostack/source/6LoWPAN/Thread

I would recommend doing a proper table with links to the sources/licence file in the three. Makes it easier to find those, since for the BSD related stuff - the end product needs to show the license SOMEWHERE in the UI/manuals.

Having a link to POINT to a direct LICENSE -file also ensures we do our due diligence and include the license in the source code itself, like we need to.

I stated this lists contains folders with non-apache files (thus nanostack folder marked as it contains BSD-3-Clause, does not mean there are no files with Apache 2.0). Each of these folders should have then list of non Apache files in its folder.

I like the idea having the tree link

features/nanostack/sal-stack-nanostack - BSD-3-Clause

This would have url link so we can go to nanostack folder and there would be:

license file (in this case BSD-3-Clause)

Readme with license information (what files are non-apache)

In cases like nanostack this is simple, when we consider targets like we have in BLE or under targets/ the list will be very large (multiple licenses involved).

Open for suggestions

Updated. The latest push contains links to folders. Each of them should contain Readme (will be added later by separate PRs). I'll add this requirement to our documentation first and will request each module to add it later.

Readme.md in the root should just point to features/nanostack (license overview).
features/nanostack/Readme.md will contain list of files/modules inside with licenses (detailed view).

Our license page actually contains this, we just need to fix the current ones and check the new ones as a requirement

https://os.mbed.com/docs/mbed-os/v5.11/contributing/license.html (Using a different license).

SeppoTakalo · 2019-01-25T09:39:15Z

README.md

+- features/storage/blockdevice - MIT
+- features/storage/filesystem/littlefs - BSD-3-Clause
+- features/storage/filesystem/fat - MIT/BSD-style
+- features/netsocket/emac-drivers - BSD-3-Clause


This depends on the driver itself.
There drivers are supplied mostly by our partners, so it is not our choice what license they use.

We just need to document the licenses - provide a list of files that are not. This is going that direction and we start documenting every change to this (if not Apache files being added, they need to be documented and questioned why not apache 2.0/pbl as our license guide suggests).

ciarmcom · 2019-01-25T10:00:36Z

@0xc0170, thank you for your changes.
@AnttiKauppila @SeppoTakalo @SenRamakri @dannybenor @donatieng @ARMmbed/mbed-os-maintainers please review.

cmonr · 2019-02-12T01:27:42Z

@0xc0170 Any updates?

AnttiKauppila

WAN team content is fine

0xc0170 · 2019-02-12T09:43:56Z

@cmonr Yes, I've completed the scan and its results, will update this.

Fix licenses based on latest Fossology scan. Using -style licenses for specific type licenses Add paths to the readme.

0xc0170 · 2019-02-12T10:24:45Z

I've updated the Readme - used 5.11.3 release scan results. Added paths to each folder as @JanneKiiskila suggested. It now contains components. Each of these will need own readme to specify licenses in detail. This will be the second step. Good exercise will be to capture targets folders.

Ready for review

0xc0170 · 2019-02-12T13:25:42Z

Created #9683 to have licenses fixed in each of the items in the list here. Will be tracked separately.

cmonr

Find a different way to indicate/list/link files with different licenses.

README.md should be short and easy to digest. This PR asis would double the size of the file while only providing very specific information that most users would not care about.

cmonr · 2019-02-12T20:52:40Z

README.md

@@ -33,6 +33,26 @@ The software is provided under [Apache-2.0 license](LICENSE). Contributions to t

 This project contains code from other projects. The original license text is included in those source files. They must comply with our [license guide](https://os.mbed.com/docs/latest/reference/license.html)

+Folders containing files not under Apache 2.0 as listed above (each folder should contain own README file with license specified for its files). The original license text is included in those source files.
+
+- [cmsis](./cmsis) - MIT, BSD-3-Clause


I really don't like how much this changes what is suppose to be a simple README.

cmonr · 2019-02-12T20:56:09Z

Added @ARMmbed/mbed-docs for review (bad bot, leaving them out...)

0xc0170 · 2019-02-13T10:49:09Z

README.md should be short and easy to digest. This PR asis would double the size of the file while only providing very specific information that most users would not care about.

I can create LICENSE file with this list, and just link it here.

0xc0170 · 2019-02-13T11:30:52Z

Pushed an update, following our license guide. LICENSE provides overview of licenses, LICENSE-apache-2.0.txt the main license text. And our readme just references both.

cmonr · 2019-02-13T19:23:21Z

README.md

@@ -29,10 +29,12 @@ The [release notes](https://os.mbed.com/releases) detail the current release. Yo

 ## License and contributions 

-The software is provided under [Apache-2.0 license](LICENSE). Contributions to this project are accepted under the same license. Please see [contributing.md](CONTRIBUTING.md) for more info. 
+The software is provided under [Apache-2.0 license](LICENSE-apache-2.0.txt). Contributions to this project are accepted under the same license. Please see [contributing.md](CONTRIBUTING.md) for more info. 

 This project contains code from other projects. The original license text is included in those source files. They must comply with our [license guide](https://os.mbed.com/docs/latest/reference/license.html)


Suggested change

This project contains code from other projects. The original license text is included in those source files. They must comply with our [license guide](https://os.mbed.com/docs/latest/reference/license.html)

This project contains code from other projects. The original license text is included in those source files. They must comply with our [license guide](https://os.mbed.com/docs/latest/reference/license.html).

cmonr

👍

0xc0170 · 2019-02-14T13:08:39Z

Needs more reviews ! I would like to have this on master, so any new non apache code is documented.

0xc0170 · 2019-02-15T09:42:21Z

@AnotherButler Can you pls review? If we can get this in prior the weekend, we are going to push for cleanup licenses the following weeks

0xc0170 · 2019-02-15T09:46:38Z

LICENSE

+Unless specifically indicated otherwise in a file, files are licensed under the Apache 2.0 license,
+as can be found in: LICENSE-apache-2.0.txt
+
+Folders containing files under different permissive license than Apache 2.0 are listed below. Eeach folder should contain own README file with license specified for its files. The original license text is included in those source files.


Eeach -> typo, @AnotherButler Can you fix ? I've just noticed this, I expect additional styling commit :)

Fix typo as requested in comments.

Include articles for clarity.

cmonr · 2019-02-15T20:10:58Z

CI started

mbed-ci · 2019-02-15T21:50:05Z

Test run: SUCCESS

Summary: 12 of 12 test jobs passed
Build number : 1
Build artifacts

0xc0170 · 2019-02-18T10:01:49Z

I've noticed one thing reviewing it now on master. We might want to rename LICENSE to LICENSE.md as Github does not show it as markdown - the view is "raw", see https://github.com/ARMmbed/mbed-os/blob/master/LICENSE

@AnotherButler Should we update our docs to specify license decription files being .md files rather?

0xc0170 · 2019-02-18T10:02:27Z

I'll send separate PR addressing this.

readme: add list of licenses - not Apache 2.0

417979f

Name all folders containing different liceses. Any new file not Apache 2.0 should be captured here.

SeppoTakalo suggested changes Jan 25, 2019

View reviewed changes

ciarmcom requested review from AnttiKauppila, dannybenor, donatieng, SenRamakri, SeppoTakalo and a team January 25, 2019 10:00

ciarmcom added the needs: review label Jan 25, 2019

0xc0170 added needs: work and removed needs: review labels Jan 28, 2019

AnttiKauppila approved these changes Feb 12, 2019

View reviewed changes

0xc0170 added 2 commits February 12, 2019 10:13

readme: license update

bec0033

Fix licenses based on latest Fossology scan. Using -style licenses for specific type licenses Add paths to the readme.

readme: storage license under one folder

9de5297

0xc0170 mentioned this pull request Feb 12, 2019

License documentation for non-apache files (non-targets code) #9683

Closed

15 tasks

cmonr suggested changes Feb 12, 2019

View reviewed changes

cmonr requested a review from a team February 12, 2019 20:55

0xc0170 added 2 commits February 13, 2019 11:28

license: rename to apache 2.0 txt file

2cde31c

license: add license file containing folders with non apache license

49d6dd8

0xc0170 added the needs: review label Feb 13, 2019

0xc0170 removed the needs: work label Feb 13, 2019

readme: license file reference fix

7b3feea

cmonr reviewed Feb 13, 2019

View reviewed changes

cmonr approved these changes Feb 13, 2019

View reviewed changes

readme: fix space and . in license

1e43cdf

0xc0170 force-pushed the dev_readme_licenses branch from 66ea3b1 to 1e43cdf Compare February 14, 2019 10:42

SeppoTakalo approved these changes Feb 14, 2019

View reviewed changes

0xc0170 commented Feb 15, 2019

View reviewed changes

Amanda Butler added 2 commits February 15, 2019 13:58

Fix typo in LICENSE

e0aa9c5

Fix typo as requested in comments.

Add articles to README.md

4aaf3e4

Include articles for clarity.

AnotherButler approved these changes Feb 15, 2019

View reviewed changes

cmonr added ready for merge release-version: 5.11.5 and removed needs: review labels Feb 15, 2019

cmonr merged commit 287dde4 into ARMmbed:master Feb 15, 2019

cmonr removed the ready for merge label Feb 15, 2019

0xc0170 deleted the dev_readme_licenses branch February 18, 2019 09:59

0xc0170 mentioned this pull request Feb 18, 2019

license: add extension to LICENSE file ARMmbed/mbed-os-5-docs#954

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

readme: add list of licenses - not Apache 2.0 #9502

readme: add list of licenses - not Apache 2.0 #9502

0xc0170 commented Jan 25, 2019 •

edited

Loading

0xc0170 commented Jan 25, 2019

0xc0170 commented Jan 25, 2019

SeppoTakalo left a comment

SeppoTakalo Jan 25, 2019

JanneKiiskila Jan 25, 2019 •

edited

Loading

0xc0170 Jan 25, 2019 •

edited

Loading

0xc0170 Feb 12, 2019

0xc0170 Feb 12, 2019

SeppoTakalo Jan 25, 2019

0xc0170 Feb 12, 2019

ciarmcom commented Jan 25, 2019

cmonr commented Feb 12, 2019

AnttiKauppila left a comment

0xc0170 commented Feb 12, 2019

0xc0170 commented Feb 12, 2019

0xc0170 commented Feb 12, 2019

cmonr left a comment

cmonr Feb 12, 2019

cmonr commented Feb 12, 2019

0xc0170 commented Feb 13, 2019

0xc0170 commented Feb 13, 2019

cmonr Feb 13, 2019

0xc0170 Feb 14, 2019

cmonr left a comment

0xc0170 commented Feb 14, 2019

0xc0170 commented Feb 15, 2019

0xc0170 Feb 15, 2019

cmonr commented Feb 15, 2019

mbed-ci commented Feb 15, 2019

0xc0170 commented Feb 18, 2019

0xc0170 commented Feb 18, 2019

	This project contains code from other projects. The original license text is included in those source files. They must comply with our [license guide](https://os.mbed.com/docs/latest/reference/license.html)
	This project contains code from other projects. The original license text is included in those source files. They must comply with our [license guide](https://os.mbed.com/docs/latest/reference/license.html).

readme: add list of licenses - not Apache 2.0 #9502

readme: add list of licenses - not Apache 2.0 #9502

Conversation

0xc0170 commented Jan 25, 2019 • edited Loading

Description

Pull request type

Reviewers

0xc0170 commented Jan 25, 2019

0xc0170 commented Jan 25, 2019

SeppoTakalo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JanneKiiskila Jan 25, 2019 • edited Loading

Choose a reason for hiding this comment

0xc0170 Jan 25, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ciarmcom commented Jan 25, 2019

cmonr commented Feb 12, 2019

AnttiKauppila left a comment

Choose a reason for hiding this comment

0xc0170 commented Feb 12, 2019

0xc0170 commented Feb 12, 2019

0xc0170 commented Feb 12, 2019

cmonr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cmonr commented Feb 12, 2019

0xc0170 commented Feb 13, 2019

0xc0170 commented Feb 13, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cmonr left a comment

Choose a reason for hiding this comment

0xc0170 commented Feb 14, 2019

0xc0170 commented Feb 15, 2019

Choose a reason for hiding this comment

cmonr commented Feb 15, 2019

mbed-ci commented Feb 15, 2019

0xc0170 commented Feb 18, 2019

0xc0170 commented Feb 18, 2019

0xc0170 commented Jan 25, 2019 •

edited

Loading

JanneKiiskila Jan 25, 2019 •

edited

Loading

0xc0170 Jan 25, 2019 •

edited

Loading