]> git.hungrycats.org Git - bees/commitdiff
docs: update thread option defaults for config version 2
authorZygo Blaxell <bees@furryterror.org>
Sat, 12 Sep 2026 20:29:07 +0000 (16:29 -0400)
committerZygo Blaxell <bees@furryterror.org>
Sun, 11 Oct 2026 00:48:00 +0000 (20:48 -0400)
thread.thread-max is 4 from version 2 onward, so --thread-factor no
longer feeds any default expression.  Say so in both option entries, and
name the version 1 expression as the way back to a CPU-relative count.

Assisted-by: Claude-Code:claude-fable-5-1
docs/options.md

index 0ed2f8a7bf84805109147d11db0e0bac46b3db87..9a8af5e79ffb78967ec2caaa296fa4fcaca638f4 100644 (file)
@@ -4,20 +4,28 @@
 
 * `--thread-count COUNT` or `-c`
 
- Set the number of worker threads to exactly `COUNT`, overriding the default
- `thread.thread-max` expression (and therefore `--thread-factor`).  Values
- larger than the CPU count are honoured, so this can oversubscribe CPUs.
+ Set the number of worker threads to exactly `COUNT`, overriding
+ `thread.thread-max` (and therefore `--thread-factor`).  Values larger
+ than the CPU count are honoured, so this can oversubscribe CPUs.
+
+ The default `thread.thread-max` is `4` from config version 2 onward.
+ Version 1 and `v0.11` default to the CPU-relative expression
+ `max(1, ceil(${NPROC} * ${THREAD_FACTOR}))`.
 
 * `--thread-factor FACTOR` or `-C`
 
  Specify ratio of worker threads to detected CPU cores.  This is the
- `${THREAD_FACTOR}` substitution used by the default `thread.thread-max`
- expression, `max(1, ceil(${NPROC} * ${THREAD_FACTOR}))`.  It has no effect
- when `--thread-count` (`-c`) sets an explicit count.
-
- Default is 1.0, i.e. 1 worker thread per detected CPU.  Use values
- below 1.0 to leave some cores idle, or above 1.0 if there are more
- disks than CPUs in the filesystem.
+ `${THREAD_FACTOR}` substitution available to the `thread.thread-max`,
+ `thread.thread-min` and `thread.loadavg-target` expressions.  It has no
+ effect unless one of those expressions uses it, and none of the config
+ version 2 defaults do: set `thread-max` to something like
+ `max(1, ceil(${NPROC} * ${THREAD_FACTOR}))` -- the version 1 default --
+ to get a CPU-relative thread count again.  It also has no effect when
+ `--thread-count` (`-c`) sets an explicit count.
+
+ Default is 1.0, i.e. 1 worker thread per detected CPU where the
+ expression uses it.  Use values below 1.0 to leave some cores idle, or
+ above 1.0 if there are more disks than CPUs in the filesystem.
 
 * `--loadavg-target LOADAVG` or `-g`