diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e5eb3b6d7..25b08df08 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,81 +1,99 @@ # Contributing to GNU Radio + :+1::tada: First off, thanks for taking the time to contribute! :tada::+1: The following is a set of guidelines for contributing. These are mostly guidelines, not rules. Use your best judgement, and feel free to propose changes to this document in a pull request. ## Open an issue + For bugs, issues, or other discussion, please log a new issue in the GitHub repository. GitHub supports [markdown](https://help.github.com/categories/writing-on-github/), so when filing bugs make sure you check the formatting before clicking submit. ## Other discussions + For general "how-to" and guidance questions about using GNU Radio to build and run applications, please have a look at the various examples or if you cannot find anything that fits your use-case use GitHub's discussions forum. ## Contributing code and content + We welcome all forms of contributions from the community. Please read the following guidelines to maximise the chances of your PR being merged. +### Communication + +- Before starting work on a feature, check if there isn't already an example in the block library. + If not, then please open an issue on GitHub describing the proposed feature. We want to make sure any feature work goes smoothly. + We're happy to work with you to determine if it fits the current project direction and make sure no one else is already working on it. + +- For any work related to setting up build, test, and CI for GNU Radio on GitHub, or for small patches or bug fixes, please open an issue + for tracking purposes, but we generally don't need a discussion prior to opening a PR. + +### Development process + +Please be sure to follow the usual process for submitting PRs: + +- Fork the repository +- Make sure it compiles w/o errors against the current release 'main' branch: +- Write and add a descriptive/meaningful unit-test-case +- apply the default code formatter (to minimise future refactoring) +- Please check against common sanitizers, the CI/CD pipeline, or similar other QA code checker (N.B. other/further code improvements are welcome) +- Create a pull request +- Make sure your PR title is descriptive +- Include a link back to an open issue in the PR description + +We reserve the right to close PRs that are not making progress. Closed PRs can be reopened again later and work can resume. + +### Copyright Assignment + +GNU Radio does not claim ownership of any contributions you make. All copyrights remain with the original author of the contribution. As such, we don't require copyright notices in the header of each file, and the broader copyright statement for collective attribution is located in the [README](README.md) + +#### Non-Revocability of Contributions + +By submitting a contribution to the GNU Radio project, you agree that your contribution is non-revocable. Once a contribution is accepted and merged into the GNU Radio repository, it cannot be withdrawn or removed by the original author. This ensures that the integrity and continuity of the project's codebase are preserved. + +### License Terms + +GNU Radio intends to maintain the existing license terms under which contributions are made. We do not intend to change the licensing terms of any contributions after submission. Any potential changes to the license, such as re-licensing, would require an explicit, agreed-upon process involving the contributor and the project maintainers. Initial license terms are specified in the LICENSE file of the subdirectory under which licensing differs from the top level license, or in the SPDX header of the individual file if not consistent with the overall subdirectory. + +By submitting a contribution, you agree to the terms of the Developer Certificate of Origin (DCO), which certifies that your contribution is your original work and that you have the right to submit it under the license terms of the specific module. + + ### DCO Signing -Any code contributions going into GNU Radio will become part of a LGPL-licensed, open source repository. It is therefore imperative that code submissions belong to the authors, and that submitters have the authority to merge that code into the public GNU Radio codebase. +Code submitters must have the authority to merge that code into the public GNU Radio codebase. +In some cases, the rights to exploit the code may belong to the contributor's employer, depending on jurisdiction +and employment agreements. -For that purpose, we use the [Developer's Certificate of Origin](DCO.txt). It is the same document used by other projects. Signing the DCO states that there are no legal reasons to not merge your code. +For that purpose, we use the [Developer's Certificate of Origin](DCO.txt). It is the same document used by other +projects. +Signing the DCO states that there are no legal reasons to not merge your code. -To sign the DCO, suffix your git commits with a "Signed-off-by" line. When using the command line, you can use `git commit -s` to automatically add this line. If there were multiple authors of the code, or other types of stakeholders, make sure that all are listed, each with a separate Signed-off-by line. +To sign the DCO, suffix your git commits with a "Signed-off-by" line. When using the command line, +you can use `git commit -s` to automatically add this line. If there were multiple authors of the code, or other types +of stakeholders, make sure that all are listed, each with a separate Signed-off-by line. -### Communication - - Before starting work on a feature, check if there isn't already an examples in the 'samples' sub-module. - If not, then please open an issue on GitHub describing the proposed feature. We want to make sure any feature work goes smoothly. - We're happy to work with you to determine if it fits the current project direction and make sure no one else is already working on it. +#### License Philosophy - - For any work related to setting up build, test, and CI for GNU Radio on GitHub, or for small patches or bug fixes, please open an issue - for tracking purposes, but we generally don't need a discussion prior to opening a PR. +GNU Radio 4 uses the MIT License for the core runtime and libraries, with the option for submodules to be licensed under GPLv3 when the author desired stronger copyleft or the code origin requires it. This licensing model in combination with the DCO was chosen to support the following goals: -### Development process -Please be sure to follow the usual process for submitting PRs: +- Maximize Adoption and Enable Public-Private Collaboration: The MIT License reduces legal and logistical friction for development partners - including those with cautious legal teams or incompatible licensing needs - making it easier for academia, industry, and government to integrate, contribute to, and build on GNU Radio. This fosters innovation, accelerates adoption across sectors, and ensures that the broader community benefits from shared advancements. - - Fork the repository - - Make sure it compiles w/o errors against the current release 'main' branch: - - Write and add a descriptive/meaningful unit-test-case - - apply the default code formatter (to minimise future refactoring) - - Please check against common sanitizers, the CI/CD pipeline, or similar other QA code checker (N.B. other/further code improvements are welcome) - - Create a pull request - - Make sure your PR title is descriptive - - Include a link back to an open issue in the PR description +- Encourage Contributions from a Diverse Ecosystem: By lowering legal barriers, we aim to attract contributors from companies, academic institutions, and individuals who might otherwise avoid contributing to more restrictively licensed codebases due to internal policies or licensing constraints. -We reserve the right to close PRs that are not making progress. Closed PRs can be reopened again later and work can resume. +- Remain free/libre in the spirit of the open source principles: For certain submodules that implement signal processing algorithms or higher-level blocks, the GPLv3 license can be used to preserve the copyleft spirit of GNU Radio. + +- Empower Submodule Authors: We recognize that some contributors may wish to enforce stronger copyleft guarantees. By allowing submodules to choose GPLv3 (and out of tree authors to choose any other license), we provide flexibility for authors to assert more control over how their code is reused. + +- Stay Compliant with Evolving Legal Landscapes: A modular, permissive licensing approach ensures GNU Radio can remain compliant under changing national and international laws - particularly around cybersecurity, product liability, AI governance, and data protection regulations like GDPR. -### Contributor License Agreement -By contributing your code to GNU Radio you grant us a non-exclusive, -irrevocable, worldwide, royalty-free, sublicenseable, transferable -license under all of Your relevant intellectual property rights -(including copyright, patent, and any other rights), to use, copy, -prepare derivative works of, distribute and publicly perform and -display the Contributions on any licensing terms, including without limitation: -(a) open source licenses like the Apache license; and (b) binary, -proprietary, or commercial licenses. Except for the licenses granted herein, -You reserve all right, title, and interest in and to the Contribution. - -You confirm that you are able to grant us these rights. You represent -that You are legally entitled to grant the above license. If Your employer -has rights to intellectual property that You create, You represent that -You have received permission to make the Contributions on behalf of that -employer, or that Your employer has waived such rights for the Contributions. - -You represent that the Contributions are Your original works of -authorship, and to Your knowledge, no other person claims, or -has the right to claim, any right in any invention or patent -related to the Contributions. You also represent that You are -not legally obligated, whether by entering into an agreement -or otherwise, in any way that conflicts with the terms of this license. - -We acknowledge that, except as explicitly described in this -Agreement, any Contribution which you provide is on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, -EITHER EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, -ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, -MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. + +We accept contributions for in-tree code with the following license preference: + +Core: MIT required + +Block Library: MIT preferred, with GPLv3 as an alternative ## Code of Conduct -To ensure an inclusive community, contributors and users in the GNU Radio -community should follow the [code of conduct](./CODE_OF_CONDUCT.md). + +To ensure an inclusive community, contributors and users in the GNU Radio community should follow +the [code of conduct](./CODE_OF_CONDUCT.md). diff --git a/LICENSE b/LICENSE index 11981c701..074c33123 100644 --- a/LICENSE +++ b/LICENSE @@ -1,184 +1,23 @@ -This software is licensed under the LGPLv3, included below. - -As a special exception to the GNU Lesser General Public License version 3 -("LGPL3"), the copyright holders of this Library give you permission to -convey to a third party a Combined Work that links statically or dynamically -to this Library without providing any Minimal Corresponding Source or -Minimal Application Code as set out in 4d or providing the installation -information set out in section 4e, provided that you comply with the other -provisions of LGPL3 and provided that you meet, for the Application the -terms and conditions of the license(s) which apply to the Application. - -Except as stated in this special exception, the provisions of LGPL3 will -continue to comply in full to this Library. If you modify this Library, you -may apply this exception to your version of this Library, but you are not -obliged to do so. If you do not wish to do so, delete this exception -statement from your version. This exception does not (and cannot) modify any -license terms which apply to the Application, with which you must still -comply. - - GNU LESSER GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - - This version of the GNU Lesser General Public License incorporates -the terms and conditions of version 3 of the GNU General Public -License, supplemented by the additional permissions listed below. - - 0. Additional Definitions. - - As used herein, "this License" refers to version 3 of the GNU Lesser -General Public License, and the "GNU GPL" refers to version 3 of the GNU -General Public License. - - "The Library" refers to a covered work governed by this License, -other than an Application or a Combined Work as defined below. - - An "Application" is any work that makes use of an interface provided -by the Library, but which is not otherwise based on the Library. -Defining a subclass of a class defined by the Library is deemed a mode -of using an interface provided by the Library. - - A "Combined Work" is a work produced by combining or linking an -Application with the Library. The particular version of the Library -with which the Combined Work was made is also called the "Linked -Version". - - The "Minimal Corresponding Source" for a Combined Work means the -Corresponding Source for the Combined Work, excluding any source code -for portions of the Combined Work that, considered in isolation, are -based on the Application, and not on the Linked Version. - - The "Corresponding Application Code" for a Combined Work means the -object code and/or source code for the Application, including any data -and utility programs needed for reproducing the Combined Work from the -Application, but excluding the System Libraries of the Combined Work. - - 1. Exception to Section 3 of the GNU GPL. - - You may convey a covered work under sections 3 and 4 of this License -without being bound by section 3 of the GNU GPL. - - 2. Conveying Modified Versions. - - If you modify a copy of the Library, and, in your modifications, a -facility refers to a function or data to be supplied by an Application -that uses the facility (other than as an argument passed when the -facility is invoked), then you may convey a copy of the modified -version: - - a) under this License, provided that you make a good faith effort to - ensure that, in the event an Application does not supply the - function or data, the facility still operates, and performs - whatever part of its purpose remains meaningful, or - - b) under the GNU GPL, with none of the additional permissions of - this License applicable to that copy. - - 3. Object Code Incorporating Material from Library Header Files. - - The object code form of an Application may incorporate material from -a header file that is part of the Library. You may convey such object -code under terms of your choice, provided that, if the incorporated -material is not limited to numerical parameters, data structure -layouts and accessors, or small macros, inline functions and templates -(ten or fewer lines in length), you do both of the following: - - a) Give prominent notice with each copy of the object code that the - Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the object code with a copy of the GNU GPL and this license - document. - - 4. Combined Works. - - You may convey a Combined Work under terms of your choice that, -taken together, effectively do not restrict modification of the -portions of the Library contained in the Combined Work and reverse -engineering for debugging such modifications, if you also do each of -the following: - - a) Give prominent notice with each copy of the Combined Work that - the Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the Combined Work with a copy of the GNU GPL and this license - document. - - c) For a Combined Work that displays copyright notices during - execution, include the copyright notice for the Library among - these notices, as well as a reference directing the user to the - copies of the GNU GPL and this license document. - - d) Do one of the following: - - 0) Convey the Minimal Corresponding Source under the terms of this - License, and the Corresponding Application Code in a form - suitable for, and under terms that permit, the user to - recombine or relink the Application with a modified version of - the Linked Version to produce a modified Combined Work, in the - manner specified by section 6 of the GNU GPL for conveying - Corresponding Source. - - 1) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (a) uses at run time - a copy of the Library already present on the user's computer - system, and (b) will operate properly with a modified version - of the Library that is interface-compatible with the Linked - Version. - - e) Provide Installation Information, but only if you would otherwise - be required to provide such information under section 6 of the - GNU GPL, and only to the extent that such information is - necessary to install and execute a modified version of the - Combined Work produced by recombining or relinking the - Application with a modified version of the Linked Version. (If - you use option 4d0, the Installation Information must accompany - the Minimal Corresponding Source and Corresponding Application - Code. If you use option 4d1, you must provide the Installation - Information in the manner specified by section 6 of the GNU GPL - for conveying Corresponding Source.) - - 5. Combined Libraries. - - You may place library facilities that are a work based on the -Library side by side in a single library together with other library -facilities that are not Applications and are not covered by this -License, and convey such a combined library under terms of your -choice, if you do both of the following: - - a) Accompany the combined library with a copy of the same work based - on the Library, uncombined with any other library facilities, - conveyed under the terms of this License. - - b) Give prominent notice with the combined library that part of it - is a work based on the Library, and explaining where to find the - accompanying uncombined form of the same work. - - 6. Revised Versions of the GNU Lesser General Public License. - - The Free Software Foundation may publish revised and/or new versions -of the GNU Lesser General Public License from time to time. Such new -versions will be similar in spirit to the present version, but may -differ in detail to address new problems or concerns. - - Each version is given a distinguishing version number. If the -Library as you received it specifies that a certain numbered version -of the GNU Lesser General Public License "or any later version" -applies to it, you have the option of following the terms and -conditions either of that published version or of any later version -published by the Free Software Foundation. If the Library as you -received it does not specify a version number of the GNU Lesser -General Public License, you may choose any version of the GNU Lesser -General Public License ever published by the Free Software Foundation. - - If the Library as you received it specifies that a proxy can decide -whether future versions of the GNU Lesser General Public License shall -apply, that proxy's public statement of acceptance of any version is -permanent authorization for you to choose that version for the -Library. \ No newline at end of file +MIT License + +Copyright (C) The GNU Radio Authors +Copyright (C) Contributors to the GNU Radio Project +Copyright (C) FAIR - Facility for Antiproton & Ion Research, Darmstadt, Germany + +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. diff --git a/README.md b/README.md index 6d8c64244..349cbba54 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,13 @@

