mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

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

Browse source
This commit is contained in:
Joey Hess 2021-05-10 11:11:50 -04:00
parent c88fdd91f9
commit 56ccc0302e
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
3 changed files with 24 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
doc/git-annex-fsck.mdwn
View file

@ -110,6 +110,13 @@ better format.
Messages that would normally be output to standard error are included in Messages that would normally be output to standard error are included in
the json instead. 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 # SEE ALSO
[[git-annex]](1) [[git-annex]](1)

2
doc/todo/fsck_option_to_only_show_broken.mdwn
View file

@ -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. `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`. 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"]]

15
doc/todo/fsck_option_to_only_show_broken/comment_3_77600b5ce57004e66f9fde7ac8386928._comment Normal file
View file

@ -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.
"""]]