Browse Source

doc: clarify `algorithm` usage in a config file pool section.

refactor
Noel Maersk 11 years ago
parent
commit
0dcb6ca498
  1. 5
      NEWS.md
  2. 13
      doc/configuration.md

5
NEWS.md

@ -2,6 +2,11 @@
## Version 4.2.0 - TBA ## Version 4.2.0 - TBA
* Allow setting algorithm per-pool and initial implementation of kernel
hot-swapping (by _mrbrdo_). Use options `pool-algorithm` (in config
file or in CLI) or `algorithm` (config-only).
## Version 4.1.242 - 7th April 2014 ## Version 4.1.242 - 7th April 2014
* There are now two mailing lists (on SourceForge), see `README.md`. * There are now two mailing lists (on SourceForge), see `README.md`.

13
doc/configuration.md

@ -10,6 +10,9 @@
Allows choosing between the few mining algorithms for incompatible Allows choosing between the few mining algorithms for incompatible
cryptocurrencies. cryptocurrencies.
If specified in a pool section in the configuration file, sets the
option for that pool only. Otherwise sets the default.
*Argument:* string *Argument:* string
*Default:* `scrypt` *Default:* `scrypt`
@ -23,22 +26,30 @@ cryptocurrencies.
* everything else - currently defaults to `scrypt`, subject to change * everything else - currently defaults to `scrypt`, subject to change
without warning. without warning.
### pool-algorithm ### pool-algorithm
Allows choosing the algorithm for a specific pool. See `algorithm`. Allows choosing the algorithm for a specific pool. See `algorithm`.
### nfactor ### nfactor
Overrides the default scrypt parameter N, specified as the factor of 2 Overrides the default scrypt parameter N, specified as the factor of 2
(`N = 2^nfactor`). (`N = 2^nfactor`).
If specified in a pool section in the configuration file, sets the
option for that pool only. Otherwise sets the default.
*Argument:* whole number (>1). *Argument:* whole number (>1).
*Default:* depends on `algorithm`; otherwise `10`. *Default:* depends on `algorithm`; otherwise `10`.
### pool-nfactor ### pool-nfactor
Overrides the default scrypt parameter N for a specific pool. See `nfactor`. Overrides the default scrypt parameter N for a specific pool.
See `nfactor`.
## CLI-only options ## CLI-only options

Loading…
Cancel
Save