Skip to content

Latest commit

 

History

History
101 lines (59 loc) · 3.35 KB

output-filters-and-control.rst

File metadata and controls

101 lines (59 loc) · 3.35 KB
Raw

Controlling Scancode Output and Filters

--strip-root Vs. --full-root

For a default scan of the "samples" folder, this a comparison between the default, strip-root and full-root options.

An example Scan

scancode -cplieu --json-pp output.json samples --full-root

These two changes only the "path" attribute of the file information. For this comparison we compare the "path" attributes of the file LICENSE inside JGroups directory.

The default path:

"path": "samples/JGroups/LICENSE",

For the --full-root option, the path relative to the Root of your local filesystem.

"path": "/home/ayansm/Desktop/GSoD/scancode-toolkit-versions/scancode-toolkit-2.2.1/samples/JGroups/LICENSE"

For the --strip-root option, the root directory (here samples) is removed from path :

"path": "JGroups/LICENSE"

--ignore-author <pattern> Option

In a normal scan, all files inside the directory specified as an input argument is scanned and subsequently included in the scan report. But if you want to run the scan on only some selective files, with some specific common author then --ignore-author option can be used to do the same.

This scan ignores all files with authors matching the string "Apache Software Foundation":

scancode -cplieu --json-pp output.json samples --ignore-author "Apache Software Foundation"

More information on :ref:`glob_pattern_matching`.

--ignore-copyright-holder <pattern> Option

In a normal scan, all files inside the directory specified as an input argument is scanned and subsequently included in the scan report. But if you want to run the scan on only some selective files, with some specific common copyright holder then --ignore-copyright-holder option can be used to do the same.

This scan ignores all files with Copyright Holders matching the string "Free Software Foundation":

scancode -cplieu --json-pp output.json samples --ignore-copyright-holder "Free Software Foundation"

More information on :ref:`glob_pattern_matching`.

--only-findings Plugin

This option removes from the scan results, the files where nothing significant has been detected, like files which doesn't contain any licenses, copyrights, emails or urls (if requested in the scan options), and isn't a package.

An example Scan:

scancode -cplieu --json-pp output.json samples --only-findings

Note

This also changes in the result displayed, the number of files scanned.

For example, scanning the sample files (distributed by default with scancode-toolkit) without this option, displays in it's report information of 43 files. But after enabling this option, the result shows information for only 31 files.