From: Joey Hess <joeyh@joeyh.name>
Date: Mon, 10 May 2021 15:11:50 +0000 (-0400)
Subject: mention --all on fsck man page, and repurpose todo
X-Git-Tag: archive/raspbian/10.20250416-2+rpi1~1^2~91^2~410
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=56ccc0302e57e76a4f41094108bb3cddc9b2ce4b;p=git-annex.git

mention --all on fsck man page, and repurpose todo
---

diff --git a/doc/git-annex-fsck.mdwn b/doc/git-annex-fsck.mdwn
index 472c5a70af..4407f0c5e4 100644
--- a/doc/git-annex-fsck.mdwn
+++ b/doc/git-annex-fsck.mdwn
@@ -110,6 +110,13 @@ better format.
   Messages that would normally be output to standard error are included in
   the json instead.
 
+* `--quiet`
+
+  Like all git-annex commands, this option makes only error and warning
+  messages be displayed. This is particularly useful with fsck, which
+  normally displays all the files it's checking even when there is no
+  problem with them.
+
 # SEE ALSO
 
 [[git-annex]](1)
diff --git a/doc/todo/fsck_option_to_only_show_broken.mdwn b/doc/todo/fsck_option_to_only_show_broken.mdwn
index cade432e43..f0ed31c851 100644
--- a/doc/todo/fsck_option_to_only_show_broken.mdwn
+++ b/doc/todo/fsck_option_to_only_show_broken.mdwn
@@ -1,3 +1,5 @@
 `git annex fsck` currently spams the terminal with all keys in a repo and prints `git-annex: fsck: n failed` at the end if errors occur. Finding these errors in a sea of `ok`s is not trivial however.
 
 A simple solution to this could be an fsck option which skips printing ok'd (and perhaps also dead) keys, i.e. `--no-ok` and `--no-dead`.
+
+[[!meta title="mention common options on per-command man pages"]]
diff --git a/doc/todo/fsck_option_to_only_show_broken/comment_3_77600b5ce57004e66f9fde7ac8386928._comment b/doc/todo/fsck_option_to_only_show_broken/comment_3_77600b5ce57004e66f9fde7ac8386928._comment
new file mode 100644
index 0000000000..1c778a4ab9
--- /dev/null
+++ b/doc/todo/fsck_option_to_only_show_broken/comment_3_77600b5ce57004e66f9fde7ac8386928._comment
@@ -0,0 +1,15 @@
+[[!comment format=mdwn
+ username="joey"
+ subject="""comment 3"""
+ date="2021-05-10T15:07:06Z"
+ content="""
+Normally the common options are not included in every command's man page
+because there are over 100 lines of them. However, I do think it's worth
+including --quiet on fsck's man page in this specific case and am doing
+that.
+
+Maybe individual command man pages should mention that there are
+also a bunch of common options. Perhaps those should be split out of the
+git-annex man page, like the git-annex-matching-options man page is
+handled.
+"""]]