Skip to content

Commit 56b84f1

Browse files
Adds Command Line Referance and Explanation Sections
Initial Files are Added, content to be added in Version Specific Branches v2.2.1 and v3.1.1 which branches from this commit. Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
1 parent 08b1300 commit 56b84f1

6 files changed

Lines changed: 38 additions & 1 deletion

File tree

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Help text
2+
=========
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
All Available Options
2+
=====================
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
A Simple Example
2+
================
3+
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Synopsis
2+
========
3+
4+
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Overview
2+
========
3+
4+
How does ScanCode work?
5+
-----------------------
6+
7+
For license detection, ScanCode uses a (large) number of license texts and license detection 'rules' that are compiled in a search index. When scanning, the text of the target file is extracted and used to query the license search index and find license matches.
8+
9+
For copyright detection, ScanCode uses a grammar that defines the most common and less common forms of copyright statements. When scanning, the target file text is extracted and 'parsed' with this grammar to extract copyright statements.
10+
11+
Scan results are provided in various formats:
12+
13+
- a JSON file simple or pretty-printed,
14+
- SPDX tag value or XML RDF formats,
15+
- CSV,
16+
- a simple unformatted HTML file that can opened in browser or as a spreadsheet.
17+
18+
For each scanned file, the result contains:
19+
20+
- its location in the codebase,
21+
- the detected licenses and copyright statements,
22+
- the start and end line numbers identifying where the license or copyright was found in the scanned file, and
23+
- reference information for the detected license.
24+
25+
For archive extraction, ScanCode uses a combination of Python modules, 7zip and libarchive/bsdtar to detect archive types and extract these recursively.
26+
27+
Several other utility modules are used such as libmagic for file and mime type detection.

docs/source/scancode-toolkit/misc/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
:maxdepth: 2
66

77
faq
8-
help
98
support
109
perf_report
1110
plugin_arch

0 commit comments

Comments
 (0)