]> git.hungrycats.org Git - bees/commitdiff
docs: config-file: spell 'bees' correctly
authorZygo Blaxell <bees@furryterror.org>
Tue, 16 Jun 2026 05:01:58 +0000 (01:01 -0400)
committerZygo Blaxell <bees@furryterror.org>
Sat, 5 Sep 2026 04:03:57 +0000 (00:03 -0400)
Signed-off-by: Zygo Blaxell <bees@furryterror.org>
docs/config-file.md

index 29f61e5948043f3849e78284a2775d7245169367..1fbdcfab8ca21805d21124a3c2950fc7f602212f 100644 (file)
@@ -1,4 +1,4 @@
-# Bees Configuration File Reference
+# bees Configuration File Reference
 
 This page describes the bees configuration options.  For the location
 and syntax of configuration, see [bees configuration format
@@ -114,7 +114,7 @@ removed when bees closes them.
   * The path must be relative to the filesystem root; symlinks are not followed.
   * The default `"."` is implemented by opening the target filesystem root
     directly and works on any kernel version.
-  * Any other value requires `openat2(2)` (Linux 5.6+).  Bees will exit at
+  * Any other value requires `openat2(2)` (Linux 5.6+).  bees will exit at
     startup if `openat2` is unavailable rather than fall back to `openat(2)`,
     which cannot enforce `RESOLVE_BENEATH` or `RESOLVE_NO_SYMLINKS`.
   * Because `O_TMPFILE` inodes are anonymous, `dir` does not need to be listed
@@ -175,7 +175,7 @@ The `[log]` section controls the verbosity and content of log output.  This incl
   * `7` – Extent-level dedupe operations (filenames, offsets, and lengths), progress updates, statistics, minor errors.
   * `8` – Full debugging information.
     Default: `8` (full debug).
-    **Note**: Bees currently does not produce any log messages at level 3 or lower.
+    **Note**: bees currently does not produce any log messages at level 3 or lower.
 
 * **`timestamps`** *(legacy `--timestamps` / `--no-timestamps`)*
   Whether to include timestamps in log entries.
@@ -300,7 +300,7 @@ The `[paths]` section defines writable directories used by bees for persistent s
     if every active report uses an absolute filename; an active report with a
     relative filename and an empty `paths.reports` is a startup error.
   * Substitution variables `${UUID}`, `${LABEL}`, and `${BASENAME}` are expanded.
-  * Bees creates this directory if an active report with a relative filename
+  * This directory is created if an active report with a relative filename
     needs it.  Only the final path component is created (a plain `mkdir()`,
     not `mkdir -p`); the parent must already exist.  This is deliberately
     a single level: it lets a system that has `/run` gain `/run/bees`