Skip to content

Commit 4bbdacd

Browse files
committed
Merge branch 'docs/fix_license_field' into 'main'
docs: update `license` field in the manifest file Closes PACMAN-965 See merge request espressif/idf-component-manager!430
2 parents 0e51ac6 + f8a125e commit 4bbdacd

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/en/reference/manifest_file.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,13 @@ Example:
103103

104104
The license of the component. It has to be a valid SPDX license identifier listed in https://spdx.org/licenses/.
105105

106-
This field is optional.
106+
Either the ``license`` field or the ``LICENSE`` or ``LICENSE.txt`` file has to be present in the component directory.
107+
108+
The license type will be:
107109

108-
If not specified, and ``LICENSE`` or ``LICENSE.txt`` file exists, the license type will be parsed from the file. If the license type cannot be determined, it will be set to ``unknown``.
110+
- exactly the value of the ``license`` field if it is specified, or
111+
- parsed from the ``LICENSE`` or ``LICENSE.txt`` file while uploading, or
112+
- set to ``Custom`` if the license type cannot be determined.
109113

110114
Example:
111115

0 commit comments

Comments
 (0)