Create CPU_MAX_USAGE.md

This commit is contained in:
xmrig 2019-09-28 02:22:38 +07:00 committed by GitHub
parent 7c463849cc
commit 0eb754d76e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

26
doc/CPU_MAX_USAGE.md Normal file
View File

@ -0,0 +1,26 @@
# Maximum CPU usage
Please read this document carefully, `max-threads-hint` (was known as `max-cpu-usage`) option is most confusing option in the miner with many myth and legends.
This option is just hint for automatic configuration and can't precise define CPU usage.
### Option definition
#### Config file:
```json
{
...
"cpu": {
"max-threads-hint": 100,
...
},
...
}
```
#### Command line
`--cpu-max-threads-hint 100`
### Known issues and usage
* This option has no effect if miner already generated CPU configuration, to prevent config generation use `"autosave":false,`.
* Only threads count can be changed, for 1 core CPU this option has no effect, for 2 core CPU only 2 values possible 50% and 100%, for 4 cores: 25%, 50%, 75%, 100%. etc.
* You CPU may limited by other factors, eg cache.