diff options
-rw-r--r-- | README.md | 31 | ||||
-rw-r--r-- | classes/fossdriver-host.bbclass | 12 |
2 files changed, 32 insertions, 11 deletions
@@ -1,22 +1,41 @@ # meta-spdxscanner meta-spdxscanner supports the following SPDX create tools. -1. fossdriver (Can work with fossology 3.5.0) -2. DoSOCSv2 (Scanner comes from fossology 3.4.0) +1. fossology REST API (Can work with fossology after 3.5.0) +2. fossdriver (Can work with fossology 3.5.0) +3. DoSOCSv2 (Scanner comes from fossology 3.4.0) # This layer depends on: -1. fossdriver +1. fossology REST API - openembedded-core -2. DoSOCSv2 +2. fossdriver +- openembedded-core + +3. DoSOCSv2 - openembedded-core - meta-openembedded/meta-oe - meta-openembedded/meta-python # How to use -1. fossdriver-host.bbclass +1. fossology-rest.bbclass +- inherit the folowing class in your conf/local.conf for all of recipes or + in some recipes which you want. + +``` + INHERIT += "fossology-rest" + TOKEN = "eyJ0eXAiO..." + FOSSOLOGY_SERVER = "http://xx.xx.xx.xx:8081/repo" //By default, it is http://127.0.0.1:8081/repo +``` +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". +- If you don't want to create spdx files for *-native, please use meta-spdxscanner/classes/nopackages.bbclass instead of oe-core. + +2. fossdriver-host.bbclass - inherit the folowing class in your conf/local.conf for all of recipes or in some recipes which you want. @@ -28,7 +47,7 @@ Note 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. -2. dosocs.bbclass +3. dosocs.bbclass - inherit the folowing class in your conf/local.conf for all of recipes or in some recipes which you want. diff --git a/classes/fossdriver-host.bbclass b/classes/fossdriver-host.bbclass index cb04333..655dbc0 100644 --- a/classes/fossdriver-host.bbclass +++ b/classes/fossdriver-host.bbclass @@ -1,18 +1,20 @@ # This class integrates real-time license scanning, generation of SPDX standard # output and verifiying license info during the building process. -# It is a combination of efforts from the OE-Core, SPDX and fossdriver projects. +# It is a combination of efforts from the OE-Core, SPDX and fossology projects. # -# For more information on fossdriver: -# https://github.com/fossology/fossdriver +# For more information on fossology REST API: +# https://www.fossology.org/get-started/basic-rest-api-calls/ # # For more information on SPDX: # http://www.spdx.org # # Note: -# 1) Make sure fossology 3.5.0(https://hub.docker.com/r/fossology/fossology/) has beed started on your host +# 1) Make sure fossology (after 3.5.0)(https://hub.docker.com/r/fossology/fossology/) has beed started on your host # 2) spdx files will be output to the path which is defined as[SPDX_DEPLOY_DIR]. # By default, SPDX_DEPLOY_DIR is tmp/deploy/ -# +# 3) Added TOKEN has been set in conf/local.conf +# + inherit spdx-common CREATOR_TOOL = "fossdriver-host.bbclass in meta-spdxscanner" |