Skip to content

Commit 1fae07a

Browse files
committed
fix: better explanation of path-report option
Closes: #20
1 parent a899542 commit 1fae07a

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,8 @@ Flags:
229229
--path-quarantine <path> - Set quarantine path directory.
230230
Is recommended put files outside the public document path
231231
[default: ./scanner-quarantine/]
232-
--path-report <path> - Set report log file
232+
--path-report <path> - Set report log file path and name.
233+
Note that name will be appended with .log or .html extension.
233234
[default: ./scanner-report.html]
234235
--path-whitelist <path> - Set whitelist file
235236
[default: ./scanner-whitelist.json]

src/Scanner.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -447,7 +447,7 @@ private function arguments($args = null)
447447
self::$argv->addFlag('path-backups', ['default' => self::$pathBackups, 'has_value' => true, 'value_name' => 'path', 'help' => "Set backups path directory.\nIs recommended put files outside the public document path"]);
448448
self::$argv->addFlag('path-quarantine', ['default' => self::$pathQuarantine, 'has_value' => true, 'value_name' => 'path', 'help' => "Set quarantine path directory.\nIs recommended put files outside the public document path"]);
449449
self::$argv->addFlag('path-logs', ['default' => self::$pathLogs, 'has_value' => true, 'value_name' => 'path', 'help' => 'Set quarantine log file']);
450-
self::$argv->addFlag('path-report', ['default' => self::$pathReport, 'has_value' => true, 'value_name' => 'path', 'help' => 'Set report log file']);
450+
self::$argv->addFlag('path-report', ['default' => self::$pathReport, 'has_value' => true, 'value_name' => 'path', 'help' => "Set report log file path and name.\nNote that name will be appended with .log or .html extension."]);
451451
self::$argv->addFlag('disable-colors', ['alias' => ['--no-colors', '--no-color'], 'default' => false, 'help' => 'Disable CLI colors']);
452452
self::$argv->addFlag('disable-cache', ['alias' => '--no-cache', 'default' => false, 'help' => 'Disable Cache']);
453453
self::$argv->addFlag('disable-report', ['alias' => '--no-report', 'default' => false, 'help' => 'Disable report generation']);

0 commit comments

Comments
 (0)