fix(ble): Fix license compliance#12440
Open
lucasssvaz wants to merge 2 commits intoespressif:masterfrom
Open
Conversation
lucasssvaz
added
Type: Documentation
Contributor
👋 Hello lucasssvaz, we appreciate your contribution to this project! 📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more. 🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project. Click to see more instructions ...
Review and merge process you can expect ...
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates BLE library licensing/attribution metadata to improve Apache 2.0 compliance, primarily by adding standardized license headers and introducing a NOTICE file for upstream credits.
Changes:
- Added Apache 2.0 license headers across most
libraries/BLE/srcsources. - Updated licensing/attribution artifacts (
LICENSE, newNOTICE) and expandedlibrary.propertiesauthor list. - Normalized an MIT header comment block formatting in
HIDTypes.h.
Reviewed changes
Copilot reviewed 61 out of 62 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| libraries/BLE/src/RTOS.h | Add Apache 2.0 license header. |
| libraries/BLE/src/HIDTypes.h | Reformat existing MIT license header comment (no Apache header added). |
| libraries/BLE/src/GeneralUtils.h | Add Apache 2.0 license header. |
| libraries/BLE/src/GeneralUtils.cpp | Add Apache 2.0 license header. |
| libraries/BLE/src/FreeRTOS.cpp | Add Apache 2.0 license header. |
| libraries/BLE/src/BLEValue.h | Add Apache 2.0 license header. |
| libraries/BLE/src/BLEValue.cpp | Add Apache 2.0 license header. |
| libraries/BLE/src/BLEUtils.h | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEUtils.cpp | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEUUID.h | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEUUID.cpp | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEServiceMap.cpp | Add Apache 2.0 license header. |
| libraries/BLE/src/BLEService.h | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEService.cpp | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEServer.h | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEServer.cpp | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLESecurity.h | Add Apache 2.0 license header. |
| libraries/BLE/src/BLESecurity.cpp | Add Apache 2.0 license header. |
| libraries/BLE/src/BLEScan.h | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEScan.cpp | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLERemoteService.h | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLERemoteService.cpp | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLERemoteDescriptor.h | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLERemoteDescriptor.cpp | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLERemoteCharacteristic.h | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLERemoteCharacteristic.cpp | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEHIDDevice.h | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEHIDDevice.cpp | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEExceptions.h | Add Apache 2.0 license header. |
| libraries/BLE/src/BLEExceptions.cpp | Add Apache 2.0 license header. |
| libraries/BLE/src/BLEEddystoneURL.h | Add Apache 2.0 license header. |
| libraries/BLE/src/BLEEddystoneURL.cpp | Add Apache 2.0 license header. |
| libraries/BLE/src/BLEEddystoneTLM.h | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEEddystoneTLM.cpp | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEDevice.h | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEDevice.cpp | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEDescriptorMap.cpp | Add Apache 2.0 license header. |
| libraries/BLE/src/BLEDescriptor.h | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEDescriptor.cpp | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEConnInfo.h | Add Espressif copyright line to existing Apache 2.0 header. |
| libraries/BLE/src/BLEClient.h | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEClient.cpp | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLECharacteristicMap.cpp | Add Apache 2.0 license header. |
| libraries/BLE/src/BLECharacteristic.h | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLECharacteristic.cpp | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEBeacon.h | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEBeacon.cpp | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEAdvertising.h | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEAdvertising.cpp | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEAdvertisedDevice.h | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEAdvertisedDevice.cpp | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEAddress.h | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLEAddress.cpp | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLE2904.h | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLE2904.cpp | Add Apache 2.0 license header with NimBLE-Arduino attribution. |
| libraries/BLE/src/BLE2902.h | Add Apache 2.0 license header. |
| libraries/BLE/src/BLE2902.cpp | Add Apache 2.0 license header. |
| libraries/BLE/src/BLE2901.h | Add Apache 2.0 license header. |
| libraries/BLE/src/BLE2901.cpp | Add Apache 2.0 license header. |
| libraries/BLE/library.properties | Expand author attribution list. |
| libraries/BLE/NOTICE | Add NOTICE file with upstream attribution text. |
| libraries/BLE/LICENSE | Add additional copyright lines to the Apache 2.0 appendix boilerplate. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
1
to
+5
| /* Copyright (c) 2010-2011 mbed.org, MIT License | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy of this software | ||
| * and associated documentation files (the "Software"), to deal in the Software without | ||
| * restriction, including without limitation the rights to use, copy, modify, merge, publish, | ||
| * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the | ||
| * Software is furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in all copies or | ||
| * substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING | ||
| * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
| * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, | ||
| * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
| */ | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy of this software | ||
| * and associated documentation files (the "Software"), to deal in the Software without | ||
| * restriction, including without limitation the rights to use, copy, modify, merge, publish, |
There was a problem hiding this comment.
PR description says Apache 2.0 headers were added to all source files under libraries/BLE/src, but HIDTypes.h still carries an MIT license header (which may be correct for this third-party file). Please update the PR description to exclude MIT-licensed sources and/or explicitly call out exceptions so the compliance story is accurate.
| derived from, or inspired by is, esp32-snippets, Copyright 2017 Neil Kolban. | ||
|
|
||
| If this library is used for commercial purposes, it is requested that the user consider | ||
| making a donation and/or sponsoring this project to support it's ongoing development. |
There was a problem hiding this comment.
Spelling/grammar: “support it's ongoing development” should be “support its ongoing development” (or add “[sic]” if you intend to preserve the upstream NOTICE text verbatim).
Suggested change
| making a donation and/or sponsoring this project to support it's ongoing development. | |
| making a donation and/or sponsoring this project to support it's [sic] ongoing development. |
Contributor
Test Results101 files 101 suites 29m 37s ⏱️ Results for commit cc021cf. |
Contributor
Memory usage test (comparing PR against master branch)The table below shows the summary of memory usage change (decrease - increase) in bytes and percentage for each target.
Click to expand the detailed deltas report [usage change in BYTES]
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
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.
Description of Change
This pull request updates the licensing and attribution information for the BLE library, ensuring that all relevant contributors and upstream projects are properly credited. It also adds explicit Apache 2.0 license headers to the source files. No functional or behavioral code changes are included; these are documentation and legal compliance updates. PTAL if there is nothing I missed @h2zero
Licensing and Attribution Updates:
library.properties,LICENSE, and a newNOTICEfile to include Espressif Systems, Neil Kolban, Ryan Powell, and NimBLE-Arduino contributors, as well as references to upstream projects. [1] [2] [3].cppand.h) files in thelibraries/BLE/srcdirectory, explicitly crediting Espressif, Neil Kolban, Ryan Powell, and NimBLE-Arduino contributors where appropriate. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17]These changes ensure legal compliance and proper attribution for the BLE library's codebase.