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

initial implementation of --explain

Browse source 
Currently it only displays explanations of options like --in and --copies.

In the future, it should explain preferred content expression evaluation
and other decisions.

The explanations of a few things could be better. In particular,
"standard" will just appear as-is (or as "!standard" if it doesn't
match), rather than explaining why the standard preferred content expression
for the group matches or not.

Currently as implemented, it goes to stdout, and so commands like
git-annex find that have custom output will not display --explain
information. Perhaps that should change, dunno.

Sponsored-by: Dartmouth College's DANDI project
This commit is contained in:
Joey Hess 2023-07-25 16:11:06 -04:00
parent cf40e2d4b6
commit f25eeedeac
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
12 changed files with 122 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/git-annex-common-options.mdwn
View file

@ -29,11 +29,17 @@ Most of these options are accepted by all git-annex commands.
* `--verbose`
Enable verbose display.
Enable verbose display. On by default but can be disabled by --quiet.
* `--explain`
Display explanations of what git-annex takes into account when deciding
what to do. The explanations will be inside square brackets.
For example, "[foo is not present here]"
* `--debug`
Display debug messages.
Display debug messages to standard error.
* `--no-debug`