diff options
author | Roland Hieber <rhi@pengutronix.de> | 2021-08-06 12:44:01 +0200 |
---|---|---|
committer | Michael Olbrich <m.olbrich@pengutronix.de> | 2021-08-06 12:57:31 +0200 |
commit | 76d1f680233955839298435e9faf11f15434b4a4 (patch) | |
tree | f7f88b8ddd75fc064f0b2f1b969601d4116419f5 /doc/dev_add_new_pkgs.rst | |
parent | b64dea50daad0fa64dec356dd8865464c86e3ee8 (diff) | |
download | ptxdist-76d1f680233955839298435e9faf11f15434b4a4.tar.gz ptxdist-76d1f680233955839298435e9faf11f15434b4a4.tar.xz |
doc: working with licensing information in packages
Co-authored-by: Felicitas Jung <f.jung@pengutronix.de>
Signed-off-by: Felicitas Jung <f.jung@pengutronix.de>
Signed-off-by: Roland Hieber <rhi@pengutronix.de>
Message-Id: <20210806104401.12401-1-rhi@pengutronix.de>
Signed-off-by: Michael Olbrich <m.olbrich@pengutronix.de>
Diffstat (limited to 'doc/dev_add_new_pkgs.rst')
-rw-r--r-- | doc/dev_add_new_pkgs.rst | 46 |
1 files changed, 1 insertions, 45 deletions
diff --git a/doc/dev_add_new_pkgs.rst b/doc/dev_add_new_pkgs.rst index 3506436d7..6b1248563 100644 --- a/doc/dev_add_new_pkgs.rst +++ b/doc/dev_add_new_pkgs.rst @@ -248,6 +248,7 @@ PTXdist specific. What does it mean: - ``*_LICENSE`` enables the user to get a list of licenses she/he is using in her/his project (licenses of the enabled packages). + See :ref:`licensing_in_packages` below for detailed information. After enabling the menu entry, we can start to check the *get* and *extract* stages, calling them manually one after another. @@ -603,48 +604,3 @@ to do (even if its boring and takes time): This will re-start with a **clean** BSP and builds exactly the new package and its (known) dependencies. If this builds successfully as well we are really done with the new package. - -Some Notes about Licenses -~~~~~~~~~~~~~~~~~~~~~~~~~ - -The already mentioned rule variable ``*_LICENSE`` (e.g. ``FOO_LICENSE`` in our -example) is very important and must be filled by the developer of the package. -Many licenses bring in obligations using the corresponding package (*attribution* -for example). To make life easier for everybody the license for a package must -be provided. *SPDX* license identifiers unify the license names and are used -in PTXdist to identify license types and obligations. - -If a package comes with more than one license, all of their SPDX identifiers -must be listed and connected with the keyword ``AND``. If your package comes -with GPL-2.0 and LGPL-2.1 licenses, the definition should look like this: - -.. code-block:: make - - FOO_LICENSE := GPL-2.0 AND LGPL-2.1 - -One specific obligation cannot be detected examining the SPDX license identifiers -by PTXdist: *the license choice*. In this case all licenses of choice must be -listed and connected by the keyword ``OR``. - -If, for example, your obligation is to select one of the licenses *GPL-2.0* **or** -*GPL-3.0*, the ``*_LICENSE`` variable should look like this: - -.. code-block:: make - - FOO_LICENSE := GPL-2.0 OR GPL-3.0 - -SPDX License Identifiers -^^^^^^^^^^^^^^^^^^^^^^^^ - -A list of SPDX license identifiers can be found here: - - https://spdx.org/licenses/ - -Help to Detect the Correct License -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -License identification isn't trivial. A help in doing so can be the following -repository and its content. It contains a list of known licenses based on their -SPDX identifier. The content is without formatting to simplify text search. - - https://github.com/spdx/license-list-data/tree/master/text |