Skip to content

Commit cf91c1b

Browse files
doc: licensing: clarify the impact of the various files
Clarify the impact of the various non-Apache-2.0 licensed files in the tree. Clean up the formatting to improve readability and better match the other parts of the project documentation. Signed-off-by: Henrik Brix Andersen <[email protected]>
1 parent 8307900 commit cf91c1b

File tree

1 file changed

+93
-26
lines changed

1 file changed

+93
-26
lines changed

doc/LICENSING.rst

Lines changed: 93 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -10,42 +10,109 @@ are not covered by the `Apache 2.0 License`_. In some places
1010
there is no LICENSE file or way to put a LICENSE file there, so we describe the
1111
licensing in this document.
1212

13+
Continuous Integration Scripts
14+
------------------------------
15+
16+
* *Origin:* Linux Kernel
17+
* *Licensing:* `GPLv2 License`_
18+
* *Impact:* These files are used in Continuous Integration (CI) and never linked into the firmware.
19+
* *Files:*
20+
21+
* :zephyr_file:`scripts/checkpatch.pl`
22+
* :zephyr_file:`scripts/checkstack.pl`
23+
* :zephyr_file:`scripts/spelling.txt`
24+
25+
Coccinelle Scripts
26+
------------------
27+
28+
* *Origin:* Coccinelle
29+
* *Licensing:* `GPLv2 License`_
30+
* *Impact:* These files are used by `Coccinelle`_, a tool for transforming C-code, and never linked
31+
into the firmware.
32+
* *Files:*
33+
34+
* :zephyr_file:`scripts/coccicheck`
35+
* :zephyr_file:`scripts/coccinelle/array_size.cocci`
36+
* :zephyr_file:`scripts/coccinelle/deref_null.cocci`
37+
* :zephyr_file:`scripts/coccinelle/deref_null.cocci`
38+
* :zephyr_file:`scripts/coccinelle/deref_null.cocci`
39+
* :zephyr_file:`scripts/coccinelle/mini_lock.cocci`
40+
* :zephyr_file:`scripts/coccinelle/mini_lock.cocci`
41+
* :zephyr_file:`scripts/coccinelle/mini_lock.cocci`
42+
* :zephyr_file:`scripts/coccinelle/noderef.cocci`
43+
* :zephyr_file:`scripts/coccinelle/noderef.cocci`
44+
* :zephyr_file:`scripts/coccinelle/returnvar.cocci`
45+
* :zephyr_file:`scripts/coccinelle/semicolon.cocci`
46+
47+
GCOV Coverage Header File
48+
-------------------------
49+
50+
* *Origin:* GCC, the GNU Compiler Collection
51+
* *Licensing:* `GPLv2 License`_ with Runtime Library Exception
52+
* *Impact:* This file is only linked into the firmware if :kconfig:option:`CONFIG_COVERAGE_GCOV` is
53+
enabled.
54+
* *Files:*
55+
56+
* :zephyr_file:`subsys/testsuite/coverage/coverage.h`
57+
58+
ENE KB1200_EVB Board OpenOCD Configuration
59+
------------------------------------------
60+
61+
* *Licensing:* `GPLv2 License`_
62+
* *Impact:* This file is used by `OpenOCD`_ when programming and debugging the :ref:`ene_kb1200_evb`
63+
board. It is never linked into the firmware.
64+
* *Files:*
65+
66+
* :zephyr_file:`boards/ene/kb1200_evb/support/openocd.cfg`
67+
68+
Thread-Metric RTOS Test Suite Source Files
69+
------------------------------------------
70+
71+
* *Origin:* ThreadX
72+
* *Licensing:* `MIT License`_
73+
* *Impact:* These files are only linked into the Thread-Metric RTOS Test Suite test firmware.
74+
* *Files:*
75+
76+
* :zephyr_file:`tests/benchmarks/thread_metric/thread_metric_readme.txt`
77+
* :zephyr_file:`tests/benchmarks/thread_metric/src/tm_api.h`
78+
* :zephyr_file:`tests/benchmarks/thread_metric/src/tm_basic_processing_test.c`
79+
* :zephyr_file:`tests/benchmarks/thread_metric/src/tm_cooperative_scheduling_test.c`
80+
* :zephyr_file:`tests/benchmarks/thread_metric/src/tm_interrupt_preemption_processing_test.c`
81+
* :zephyr_file:`tests/benchmarks/thread_metric/src/tm_interrupt_processing_test.c`
82+
* :zephyr_file:`tests/benchmarks/thread_metric/src/tm_memory_allocation_test.c`
83+
* :zephyr_file:`tests/benchmarks/thread_metric/src/tm_message_processing_test.c`
84+
* :zephyr_file:`tests/benchmarks/thread_metric/src/tm_porting_layer.h`
85+
* :zephyr_file:`tests/benchmarks/thread_metric/src/tm_porting_layer_zephyr.c`
86+
* :zephyr_file:`tests/benchmarks/thread_metric/src/tm_preemptive_scheduling_test.c`
87+
* :zephyr_file:`tests/benchmarks/thread_metric/src/tm_synchronization_processing_test.c`
88+
89+
OpenThread Spinel HDLC RCP Host Interface Files
90+
-----------------------------------------------
91+
92+
* *Origin:* OpenThread
93+
* *Licensing:* `BSD-3-clause`_
94+
* *Impact:* These files are only linked into the firmware if :kconfig:option:`CONFIG_HDLC_RCP_IF` is
95+
enabled.
96+
* *Files*:
97+
98+
* :zephyr_file:`modules/openthread/platform/hdlc_interface.hpp`
99+
* :zephyr_file:`modules/openthread/platform/radio_spinel.cpp`
100+
* :zephyr_file:`modules/openthread/platform/hdlc_interface.cpp`
101+
13102
.. _Apache 2.0 License:
14103
https://github.com/zephyrproject-rtos/zephyr/blob/main/LICENSE
15104

