Commit Graph

9 Commits

Author SHA1 Message Date
Marius Vikhammer
f1e65b8373 docs(misc): fixed typos found with codespell 2024-03-28 11:50:58 +08:00
Ren Pei Ying
3e1a6afb00 docs: add CN translation for contribute/esp-idf-tests-with-pytest.rst 2023-08-24 05:32:11 +08:00
Cai Xin Ying
bcb87c4b8f docs: update format issues for both EN and CN under security and contribute folder 2023-08-22 23:59:44 +08:00
renpeiying
e6d1e2437a docs: Provide CN translation for contribute/copyright-guide and install-pre-commit-hook 2023-08-07 11:55:30 +08:00
Frantisek Hrbata
8e893db5f3 docs: allow to use SPDX LicenseRef-[idstring] indentifier
In a very rare cases there is a need to use custom license, which is not
present on the SPDX list. Now, files under such license are added to the
check_copyright ignore list. For example zigbee examples introduced
by !16205. SPDX has a LicenseRef-[idstring] identifier[1] for such cases,
so let's try to use it in license representation[2]. The idea is that licenses
not on the SPDX list can be added into the LICENSES[3] directory and used as

	SPDX-License-Identifier: LicenseRef-Special-License

Or if the custom license is present directly in a source file we can use
a special LicenseRef-Included identifier to state that the license
is included.

	SPDX-License-Identifier: LicenseRef-Included

Please note that LicenseRef-Included is just a made up identifier to
state the fact that the license is included directly in the source file.
There is nothing in the SPDX spec about this usage.

This relatively small adjustment allows to refer to custom licenses
without a need to skip check_copyright for them.

[1] https://spdx.github.io/spdx-spec/v2.3/other-licensing-information-detected/#101-license-identifier-field
[2] https://spdx.github.io/spdx-spec/v2.3/using-SPDX-short-identifiers-in-source-files/#e4-representing-multiple-licenses
[3] https://reuse.software/spec/

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2023-02-02 08:21:47 +01:00
Marius Vikhammer
030cb77597 docs: update redirected links 2022-05-07 13:09:41 +08:00
Marius Vikhammer
93430c9eab docs: update copyright date for docs automatically 2022-01-10 15:05:33 +08:00
Roland Dobai
513a9b18a3 Docs: Update the copyright contribution guide with new options of the checker
Document additional options introduced by 228113a399.
2021-12-08 12:17:24 +01:00
Roland Dobai
4d149f070c Docs: Add copyright header guide for contributions 2021-11-04 11:55:26 +01:00