From 577eadd37353222627f94691fe4a7cd274a26999 Mon Sep 17 00:00:00 2001 From: Nicolas Dechesne Date: Mon, 26 Oct 2020 08:50:36 +0100 Subject: dev-manual/dev-manual-common-tasks: fix warning A new warning was introduced in 59908cecb528 (docs: Updated the status of spdx module.) The code-block section belongs to the #3 item in the enumerated list. While at it, also fixed a typo in the text. (From yocto-docs rev: 0e301503883222da702e2418404ee6f04a25dbc1) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-common-tasks.rst | 35 ++++++++++------------ 1 file changed, 16 insertions(+), 19 deletions(-) diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst index dedc30d7d3..e1ee03da8d 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.rst +++ b/documentation/dev-manual/dev-manual-common-tasks.rst @@ -11487,26 +11487,23 @@ this function, you have to follow the following steps: 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. +3. Meta-spdxscanner provides 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 + 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/. -- cgit v1.2.3-54-g00ecf