Skip to content

Drop -c short flag from --config-file to fix duplicate parameter warning #5279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MGpromax wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Drop -c short flag from --config-file to fix duplicate parameter warning #5279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/reference/scancode-cli/cli-help-text-options.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ The following help text is displayed for ScanCode version 32.0.0:
-n, --processes INT Set the number of parallel processes to use. Disable
parallel processing if 0. Also disable threading if
-1. [default: (number of CPUs)-1]
-c, --config-file FILENAME Path to the configuration file.
--config-file FILENAME Path to the configuration file.
-q, --quiet Do not print summary or progress.
-v, --verbose Print progress as file-by-file path instead of a
progress bar. Print verbose scan counters.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/rst-snippets/cli-core-options.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

Default: ``(number of CPUs)-1``

-c, --config-file FILENAME Path to the configuration file.
--config-file FILENAME Path to the configuration file.
-v, --verbose Print verbose file-by-file progress messages.

-q, --quiet Do not print summary or progress messages.
Expand Down
2 changes: 1 addition & 1 deletion src/scancode/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ def default_processes():
cls=PluggableCommandLineOption,
)

@click.option('-c', '--config-file',
@click.option('--config-file',
type=click.File('r'),
required=False,
help='Path to the configuration file.',
Expand Down
45 changes: 22 additions & 23 deletions tests/scancode/data/help/help.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,29 +136,28 @@ Options:
which are todo items and needs manual review.

core:
--ignore <pattern> Ignore files matching <pattern>.
--timeout <seconds> Stop an unfinished file scan after a timeout in
seconds. [default: 120 seconds]
-n, --processes INT Set the number of parallel processes to use.
Disable parallel processing if 0. Also disable
threading if -1. [default: (number of CPUs)-1]
-c, --config-file FILENAME Path to the configuration file.
-q, --quiet Do not print summary or progress.
-v, --verbose Print progress as file-by-file path instead of a
progress bar. Print verbose scan counters.
--from-json Load codebase from one or more <input> JSON scan
file(s).
--max-in-memory INTEGER Maximum number of files and directories scan
details kept in memory during a scan. Additional
files and directories scan details above this
number are cached on-disk rather than in memory.
Use 0 to use unlimited memory and disable on-disk
caching. Use -1 to use only on-disk caching.
[default: 10000]
--max-depth INTEGER Maximum nesting depth of subdirectories to scan.
Descend at most INTEGER levels of directories
below and including the starting directory. Use 0
for no scan depth limit.
--ignore <pattern> Ignore files matching <pattern>.
--timeout <seconds> Stop an unfinished file scan after a timeout in
seconds. [default: 120 seconds]
-n, --processes INT Set the number of parallel processes to use. Disable
parallel processing if 0. Also disable threading if
-1. [default: (number of CPUs)-1]
--config-file FILENAME Path to the configuration file.
-q, --quiet Do not print summary or progress.
-v, --verbose Print progress as file-by-file path instead of a
progress bar. Print verbose scan counters.
--from-json Load codebase from one or more <input> JSON scan
file(s).
--max-in-memory INTEGER Maximum number of files and directories scan details
kept in memory during a scan. Additional files and
directories scan details above this number are cached
on-disk rather than in memory. Use 0 to use unlimited
memory and disable on-disk caching. Use -1 to use
only on-disk caching. [default: 10000]
--max-depth INTEGER Maximum nesting depth of subdirectories to scan.
Descend at most INTEGER levels of directories below
and including the starting directory. Use 0 for no
scan depth limit.

documentation:
-h, --help Show this message and exit.
Expand Down
45 changes: 22 additions & 23 deletions tests/scancode/data/help/help_linux.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,29 +138,28 @@ Options:
which are todo items and needs manual review.

core:
--ignore <pattern> Ignore files matching <pattern>.
--timeout <seconds> Stop an unfinished file scan after a timeout in
seconds. [default: 120 seconds]
-n, --processes INT Set the number of parallel processes to use.
Disable parallel processing if 0. Also disable
threading if -1. [default: (number of CPUs)-1]
-c, --config-file FILENAME Path to the configuration file.
-q, --quiet Do not print summary or progress.
-v, --verbose Print progress as file-by-file path instead of a
progress bar. Print verbose scan counters.
--from-json Load codebase from one or more <input> JSON scan
file(s).
--max-in-memory INTEGER Maximum number of files and directories scan
details kept in memory during a scan. Additional
files and directories scan details above this
number are cached on-disk rather than in memory.
Use 0 to use unlimited memory and disable on-disk
caching. Use -1 to use only on-disk caching.
[default: 10000]
--max-depth INTEGER Maximum nesting depth of subdirectories to scan.
Descend at most INTEGER levels of directories
below and including the starting directory. Use 0
for no scan depth limit.
--ignore <pattern> Ignore files matching <pattern>.
--timeout <seconds> Stop an unfinished file scan after a timeout in
seconds. [default: 120 seconds]
-n, --processes INT Set the number of parallel processes to use. Disable
parallel processing if 0. Also disable threading if
-1. [default: (number of CPUs)-1]
--config-file FILENAME Path to the configuration file.
-q, --quiet Do not print summary or progress.
-v, --verbose Print progress as file-by-file path instead of a
progress bar. Print verbose scan counters.
--from-json Load codebase from one or more <input> JSON scan
file(s).
--max-in-memory INTEGER Maximum number of files and directories scan details
kept in memory during a scan. Additional files and
directories scan details above this number are cached
on-disk rather than in memory. Use 0 to use unlimited
memory and disable on-disk caching. Use -1 to use
only on-disk caching. [default: 10000]
--max-depth INTEGER Maximum nesting depth of subdirectories to scan.
Descend at most INTEGER levels of directories below
and including the starting directory. Use 0 for no
scan depth limit.

documentation:
-h, --help Show this message and exit.
Expand Down