16105
.. _GPLv2 License:
17106
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/COPYING
18107

19-
*scripts/{checkpatch.pl,checkstack.pl,spelling.txt}*
20-
*Origin:* Linux Kernel
21-
22-
*Licensing:* `GPLv2 License`_
23-
24-
*scripts/{coccicheck,coccinelle/array_size.cocci,coccinelle/deref_null.cocci,coccinelle/deref_null.cocci,coccinelle/deref_null.cocci,coccinelle/mini_lock.cocci,coccinelle/mini_lock.cocci,coccinelle/mini_lock.cocci,coccinelle/noderef.cocci,coccinelle/noderef.cocci,coccinelle/returnvar.cocci,coccinelle/semicolon.cocci}*
25-
*Origin:* Coccinelle
26-
27-
*Licensing:* `GPLv2 License`_
28-
29-
*subsys/testsuite/coverage/coverage.h*
30-
*Origin:* GCC, the GNU Compiler Collection
31-
32-
*Licensing:* `GPLv2 License`_ with Runtime Library Exception
33-
34-
*boards/ene/kb1200_evb/support/openocd.cfg*
35-
*Licensing:* `GPLv2 License`_
36-
37108
.. _MIT License:
38109
https://opensource.org/licenses/MIT
39110

40-
*tests/benchmarks/thread_metric/{thread_metric_readme.txt,src/\*}*
41-
*Origin:* ThreadX
42-
43-
*Licensing:* `MIT License`_
44-
45111
.. _BSD-3-clause:
46112
https://opensource.org/license/bsd-3-clause
47113

48-
*modules/openthread/platform/{hdlc_interface.cpp,hdlc_interface.hpp,radio_spinel.cpp}*
49-
*Origin:* OpenThread
114+
.. _Coccinelle:
115+
https://coccinelle.gitlabpages.inria.fr/website/
50116

51-
*Licensing:* `BSD-3-clause`_
117+
.. _OpenOCD:
118+
https://openocd.org

0 commit comments

Comments
 (0)