Skip to content

Commit 38a89f4

Browse files
committed
Update doc fomat and reorganize content location
Signed-off-by: Chin Yeung Li <[email protected]>
1 parent 67f7634 commit 38a89f4

File tree

2 files changed

+32
-30
lines changed

2 files changed

+32
-30
lines changed

docs/source/cli-reference/other-commands.rst

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -12,35 +12,6 @@ Other available CLIs
1212
.. include:: /rst_snippets/scancode-license-data.rst
1313

1414

15-
``--path`` Option:
16-
^^^^^^^^^^^^^^^^^^
17-
18-
The ``--path`` option defines the directory where the license data will be stored.
19-
20-
Here is an example of dumping license data with the ``--path DIR`` option::
21-
22-
scancode-license-data --path ~/licenses
23-
24-
Dumping license data to: /home/user/licenses
25-
Done dumping #2465 licenses.
26-
27-
Each of the licenses contains four files: '.LICENSE', '.html', '.json', and '.yml'.
28-
29-
The dumped licenses directory look like this::
30-
31-
licenses/
32-
├── 389-exception.LICENSE
33-
├── 389-exception.html
34-
├── 389-exception.json
35-
├── 389-exception.yml
36-
├── 3com-microcodeLICENSE
37-
├── 3com-microcode.html
38-
├── 3com-microcode.json
39-
├── 3com-microcode.yml
40-
.
41-
.
42-
.
43-
4415
----
4516

4617
.. include:: /rst_snippets/scancode-reindex-licenses.rst
Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
``scancode-license-data`` Usage
22
-------------------------------
33

4-
Usage: scancode-license-data [OPTIONS]
4+
Usage: ``scancode-license-data [OPTIONS]``
55

66
Dump scancode license data in various formats, and the licenseDB static
77
website at `path`.
@@ -10,3 +10,34 @@ Options:
1010
--path DIR Dump the license data in this directory in the LicenseDB format
1111
and exit. Creates the directory if it does not exist.
1212
-h, --help Show this message and exit.
13+
14+
15+
``--path`` Option:
16+
^^^^^^^^^^^^^^^^^^
17+
18+
The ``--path`` option is mandatory and defines the directory where the
19+
license data will be stored.
20+
21+
Here is an example of dumping license data with the ``--path DIR`` option::
22+
23+
scancode-license-data --path ~/licenses
24+
25+
Dumping license data to: /home/user/licenses
26+
Done dumping #2465 licenses.
27+
28+
Each of the licenses contains four files: '.LICENSE', '.html', '.json', and '.yml'.
29+
30+
The dumped licenses directory look like this::
31+
32+
licenses/
33+
├── 389-exception.LICENSE
34+
├── 389-exception.html
35+
├── 389-exception.json
36+
├── 389-exception.yml
37+
├── 3com-microcodeLICENSE
38+
├── 3com-microcode.html
39+
├── 3com-microcode.json
40+
├── 3com-microcode.yml
41+
.
42+
.
43+
.

0 commit comments

Comments
 (0)