Skip to content

Commit d3341dc

Browse files
authored
Merge pull request #148 from fosslight/format
Update supported format
2 parents a208dd3 + 6e01b26 commit d3341dc

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

src/fosslight_scanner/_help.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33
# Copyright (c) 2021 LG Electronics Inc.
44
# SPDX-License-Identifier: Apache-2.0
55
from fosslight_util.help import PrintHelpMsg
6+
from fosslight_util.output_format import SUPPORT_FORMAT
67

7-
_HELP_MESSAGE_SCANNER = """
8+
_HELP_MESSAGE_SCANNER = f"""
89
FOSSLight Scanner performs open source analysis after downloading the source from URL that can be cloned by git or wget.
910
Instead, open source analysis and checking copyright/license rules can be performed for the local source path.
1011
The output result is generated in OSS Report format.
@@ -21,14 +22,14 @@
2122
2223
Options:
2324
-h\t\t\t Print help message
24-
-p <path>\t\t Path to analyze (ex, -p {input_path})
25+
-p <path>\t\t Path to analyze (ex, -p [input_path])
2526
* Compare mode input file: Two FOSSLight reports (supports excel, yaml)
26-
(ex, -p {before_name}.xlsx {after_name}.xlsx)
27+
(ex, -p [before_name].xlsx [after_name].xlsx)
2728
-w <link>\t\t Link to be analyzed can be downloaded by wget or git clone
28-
-f <formats> [<format> ...]\t FOSSLight Report file format (excel, csv, opossum, yaml, spdx-tag, spdx-yaml, spdx-json, spdx-xml)
29+
-f <formats> [<format> ...]\t FOSSLight Report file format ({', '.join(SUPPORT_FORMAT)})
2930
* Compare mode result file: supports excel, json, yaml, html
3031
* Multiple formats can be specified separated by space.
31-
-e <path>\t\t Path to exclude from analysis (ex, -e {dir} {file})
32+
-e <path>\t\t Path to exclude from analysis (ex, -e [dir] [file])
3233
-o <output>\t\t Output directory or file
3334
-c <number>\t\t Number of processes to analyze source
3435
-r\t\t\t Keep raw data

0 commit comments

Comments
 (0)