summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJuergen Borleis <jbe@pengutronix.de>2017-12-07 11:11:25 +0100
committerJuergen Borleis <jbe@pengutronix.de>2017-12-08 15:25:10 +0100
commit4a8d990cbfaba061e036590c8fb8d02be1d07229 (patch)
treea4bbed16ef75ffe93d6a36199f0efecd1d45ae50 /doc
parentefc0f900167e646b04726d39e29a35e502837e4f (diff)
downloadptxdist-4a8d990cbfaba061e036590c8fb8d02be1d07229.tar.gz
ptxdist-4a8d990cbfaba061e036590c8fb8d02be1d07229.tar.xz
Doc: add license related information
Dealing with licenses is very important...and really boring. This change gives some hints how to survive this task. Signed-off-by: Juergen Borleis <jbe@pengutronix.de>
Diffstat (limited to 'doc')
-rw-r--r--doc/dev_manual.rst45
-rw-r--r--doc/ref_manual.rst2
2 files changed, 46 insertions, 1 deletions
diff --git a/doc/dev_manual.rst b/doc/dev_manual.rst
index 75fd87763..05a0f6442 100644
--- a/doc/dev_manual.rst
+++ b/doc/dev_manual.rst
@@ -721,6 +721,51 @@ 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, alls 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://www.gnu.org/licenses/license-list.html#SoftwareLicenses
+
+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.git
+
Advanced Rule Files
~~~~~~~~~~~~~~~~~~~
diff --git a/doc/ref_manual.rst b/doc/ref_manual.rst
index 451268b9d..a316635ed 100644
--- a/doc/ref_manual.rst
+++ b/doc/ref_manual.rst
@@ -191,7 +191,7 @@ Package Definition
The license of the package. The SPDX license identifiers should be used
here. Use ``proprietary`` for proprietary packages and ``ignore`` for
packages without their own license, e.g. meta packages or packages that
- only install files from projectroot/.
+ only install files from ``projectroot/``.
``<PKG>_LICENSE_FILES``
A space separated list of URLs of license text files. The URLs must be