]> git.hungrycats.org Git - bees/commitdiff
docs: editorial fixes for [state], [state.hash], and [state.point] sections
authorZygo Blaxell <bees@furryterror.org>
Wed, 22 Jul 2026 05:30:26 +0000 (01:30 -0400)
committerZygo Blaxell <bees@furryterror.org>
Sat, 5 Sep 2026 04:03:57 +0000 (00:03 -0400)
Opus isn't very good at commas, apparently.

Signed-off-by: Zygo Blaxell <bees@furryterror.org>
docs/config-file.md

index bef17ceaa0adfc218072b56c2decf5254f0af8ea..520091e8f7452bf07c87bbf4b4bf18e765cc95ad 100644 (file)
@@ -407,7 +407,7 @@ unless explicitly enabled, except that `$BEESSTATUS` activates
 ## [state] section
 
 The `[state]` section is the master switch for on-disk persistence.  When
-persistence is enabled bees stores its hash table in `beeshash.dat` and its
+persistence is enabled, bees stores its hash table in `beeshash.dat` and its
 crawl checkpoint in `beespoint.ini` under the directory named by `paths.home`.
 The `[state.hash]` and `[state.point]` subsections configure the two state
 files in detail.
@@ -420,7 +420,7 @@ files in detail.
   * `no` — bees runs entirely from an in-memory hash table and starts every
     crawl from the beginning.  No state files are read or written.  Combine
     with `loop.exit-when-finished = yes` for a stateless one-shot run; without
-    a loop-exit option the in-memory hash table is discarded on restart and
+    a loop-exit option, the in-memory hash table is discarded on restart, and
     every restart redoes work.
   * When `persistent = no`, the keys in `[state.hash]` and `[state.point]`
     have no effect.
@@ -448,7 +448,7 @@ may create or resize it, and how aggressively it is written back to disk.
     (total installed RAM) and `${FS_BYTES}` (filesystem capacity).
   * Expressions in a config file are recomputed at every startup.  If RAM
     or filesystem size changes between runs, the recomputed `size` may
-    differ from the on-disk file.  When that happens bees logs a warning
+    differ from the on-disk file.  When that happens, bees logs a warning,
     and uses the existing on-disk size unless `state.hash.resize = yes`.
     For one-time changes, prefer the `--option` command-line flag
     (combined with `state.hash.resize = yes`) rather than editing the
@@ -486,8 +486,8 @@ may create or resize it, and how aggressively it is written back to disk.
 
 * **`writeback-rate-max`**
   Maximum hash table writeback rate in bytes per second.  Caps the rate
-  derived from `writeback-time` so very large hash tables do not generate
-  proportionally large I/O storms.
+  derived from `writeback-time` so very large hash tables or very short
+  writeback times do not generate proportionally large I/O storms.
   * Default: `128K`.
   * Accepts a [size value](config-format.md#size-values) per second.
   * The effective writeback rate is
@@ -512,10 +512,10 @@ may create or resize it, and how aggressively it is written back to disk.
   `fsync` `beeshash.dat` once on clean exit.
   * `no` (default) — rely on the kernel's writeback for the closing
     flush.
-  * `yes` — block on a final `fsync` so bees does not return control
-    until the hash table is durable on disk.  Useful when bees is run
-    by a service manager that may immediately power down or unmount
-    the filesystem after bees exits.
+  * `yes` — block on a final `fsync` so bees does not exit until the
+    hash table is durable on disk.  Useful when bees is run by a service
+    manager that may immediately power down or unmount the filesystem
+    after bees exits.
 
 ## [state.point] section