diff --git a/docs/en/contribute/copyright-guide.rst b/docs/en/contribute/copyright-guide.rst index 3f84b4e54b8..37387176326 100644 --- a/docs/en/contribute/copyright-guide.rst +++ b/docs/en/contribute/copyright-guide.rst @@ -1,6 +1,8 @@ Copyright Header Guide ====================== +.. highlight:: c + ESP-IDF is released under :project_file:`the Apache License 2.0 ` with some additional third-party copyrighted code released under various licenses. For further information please refer to :doc:`the list of copyrights and licenses <../../../COPYRIGHT>`. This page explains how the source code should be properly marked with a copyright header. ESP-IDF uses `The Software Package Data Exchange (SPDX) `_ format which is short and can be easily read by humans or processed by automated tools for copyright checks. @@ -23,7 +25,7 @@ Common Examples of Copyright Headers The simplest case is when the code is not based on any licensed previous work, e.g. it was written completely from scratch. Such code can be decorated with the following copyright header and put under the license of ESP-IDF:: /* - * SPDX-FileCopyrightText: 2015-2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2015-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -34,7 +36,7 @@ Less restrictive parts of ESP-IDF Some parts of ESP-IDF are deliberately under less restrictive licenses in order to ease their re-use in commercial closed source projects. This is the case for :project:`ESP-IDF examples ` which are in Public domain or under the Creative Commons Zero Universal (CC0) license. The following header can be used in such source files:: /* - * SPDX-FileCopyrightText: 2015-2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2015-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Unlicense OR CC0-1.0 */ @@ -53,12 +55,33 @@ The following example is a suitable header for a code licensed under the "GNU Ge * * SPDX-License-Identifier: GPL-2.0-or-later * - * SPDX-FileContributor: 2019-2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileContributor: 2019-2023 Espressif Systems (Shanghai) CO LTD + */ + +The licenses can be identified and the short SPDX identifiers can be found in the official `SPDX license list`_. Other very common licenses are the GPL-2.0-only, the BSD-3-Clause, and the BSD-2-Clause. + +In exceptional case, when a license is not present on the `SPDX license list`_, it can be expressed by using the `LicenseRef-[idString]`_ custom license identifier, for example ``LicenseRef-Special-License``. The full license text must be added into the ``LICENSES`` directory under ``Special-License`` filename. :: + + /* + * SPDX-FileCopyrightText: 2015-2023 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: LicenseRef-Special-License */ -The licenses can be identified and the short SPDX identifiers can be found in the official `SPDX license list `_. Other very common licenses are the GPL-2.0-only, the BSD-3-Clause, and the BSD-2-Clause. +Dedicated ``LicenseRef-Included`` custom license identifier can be used to express a situation when the custom license is included directly in the source file. :: + + /* + * SPDX-FileCopyrightText: 2015-2023 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: LicenseRef-Included + * + * + */ The configuration stored in ``tools/ci/check_copyright_config.yaml`` offers features useful for third party licenses: * A different license can be defined for the files part of a third party library. * The check for a selected set of files can be permanently disabled. Please use this option with care and only in cases when none of the other options are suitable. + +.. _SPDX license list: https://spdx.org/licenses +.. _LicenseRef-[idString]: https://spdx.github.io/spdx-spec/v2.3/other-licensing-information-detected/#101-license-identifier-field diff --git a/examples/zigbee/esp_zigbee_gateway/main/esp_zigbee_gateway.c b/examples/zigbee/esp_zigbee_gateway/main/esp_zigbee_gateway.c index b1c7d4a318d..a1b8bbe0774 100644 --- a/examples/zigbee/esp_zigbee_gateway/main/esp_zigbee_gateway.c +++ b/examples/zigbee/esp_zigbee_gateway/main/esp_zigbee_gateway.c @@ -1,7 +1,7 @@ /* - * Copyright (c) 2021 Espressif Systems (Shanghai) CO LTD - * All rights reserved. + * SPDX-FileCopyrightText: 2021-2023 Espressif Systems (Shanghai) CO LTD * + * SPDX-License-Identifier: LicenseRef-Included * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: diff --git a/examples/zigbee/esp_zigbee_gateway/main/esp_zigbee_gateway.h b/examples/zigbee/esp_zigbee_gateway/main/esp_zigbee_gateway.h index 06268f76203..4c22871a385 100644 --- a/examples/zigbee/esp_zigbee_gateway/main/esp_zigbee_gateway.h +++ b/examples/zigbee/esp_zigbee_gateway/main/esp_zigbee_gateway.h @@ -1,7 +1,7 @@ /* - * Copyright (c) 2021 Espressif Systems (Shanghai) CO LTD - * All rights reserved. + * SPDX-FileCopyrightText: 2021-2023 Espressif Systems (Shanghai) CO LTD * + * SPDX-License-Identifier: LicenseRef-Included * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: diff --git a/examples/zigbee/esp_zigbee_rcp/main/esp_zigbee_rcp.c b/examples/zigbee/esp_zigbee_rcp/main/esp_zigbee_rcp.c index fe96d9cee4b..966baf32df1 100644 --- a/examples/zigbee/esp_zigbee_rcp/main/esp_zigbee_rcp.c +++ b/examples/zigbee/esp_zigbee_rcp/main/esp_zigbee_rcp.c @@ -1,7 +1,7 @@ /* - * Copyright (c) 2021 Espressif Systems (Shanghai) CO LTD - * All rights reserved. + * SPDX-FileCopyrightText: 2021-2023 Espressif Systems (Shanghai) CO LTD * + * SPDX-License-Identifier: LicenseRef-Included * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: diff --git a/examples/zigbee/esp_zigbee_rcp/main/esp_zigbee_rcp.h b/examples/zigbee/esp_zigbee_rcp/main/esp_zigbee_rcp.h index c59bd98d81f..50f708a5412 100644 --- a/examples/zigbee/esp_zigbee_rcp/main/esp_zigbee_rcp.h +++ b/examples/zigbee/esp_zigbee_rcp/main/esp_zigbee_rcp.h @@ -1,7 +1,7 @@ /* - * Copyright (c) 2021 Espressif Systems (Shanghai) CO LTD - * All rights reserved. + * SPDX-FileCopyrightText: 2021-2023 Espressif Systems (Shanghai) CO LTD * + * SPDX-License-Identifier: LicenseRef-Included * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: diff --git a/examples/zigbee/light_sample/HA_on_off_light/main/esp_zb_light.c b/examples/zigbee/light_sample/HA_on_off_light/main/esp_zb_light.c index d4e2a2501e6..0c38d7d8707 100644 --- a/examples/zigbee/light_sample/HA_on_off_light/main/esp_zb_light.c +++ b/examples/zigbee/light_sample/HA_on_off_light/main/esp_zb_light.c @@ -1,7 +1,7 @@ /* - * Copyright (c) 2021 Espressif Systems (Shanghai) CO LTD - * All rights reserved. + * SPDX-FileCopyrightText: 2021-2023 Espressif Systems (Shanghai) CO LTD * + * SPDX-License-Identifier: LicenseRef-Included * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: diff --git a/examples/zigbee/light_sample/HA_on_off_light/main/esp_zb_light.h b/examples/zigbee/light_sample/HA_on_off_light/main/esp_zb_light.h index 82c3b2bc770..e555e2ed111 100644 --- a/examples/zigbee/light_sample/HA_on_off_light/main/esp_zb_light.h +++ b/examples/zigbee/light_sample/HA_on_off_light/main/esp_zb_light.h @@ -1,7 +1,7 @@ /* - * Copyright (c) 2021 Espressif Systems (Shanghai) CO LTD - * All rights reserved. + * SPDX-FileCopyrightText: 2021-2023 Espressif Systems (Shanghai) CO LTD * + * SPDX-License-Identifier: LicenseRef-Included * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: diff --git a/examples/zigbee/light_sample/HA_on_off_light/main/light_driver.c b/examples/zigbee/light_sample/HA_on_off_light/main/light_driver.c index 2febb110930..72ff6b9e372 100644 --- a/examples/zigbee/light_sample/HA_on_off_light/main/light_driver.c +++ b/examples/zigbee/light_sample/HA_on_off_light/main/light_driver.c @@ -1,7 +1,7 @@ /* - * Copyright (c) 2021 Espressif Systems (Shanghai) CO LTD - * All rights reserved. + * SPDX-FileCopyrightText: 2021-2023 Espressif Systems (Shanghai) CO LTD * + * SPDX-License-Identifier: LicenseRef-Included * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: diff --git a/examples/zigbee/light_sample/HA_on_off_light/main/light_driver.h b/examples/zigbee/light_sample/HA_on_off_light/main/light_driver.h index 8fb07dd0d02..b9f734fdde8 100644 --- a/examples/zigbee/light_sample/HA_on_off_light/main/light_driver.h +++ b/examples/zigbee/light_sample/HA_on_off_light/main/light_driver.h @@ -1,7 +1,7 @@ /* - * Copyright (c) 2021 Espressif Systems (Shanghai) CO LTD - * All rights reserved. + * SPDX-FileCopyrightText: 2021-2023 Espressif Systems (Shanghai) CO LTD * + * SPDX-License-Identifier: LicenseRef-Included * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: diff --git a/examples/zigbee/light_sample/HA_on_off_switch/main/esp_zb_switch.c b/examples/zigbee/light_sample/HA_on_off_switch/main/esp_zb_switch.c index d51ae48aa06..3430f98423c 100644 --- a/examples/zigbee/light_sample/HA_on_off_switch/main/esp_zb_switch.c +++ b/examples/zigbee/light_sample/HA_on_off_switch/main/esp_zb_switch.c @@ -1,7 +1,7 @@ /* - * Copyright (c) 2021 Espressif Systems (Shanghai) CO LTD - * All rights reserved. + * SPDX-FileCopyrightText: 2021-2023 Espressif Systems (Shanghai) CO LTD * + * SPDX-License-Identifier: LicenseRef-Included * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: diff --git a/examples/zigbee/light_sample/HA_on_off_switch/main/esp_zb_switch.h b/examples/zigbee/light_sample/HA_on_off_switch/main/esp_zb_switch.h index 98f86bf7404..eeca2125b71 100644 --- a/examples/zigbee/light_sample/HA_on_off_switch/main/esp_zb_switch.h +++ b/examples/zigbee/light_sample/HA_on_off_switch/main/esp_zb_switch.h @@ -1,7 +1,7 @@ /* - * Copyright (c) 2021 Espressif Systems (Shanghai) CO LTD - * All rights reserved. + * SPDX-FileCopyrightText: 2021-2023 Espressif Systems (Shanghai) CO LTD * + * SPDX-License-Identifier: LicenseRef-Included * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: diff --git a/examples/zigbee/light_sample/HA_on_off_switch/main/switch_driver.c b/examples/zigbee/light_sample/HA_on_off_switch/main/switch_driver.c index 7b2435b0054..2acf388944e 100644 --- a/examples/zigbee/light_sample/HA_on_off_switch/main/switch_driver.c +++ b/examples/zigbee/light_sample/HA_on_off_switch/main/switch_driver.c @@ -1,7 +1,7 @@ /* - * Copyright (c) 2021 Espressif Systems (Shanghai) CO LTD - * All rights reserved. + * SPDX-FileCopyrightText: 2021-2023 Espressif Systems (Shanghai) CO LTD * + * SPDX-License-Identifier: LicenseRef-Included * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: diff --git a/examples/zigbee/light_sample/HA_on_off_switch/main/switch_driver.h b/examples/zigbee/light_sample/HA_on_off_switch/main/switch_driver.h index 67d431a9bc1..10d332cd6e1 100644 --- a/examples/zigbee/light_sample/HA_on_off_switch/main/switch_driver.h +++ b/examples/zigbee/light_sample/HA_on_off_switch/main/switch_driver.h @@ -1,7 +1,7 @@ /* - * Copyright (c) 2021 Espressif Systems (Shanghai) CO LTD - * All rights reserved. + * SPDX-FileCopyrightText: 2021-2023 Espressif Systems (Shanghai) CO LTD * + * SPDX-License-Identifier: LicenseRef-Included * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: diff --git a/tools/ci/check_copyright_config.yaml b/tools/ci/check_copyright_config.yaml index 1432a2662a5..9732dc3f28c 100644 --- a/tools/ci/check_copyright_config.yaml +++ b/tools/ci/check_copyright_config.yaml @@ -167,6 +167,13 @@ protocol_examples_common_component: - CC0-1.0 license_for_new_files: Unlicense OR CC0-1.0 +zigbee: + include: + - 'examples/zigbee/' + allowed_licenses: + - Apache-2.0 + - LicenseRef-Included + # files matching this section do not perform the check # file patterns starting with ! are negated, meaning files matching them won't match the section. ignore: @@ -182,7 +189,6 @@ ignore: - components/bt/host/bluedroid/ - '!components/bt/host/bluedroid/api/' - '!components/bt/host/bluedroid/btc/' - - examples/zigbee/ - components/esp_local_ctrl/proto-c/ - components/esp_local_ctrl/python/ - components/protocomm/proto-c/