Merge branch 'master' into indexdb

laktak · Dec 20, 2024 · bf7a02c · bf7a02c
2 parents e197928 + 4a9267f
commit bf7a02c
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -94,7 +94,7 @@ Arguments:
 
 Flags:
   -h, --help                    Show context-sensitive help.
-  -H, --tips                    Show tips.
+  -H, --tips                    show tips
   -m, --[no-]show-missing       show missing files/directories
   -d, --[no-]include-dot        include dot files
   -S, --[no-]skip-symlinks      do not follow symlinks
@@ -105,15 +105,15 @@ Flags:
                                 only)
   -l, --log-file=STRING         write to a logfile if specified
       --[no-]log-verbose        verbose logging
-      --algo="blake3"           hash algorithm: md5, sha512, blake3 (default:
-                                blake3)
+      --algo="blake3"           hash algorithm: md5, sha512, blake3
       --index-name=".chkbit"    filename where chkbit stores its hashes,
-                                needs to start with '.' (default: .chkbit)
+                                needs to start with '.'
       --ignore-name=".chkbitignore"
                                 filename that chkbit reads its ignore list from,
-                                needs to start with '.' (default: .chkbitignore)
+                                needs to start with '.'
       --db                      use a index database instead of index files
-  -w, --workers=5               number of workers to use (default: 5)
+  -w, --workers=5               number of workers to use. For slow IO (like on a
+                                spinning disk) --workers=1 will be faster.
       --[no-]plain              show plain status instead of being fancy
   -q, --[no-]quiet              quiet, don't show progress/information
   -v, --[no-]verbose            verbose output
@@ -162,7 +162,7 @@ Configuration file (json):
   { "include_dot": true }
 ```
 
-chkbit is set to use only 5 workers by default so it will not slow your system to a crawl. You can specify a higher number to make it a lot faster if the IO throughput can also keep up.
+chkbit is set to use only 5 workers by default so it will not slow your system to a crawl. You can specify a higher number to make it a lot faster if the IO throughput can also keep up. For slow/spinning disks, use `--worker=1`.
 
 
 ## Repair

diff --git a/cmd/chkbit/main.go b/cmd/chkbit/main.go
@@ -45,7 +45,7 @@ var (
 
 type CLI struct {
 	Paths           []string `arg:"" optional:"" name:"paths" help:"directories to check"`
-	Tips            bool     `short:"H" help:"Show tips."`
+	Tips            bool     `short:"H" help:"show tips"`
 	Check           bool     `short:"c" help:"chkbit will verify files in readonly mode (default mode)" xor:"mode" group:"Mode"`
 	Update          bool     `short:"u" help:"add and update indices" xor:"mode" group:"Mode"`
 	AddOnly         bool     `short:"a" help:"only add new and modified files, do not check existing (quicker)" xor:"mode" group:"Mode"`
@@ -60,11 +60,11 @@ type CLI struct {
 	Force           bool     `help:"force update of damaged items (advanced usage only)"`
 	LogFile         string   `short:"l" help:"write to a logfile if specified"`
 	LogVerbose      bool     `help:"verbose logging" negatable:""`
-	Algo            string   `default:"blake3" help:"hash algorithm: md5, sha512, blake3 (default: blake3)"`
-	IndexName       string   `default:".chkbit" help:"filename where chkbit stores its hashes, needs to start with '.' (default: .chkbit)"`
-	IgnoreName      string   `default:".chkbitignore" help:"filename that chkbit reads its ignore list from, needs to start with '.' (default: .chkbitignore)"`
+	Algo            string   `default:"blake3" help:"hash algorithm: md5, sha512, blake3"`
+	IndexName       string   `default:".chkbit" help:"filename where chkbit stores its hashes, needs to start with '.'"`
+	IgnoreName      string   `default:".chkbitignore" help:"filename that chkbit reads its ignore list from, needs to start with '.'"`
 	Db              bool     `help:"use a index database instead of index files"`
-	Workers         int      `short:"w" default:"5" help:"number of workers to use (default: 5)"`
+	Workers         int      `short:"w" default:"5" help:"number of workers to use. For slow IO (like on a spinning disk) --workers=1 will be faster."`
 	Plain           bool     `help:"show plain status instead of being fancy" negatable:""`
 	Quiet           bool     `short:"q" help:"quiet, don't show progress/information" negatable:""`
 	Verbose         bool     `short:"v" help:"verbose output" negatable:""`