-[![License](https://img.shields.io/badge/License-LGPL%203.0-blue.svg)](https://opensource.org/licenses/LGPL-3.0) -![CMake](https://github.com/fair-acc/gnuradio4/workflows/CMake/badge.svg) +[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) +[![CI](https://github.com/fair-acc/gnuradio4/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/fair-acc/gnuradio4/actions/workflows/ci.yml) + + + [![All Contributors](https://img.shields.io/badge/all_contributors-15-orange.svg?style=flat-square)](#contributors-) + # GNU Radio 4.0 prototype @@ -106,13 +110,14 @@ describe how to set up a local development environment. ## License and Copyright -Unless otherwise noted: SPDX-License-Identifier: LGPL-3.0-linking-exception -All code contributions to GNU Radio will be integrated into a library under the LGPL, ensuring it remains free/libre (FLOSS) for both personal and commercial use, without further constraints on either. -For details on how to contribute, please consult: [CONTRIBUTING.md](CONTRIBUTING.md) +Unless otherwise noted: SPDX-License-Identifier: MIT
+All code contributions to GNU Radio core and runtime will be integrated into a library under the MIT, ensuring it remains free/libre (FLOSS) for both personal and commercial use, without further constraints on either. GNU Radio also allows for individual block libraries to be licensed as GPLv3. +For details on these distinctions and how to contribute, please consult: [CONTRIBUTING.md](CONTRIBUTING.md) + +Copyright (C) The GNU Radio Authors
+Copyright (C) Contributors to the GNU Radio Project
+Copyright (C) FAIR - Facility for Antiproton & Ion Research, Darmstadt, Germany
-Copyright (C) 2001-September 2020 GNU Radio Project -- managed by Free Software Foundation, Inc. -Copyright (C) September 2020-2024 GNU Radio Project -- managed by SETI Institute -Copyright (C) 2018-2024 FAIR -- Facility for Antiproton & Ion Research, Darmstadt, Germany ## Acknowledgements diff --git a/core/include/gnuradio-4.0/Plugin.hpp b/core/include/gnuradio-4.0/Plugin.hpp index ae35436d8..8c6e61f47 100644 --- a/core/include/gnuradio-4.0/Plugin.hpp +++ b/core/include/gnuradio-4.0/Plugin.hpp @@ -66,7 +66,7 @@ class plugin : public gr_plugin_base { * - plugin version * * Example usage: - * GR_PLUGIN("Good Base Plugin", "Unknown", "LGPL3", "v1") + * GR_PLUGIN("Good Base Plugin", "Unknown", "MIT", "v1") */ #define GR_PLUGIN(Name, Author, License, Version) \ gr::plugin<>& grPluginInstance() { \ diff --git a/core/test/plugins/good_base_plugin.cpp b/core/test/plugins/good_base_plugin.cpp index 52a9a345d..d2f24b498 100644 --- a/core/test/plugins/good_base_plugin.cpp +++ b/core/test/plugins/good_base_plugin.cpp @@ -1,6 +1,6 @@ #include "good_base_plugin.hpp" -GR_PLUGIN("Good Base Plugin", "Unknown", "LGPL3", "v1") +GR_PLUGIN("Good Base Plugin", "Unknown", "MIT", "v1") namespace bts = gr::traits::block; diff --git a/core/test/plugins/good_conversion_plugin.cpp b/core/test/plugins/good_conversion_plugin.cpp index 6bd82f4e7..30e3be823 100644 --- a/core/test/plugins/good_conversion_plugin.cpp +++ b/core/test/plugins/good_conversion_plugin.cpp @@ -3,7 +3,7 @@ #include #include -GR_PLUGIN("Good Conversion Plugin", "Unknown", "LGPL3", "v1") +GR_PLUGIN("Good Conversion Plugin", "Unknown", "MIT", "v1") namespace good { diff --git a/core/test/plugins/good_math_plugin.cpp b/core/test/plugins/good_math_plugin.cpp index c283ec20f..295ee8b36 100644 --- a/core/test/plugins/good_math_plugin.cpp +++ b/core/test/plugins/good_math_plugin.cpp @@ -3,7 +3,7 @@ #include -GR_PLUGIN("Good Math Plugin", "Unknown", "LGPL3", "v1") +GR_PLUGIN("Good Math Plugin", "Unknown", "MIT", "v1") namespace good {