summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-10-26 08:50:36 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-10-26 14:56:18 +0000
commit577eadd37353222627f94691fe4a7cd274a26999 (patch)
treedff6e86410ca010ee1788fabb25699802efb66a0
parent6594c312ab272a701c292a1fc3520129923d083c (diff)
downloadpoky-577eadd37353222627f94691fe4a7cd274a26999.tar.gz
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 <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.rst35
1 files 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:
114872. Refer to the README in meta-spdxscanner to setup the environment (e.g, 114872. Refer to the README in meta-spdxscanner to setup the environment (e.g,
11488 setup a fossology server) needed for the scanner. 11488 setup a fossology server) needed for the scanner.
11489 11489
114903. Meta-spdxscanner provids several methods within the bbclass to create spdx files. 114903. Meta-spdxscanner provides several methods within the bbclass to create spdx files.
11491 Please choose one that you want to use and enable the spdx task. You have to 11491 Please choose one that you want to use and enable the spdx task. You have to
11492 add some config options in 11492 add some config options in ``local.conf`` file in your :term:`Build
11493``local.conf`` file in your 11493 Directory`. The following is an example showing how to generate spdx files
11494:term:`Build Directory`. 11494 during bitbake using the fossology-python.bbclass::
11495The following is an example showing how to generate spdx files during bitbake 11495
11496using the fossology-python.bbclass: 11496 # Selet fossology-python.bbclass.
11497:: 11497 INHERIT += "fossology-python"
11498 11498 # For fossology-python.bbclass, TOKEN is necessary, so, after setup a
11499 # Selet fossology-python.bbclass. 11499 # Fossology server, you have to create a token.
11500 INHERIT += "fossology-python" 11500 TOKEN = "eyJ0eXAiO..."
11501 # For fossology-python.bbclass, TOKEN is necessary, so, after setup a 11501 # The fossology server is necessary for fossology-python.bbclass.
11502 # Fossology server, you have to create a token. 11502 FOSSOLOGY_SERVER = "http://xx.xx.xx.xx:8081/repo"
11503 TOKEN = "eyJ0eXAiO..." 11503 # If you want to upload the source code to a special folder:
11504 # The fossology server is necessary for fossology-python.bbclass. 11504 FOLDER_NAME = "xxxx" //Optional
11505 FOSSOLOGY_SERVER = "http://xx.xx.xx.xx:8081/repo" 11505 # If you don't want to put spdx files in tmp/deploy/spdx, you can enable:
11506 # If you want to upload the source code to a special folder: 11506 SPDX_DEPLOY_DIR = "${DeployDir}" //Optional
11507 FOLDER_NAME = "xxxx" //Optional
11508 # If you don't want to put spdx files in tmp/deploy/spdx, you can enable:
11509 SPDX_DEPLOY_DIR = "${DeployDir}" //Optional
11510 11507
11511For more usage information on meta-spdxscanner, refer to the repsoitory which you can find at: 11508For more usage information on meta-spdxscanner, refer to the repsoitory which you can find at:
11512https://git.yoctoproject.org/cgit/cgit.cgi/meta-spdxscanner/. 11509https://git.yoctoproject.org/cgit/cgit.cgi/meta-spdxscanner/.