diff options
Diffstat (limited to 'external/meta-spdxscanner/README.md')
| -rw-r--r-- | external/meta-spdxscanner/README.md | 32 |
1 files changed, 9 insertions, 23 deletions
diff --git a/external/meta-spdxscanner/README.md b/external/meta-spdxscanner/README.md index a41f8216..bc8da8d8 100644 --- a/external/meta-spdxscanner/README.md +++ b/external/meta-spdxscanner/README.md @@ -1,12 +1,9 @@ -# This repository has been moved to http://git.yoctoproject.org/cgit/cgit.cgi/meta-spdxscanner/. - # meta-spdxscanner meta-spdxscanner supports the following SPDX create tools. 1. fossology REST API (Can work with fossology after 3.5.0) 2. fossdriver (Can work with fossology) 3. scancode-toolkit -4. DoSOCSv2 (Scanner comes from fossology 3.4.0) # This layer supplys invoking scanners as following: @@ -18,11 +15,7 @@ meta-spdxscanner supports the following SPDX create tools. 3. scancode-toolkit - openembedded-core - -4. DoSOCSv2 -- openembedded-core -- meta-openembedded/meta-oe -- meta-openembedded/meta-python +- meta-python2 # How to use @@ -33,8 +26,9 @@ meta-spdxscanner supports the following SPDX create tools. ``` INHERIT += "fossology-rest" TOKEN = "eyJ0eXAiO..." - FOSSOLOGY_SERVER = "http://xx.xx.xx.xx:8081/repo" //Optional,by default, it is http://127.0.0.1:8081/repo - FOLDER_NAME = "xxxx" //Optional,by default, it is the top folder "Software Repository"(folderId=1). + FOSSOLOGY_SERVER = "http://xx.xx.xx.xx:8081/repo" //Optional, by default, it is http://127.0.0.1:8081/repo + FOLDER_NAME = "xxxx" //Optional, by default, it is the top folder "Software Repository"(folderId=1). + SPDX_DEPLOY_DIR = "${DeployDir}" //Optional, by default, spdx files will be deployed to ${BUILD_DIR}/tmp/deploy/spdx/ ``` Note - If you want to use fossology-rest.bbclass, you have to make sure that fossology server on your host and make sure it works well. @@ -48,32 +42,24 @@ Note ``` INHERIT += "fossdriver-host" + SPDX_DEPLOY_DIR = "${DeployDir}" //Optional, by default, spdx files will be deployed to ${BUILD_DIR}/tmp/deploy/spdx/ ``` Note - If you want to use fossdriver-host.bbclass, you have to make sure that fossology server and fossdriver has been installed on your host and make sure it works well. Please reference to https://hub.docker.com/r/fossology/fossology/ and https://github.com/fossology/fossdriver. - Please use meta-spdxscanner/classes/nopackages.bbclass instead of oe-core. Because there is no necessary to create spdx files for *-native. -3. scancode.bbclass +3. scancode-tk.bbclass - inherit the folowing class in your conf/local.conf for all of recipes or in some recipes which you want. ``` INHERIT += "scancode-tk" + SPDX_DEPLOY_DIR = "${DeployDir}" //Optional, by default, spdx files will be deployed to ${BUILD_DIR}/tmp/deploy/spdx/ + ``` Note +- scancode-tk has to install on host development system, so, make sure the version of python on host development system is 3.6. - If you want to use scancode.bbclass, There is no need to install anything on your host. - To aviod loop dependence,please use meta-spdxscanner/classes/nopackages.bbclass instead the file comes from oe-core. - -4. dosocs.bbclass -- inherit the folowing class in your conf/local.conf for all of recipes or - in some recipes which you want. - -``` - INHERIT += "dosocs" -``` -Note -- There is no necessary to install any OSS on host. -- Please use meta-spdxscanner/classes/nopackages.bbclass instead of oe-core. Because there is no necessary to create spdx files for *-native. -- Default, DoSOCSv2 uses SQLite for database, so dosocs.bbclass doesn't support multi tasks of do_spdx. |