[LicenseSettings]
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
The group [LicenseSettings] of settings/package.ini.
File
settings/package.ini; override it in settings/override/package.ini.append.php, in a siteaccess or in an extension.
Settings
| Setting | Default | Description |
|---|---|---|
| DefaultLicense | GPL-2.0-or-later | The licenses a package can be given in the package creation wizards (Setup > Packages > Create new package, every creator's "Package information" step). The license is a strict choice from this list: the step shows a drop-down and refuses any value that is not listed here. The value stored in a package's package.xml (<licence>) is the license's identifier. Use the SPDX identifier where one exists (https://spdx.org/licenses/), otherwise an SPDX style "LicenseRef-<name>" identifier. The identifier chosen when the step opens. Must be one of LicenseList. |
| GroupList[] | software; documentation; cc-4.0; cc-3.0; cc-2.5; cc-2.0; cc-1.0; public-domain; proprietary | The drop-down's groups (<optgroup>), in the order shown. Each group has a [LicenseGroup_<group>] block with Name=, the group's heading. A license whose Group= is not listed here is shown under "Other licenses" at the end. |
| LicenseList[] | GPL-2.0-or-later; GPL-2.0-only; GPL-3.0-or-later; GPL-3.0-only; LGPL-2.1-or-later; LGPL-2.1-only; LGPL-3.0-or-later; LGPL-3.0-only; AGPL-3.0-or-later; AGPL-3.0-only; MIT; GFDL-1.3-or-later; GFDL-1.3-only; CC-BY-4.0; CC-BY-SA-4.0; CC-BY-ND-4.0; CC-BY-NC-4.0; CC-BY-NC-SA-4.0; CC-BY-NC-ND-4.0; CC-BY-3.0; CC-BY-SA-3.0; CC-BY-ND-3.0; CC-BY-NC-3.0; CC-BY-NC-SA-3.0; CC-BY-NC-ND-3.0; CC-BY-2.5; ... | The licenses that can be chosen, in the order shown within their group. Each one has a [License_<identifier>] block: Name= the license's official name (shown as it is, not translated) URL= the official page of the license Group= the group it is listed under (see GroupList) Description= optional, a short text shown below the drop-down To add a license, in settings/override/package.ini.append.php: [LicenseSettings] LicenseList[]=Apache-2.0 [License_Apache-2.0] Name=Apache License 2.0 URL=https://www.apache.org/licenses/LICENSE-2.0 Group=software To replace the whole list, start with an empty LicenseList[] line in the override and list only the licenses you want (and set DefaultLicense to one of them). |
| AliasList[<key>] | GPL=GPL-2.0-or-later | Other names a stored license is known by, mapped to a LicenseList identifier. Packages made before the license became a choice store "GPL", which always meant the GNU GPL version 2 or (at your option) any later version, the license of Exponential itself. An alias is shown as the license it stands for, and a posted alias is stored as that license's identifier. |
See also
Generated example: package.ini [LicenseSettings]
Added to the reference for Exponential 6.0.15: the 4.x reference had no page for this group. The descriptions are the comment lines of settings/package.ini.
Contributors
- Graham Brookins Updated
Comments
Add a comment