Merge branch 'develop' into add-doc-link-to-readme

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

Author: AyanSinhaMahapatra

.travis.yml

@@ -78,6 +78,16 @@ matrix:
       python: "3.6"
       dist: bionic
 
+    - os: linux
+      sudo: required
+      script: 
+        - source bin/activate
+        - cd docs
+        - ./scripts/sphinx_build_link_check.sh
+        - ./scripts/doc8_style_check.sh
+      language: python
+      python: "3.6"
+      dist: bionic
 
 addons:
   homebrew:
@@ -102,11 +112,6 @@ script:
   # - ./bin/py.test -n 2 -vvs --cov=src tests/scancode
   # - echo $TEST_SUITE
   - $TEST_SUITE
-  # Documentation Test Scripts
-  - source bin/activate
-  - cd docs
-  - "./scripts/sphinx_build_link_check.sh"
-  - "./scripts/doc8_style_check.sh"
 
 # Pay attention to both calls below. They will succeed even if there
 # is no coverage information or connection to reporting website fails.

docs/source/plugins/cpp_includes_plugin.rst

@@ -0,0 +1,41 @@
+.. _cpp_includes_plugin:
+
+CPP Includes Plugin
+===================
+
+This plugin allows users to collect the #includes statements in C/C++ files.
+
+Using the Plugin
+----------------
+
+User needs to use the ``--cpp-includes`` option.
+
+The following command will collect the #includes statements from C/C++ files.::
+
+  $ scancode --cpp-includes /path/to/codebase/ --json-pp ~/path/to/scan-output.json
+
+Example Output
+--------------
+
+Here is an sample output::
+
+    {
+      "path": "zlib_deflate/deflate.c",
+      "type": "file",
+      "cpp_includes": [
+        "<linux/module.h",
+        "<linux/zutil.h",
+        "\"defutil.h"
+      ],
+      "scan_errors": []
+    },
+    {
+      "path": "zlib_deflate/deflate_syms.c",
+      "type": "file",
+      "cpp_includes": [
+        "<linux/module.h",
+        "<linux/init.h",
+        "<linux/zlib.h"
+      ],
+      "scan_errors": []
+    }

docs/source/plugins/dwarf.rst

@@ -0,0 +1,39 @@
+.. _dwarf_plugin:
+
+Dwarf Plugin
+============
+
+This plugin allows users to collect source code path/name from compilation units found in
+ELF DWARFs.
+
+Specification
+-------------
+
+This plugin will only work with non-stripped ELFs with debug symbols.
+
+Using the Plugin
+----------------
+
+User needs to use the ``--dwarf`` option.
+
+The following command will collect all the dwarf references found in non-stripped ELFs::
+
+  $ scancode --dwarf /path/to/codebase/ --json-pp ~/path/to/scan-output.json
+
+Example Output
+--------------
+
+Here is an sample output::
+
+    {
+      "path": "project/stripped.ELF",
+      "type": "file",
+      "dwarf_source_path": [],
+      "scan_errors": []
+    },
+    {
+      "path": "project/non-stripped.ELF",
+      "type": "file",
+      "dwarf_source_path": ['/tmp/test.c],
+      "scan_errors": []
+    }

docs/source/plugins/index.rst

@@ -7,3 +7,6 @@
    plugin_arch
    licence_policy_plugin
    plugin_tutorials
+   cpp_includes_plugin
+   lkmclue
+   dwarf

docs/source/plugins/lkmclue.rst

@@ -0,0 +1,45 @@
+.. _lkmclue_plugin:
+
+LKMClue Plugin
+==============
+
+This plugin allows users to collect LKM module clues and type indicating a
+possible Linux Kernel Module.
+
+Using the Plugin
+----------------
+
+User needs to use the ``--lkmclue`` option.
+
+The following command will collect the LKM module clues from the input location::
+
+  $ scancode --lkmclue /path/to/codebase/ --json-pp ~/path/to/scan-output.json
+
+Example Output
+--------------
+
+Here is an sample output::
+
+    {
+      "path": "zlib_deflate/deflate.c",
+      "type": "file",
+      "lkm_clue": {
+        "lkm-header-include": [
+          "include <linux/module.h>"
+        ]
+      },
+      "scan_errors": []
+    },
+    {
+      "path": "zlib_deflate/deflate_syms.c",
+      "type": "file",
+      "lkm_clue": {
+        "lkm-header-include": [
+          "include <linux/module.h>"
+        ],
+        "lkm-license": [
+          "GPL"
+        ]
+      },
+      "scan_errors": []
+    }

setup.py

@@ -293,7 +293,7 @@ def read(*names, **kwargs):
             'classify-package = summarycode.classify:PackageTopAndKeyFilesTagger',
             'is-license-text = licensedcode.plugin_license_text:IsLicenseText',
             'filter-clues = cluecode.plugin_filter_clues:RedundantCluesFilter',
-            'consolidate = scancode.plugin_consolidate:Consolidator',
+            'consolidate = summarycode.plugin_consolidate:Consolidator',
         ],
 
         # scancode_output_filter is the entry point for filter plugins executed

src/packagedcode/models.py

@@ -241,6 +241,8 @@ def purl(self):
         """
         Return a compact purl package URL string.
         """
+        if not self.name:
+            return
         return PackageURL(
             self.type, self.namespace, self.name, self.version,
             self.qualifiers, self.subpath).to_string()
@@ -323,7 +325,8 @@ class DependentPackage(BaseModel):
     purl = String(
         repr=True,
         label='Dependent package URL',
-        help='A compact purl package URL')
+        help='A compact purl package URL. Typically when there is an unresolved requirement, there is no version. '
+             'If the dependency is resolved, the version should be added to the purl')
 
     requirement = String(
         repr=True,