Skip to content

Commit 898409c

Browse files
author
Paulo Ribeiro
authored
doc: Change unit of --max-tool-memory default value to GB (#373)
1 parent bb3f682 commit 898409c

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ Found [Clone] 7 duplicated lines with 10 tokens:
218218
* `--allow-network` [default: false] - Allow network access, so tools that need it can execute (e.g. findbugs)
219219
* `--force-file-permissions` [default: false] - Force files to be readable by changing the permissions before running the analysis
220220
* `--tool-timeout` [default: 15minutes] - Maximum time each tool has to execute (e.g. 15minutes, 1hour)
221-
* `--max-tool-memory` [default: 3000000000] - Maximum of allowed memory for each tool execution (in bytes or using the notation of [Docker's memory limit flags](https://docs.docker.com/config/containers/resource_constraints/#limit-a-containers-access-to-memory))
221+
* `--max-tool-memory` [default: 3g] - Maximum of allowed memory for each tool execution (in bytes or using the notation of [Docker's memory limit flags](https://docs.docker.com/config/containers/resource_constraints/#limit-a-containers-access-to-memory))
222222
* `--tmp-directory` [optional] - Temporary directory for analysis purposes
223223
* `--gh-code-scanning-compat` [default: false] - Reduce issue severity by one level, __for non-security issues__, for compatibility with GitHub's code scanning feature.
224224
This option will only have an effect when used in conjunction with `--format sarif`. Note that in this case, the same issues on Codacy side will have higher priority.

0 commit comments

Comments
 (0)