From c7e06033bbd074b973f57a37cdc752649ca5eb61 Mon Sep 17 00:00:00 2001 From: leimaohui Date: Mon, 12 Oct 2020 12:42:53 +0900 Subject: docs: Updated the status of spdx module. - Deleted content about old spdx.bbclass. - Added usage of meta-spdxscanner. (From yocto-docs rev: 59908cecb5283ebdea1800c4d86a6310a45159bf) Signed-off-by: Lei Maohui Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-common-tasks.rst | 38 ++++++++++++++++++++++ documentation/ref-manual/ref-classes.rst | 13 -------- documentation/ref-manual/ref-tasks.rst | 14 -------- 3 files changed, 38 insertions(+), 27 deletions(-) (limited to 'documentation') diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst index 43fe972ef4..943180296c 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.rst +++ b/documentation/dev-manual/dev-manual-common-tasks.rst @@ -11401,6 +11401,8 @@ to be covered by assuming that three main areas of concern exist: - Compilation scripts and modifications to the source code must be provided. +- spdx files can be provided. + There are other requirements beyond the scope of these three and the methods described in this section (e.g. the mechanism through which source code is distributed). @@ -11595,6 +11597,42 @@ layers (recipes, configuration files, and so forth) enables you to meet your requirements to include the scripts to control compilation as well as any modifications to the original source. +Providing spdx files +~~~~~~~~~~~~~~~~~~~~~~~~~ + +The spdx module has been integrated to a layer named meta-spdxscanner. +meta-spdxscanner provides several kinds of scanner. If you want to enable +this function, you have to follow the following steps: + +1. Add meta-spdxscanner layer into ``bblayers.conf``. + +2. Refer to the README in meta-spdxscanner to setup the environment (e.g, + setup a fossology server) needed for the scanner. + +3. Meta-spdxscanner provids several methods within the bbclass to create spdx files. + Please choose one that you want to use and enable the spdx task. You have to + add some config options in +``local.conf`` file in your +:term:`Build Directory`. +The following is an example showing how to generate spdx files during bitbake +using the fossology-python.bbclass: +:: + + # Selet fossology-python.bbclass. + INHERIT += "fossology-python" + # For fossology-python.bbclass, TOKEN is necessary, so, after setup a + # Fossology server, you have to create a token. + TOKEN = "eyJ0eXAiO..." + # The fossology server is necessary for fossology-python.bbclass. + FOSSOLOGY_SERVER = "http://xx.xx.xx.xx:8081/repo" + # If you want to upload the source code to a special folder: + FOLDER_NAME = "xxxx" //Optional + # If you don't want to put spdx files in tmp/deploy/spdx, you can enable: + SPDX_DEPLOY_DIR = "${DeployDir}" //Optional + +For more usage information on meta-spdxscanner, refer to the repsoitory which you can find at: +https://git.yoctoproject.org/cgit/cgit.cgi/meta-spdxscanner/. + Copying Licenses that Do Not Exist ---------------------------------- diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/ref-classes.rst index 756df2a60f..7277c6bb9d 100644 --- a/documentation/ref-manual/ref-classes.rst +++ b/documentation/ref-manual/ref-classes.rst @@ -2380,19 +2380,6 @@ Autotools automatically picks up. The class also provides variables like ``SITEINFO_ENDIANNESS`` and ``SITEINFO_BITS`` that can be used elsewhere in the metadata. -.. _ref-classes-spdx: - -``spdx.bbclass`` -================ - -The ``spdx`` class integrates real-time license scanning, generation of -SPDX standard output, and verification of license information during the -build. - -.. note:: - - This class is currently at the prototype stage in the 1.6 release. - .. _ref-classes-sstate: ``sstate.bbclass`` diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst index 2569306fc5..ea145644f7 100644 --- a/documentation/ref-manual/ref-tasks.rst +++ b/documentation/ref-manual/ref-tasks.rst @@ -859,17 +859,3 @@ sure that the machine and metadata branches as specified by the branches. If these branches do not exist and :term:`AUTOREV` is not being used, the ``do_validate_branches`` task fails during the build. - -Miscellaneous Tasks -=================== - -The following sections describe miscellaneous tasks. - -.. _ref-tasks-spdx: - -``do_spdx`` ------------ - -A build stage that takes the source code and scans it on a remote -FOSSOLOGY server in order to produce an SPDX document. This task applies -only to the :ref:`spdx ` class. -- cgit v1.2.3-54-g00ecf