mention --explain

Sponsored-by: Dartmouth College's DANDI project

diff --git a/doc/git-annex-preferred-content.mdwn b/doc/git-annex-preferred-content.mdwn
index e12809f55637cfcff5f8cc1b29414320761a6601..ea429228cf440d20746ad064e025ec7ff3912d8a 100644 (file)
--- a/doc/git-annex-preferred-content.mdwn
+++ b/doc/git-annex-preferred-content.mdwn
@@ -283,6 +283,13 @@ For example, git annex find --want-get --not --in . will find all the files
 that git annex get --auto will want to get, and git annex find --want-drop --in
 . will find all the files that git annex drop --auto will want to drop.
 
+The --explain option can be used to understand why a complex preferred
+content expression matches or fails to match. The expression will
+be displayed, with each term followed by "[TRUE]" or "[FALSE]" to indicate
+the value. Irrelevant terms will be ommitted from the explanation,
+for example "exclude=* and copies=1"` will be displayed as 
+`"exclude=*[FALSE]"`
+
 # SEE ALSO
 
 [[git-annex]](1)