Skip to content

Commit 82211fe

Browse files
committed
Update consolidation help text #1686
Signed-off-by: Jono Yang <[email protected]>
1 parent b989133 commit 82211fe

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

src/scancode/plugin_consolidate.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,10 @@ class Consolidator(PostScanPlugin):
160160
options = [
161161
CommandLineOption(('--consolidate',),
162162
is_flag=True, default=False,
163-
help='Return a list of consolidated packages and a list of consolidated components',
163+
help='Group resources by Packages or license and copyright holder and '
164+
'return those groupings as a list of consolidated packages and '
165+
'a list of consolidated components. '
166+
'This requires the scan to have/be run with the copyright, license, and package options active',
164167
help_group=POST_SCAN_GROUP
165168
)
166169
]

tests/scancode/data/help/help.txt

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,12 @@ Options:
8484
<pattern>.
8585

8686
post-scan:
87-
--consolidate Return a list of consolidated packages and a list of
88-
consolidated components
87+
--consolidate Group resources by Packages or license and copyright
88+
holder and return those groupings as a list of
89+
consolidated packages and a list of consolidated
90+
components. This requires the scan to have/be run
91+
with the copyright, license, and package options
92+
active
8993
--filter-clues Filter redundant duplicated clues already contained
9094
in detected license and copyright texts and notices.
9195
--is-license-text Set the "is_license_text" flag to true for files that

0 commit comments

Comments
 (0)