diff options
| -rw-r--r-- | README.md | 37 |
1 files changed, 9 insertions, 28 deletions
@@ -1,29 +1,25 @@ # 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) +1. fossology python REST API +2. fossology REST API (by curl) 3. scancode-toolkit # This layer supplys invoking scanners as following: -1. python wrapper for Fossology REST API.(https://github.com/fossology/fossology-python) +1. fossology-python.bbclass (https://github.com/fossology/fossology-python) - openembedded-core - meta-oe/meta-python - meta-oe/meta-oe - meta-oe/meta-webserver -2. python wrapper for fossology REST API +2. fossology-rest.bbclass - openembedded-core - meta-oe/meta-python -3. fossdriver(https://github.com/fossology/fossdriver) +3. scancode-tk.bbclass (https://github.com/oss-review-toolkit/ort) - openembedded-core -4. scancode-toolkit(https://github.com/oss-review-toolkit/ort) -- openembedded-core -- meta-python2 - # How to use 1. fossology-python.bbclass @@ -33,6 +29,8 @@ meta-spdxscanner supports the following SPDX create tools. ``` INHERIT += "fossology-python" TOKEN = "eyJ0eXAiO..." + WAIT_TIME = "..." //Optional, by default, it is 0. If you run hundreds of do_spdx task, + //and your fossology server is not fast enough, it's better to added this value. 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/ @@ -41,8 +39,6 @@ Note - If you want to use fossology-python.bbclass, you have to make sure that fossology server on your host and make sure it works well. Please reference to https://hub.docker.com/r/fossology/fossology/. - TOKEN can be created on fossology server after login by "Admin"->"Users"->"Edit user account"->"Create a new token". -- Not support create spdx files for *-native, so, please use meta-spdxscanner/classes/nopackages.bbclass instead of oe-core. - 2. fossology-rest.bbclass - inherit the folowing class in your conf/local.conf for all of recipes or @@ -59,22 +55,8 @@ 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. Please reference to https://hub.docker.com/r/fossology/fossology/. - TOKEN can be created on fossology server after login by "Admin"->"Users"->"Edit user account"->"Create a new token". -- Not support create spdx files for *-native, so, please use meta-spdxscanner/classes/nopackages.bbclass instead of oe-core. - -3. fossdriver-host.bbclass -- inherit the folowing class in your conf/local.conf for all of recipes or - in some recipes which you want. -``` - 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. - -4. scancode-tk.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. @@ -84,7 +66,6 @@ Note ``` Note -- scancode-tk has to install on host development system, so, make sure the version of python on host development system is 3.6. +- scancode-tk has to install on host development under python2. So, please make sure that python2 exists on your build server. - 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. |