aboutsummaryrefslogtreecommitdiff
path: root/doc/git-annex-required.mdwn
diff options
context:
space:
mode:
authorGravatar Antoine Beaupré <anarcat@koumbit.org>2015-05-29 12:02:22 -0400
committerGravatar Antoine Beaupré <anarcat@koumbit.org>2015-05-29 12:02:22 -0400
commitdc27de1f2b8a2ae13db947f99435b38c5fa01f3a (patch)
treec5b68f03ae7a515e7e60456432e74b00dd2f37b1 /doc/git-annex-required.mdwn
parent6aa866df4661093857b66f2d6a2a64965b39feb1 (diff)
explain in the required manpage the difference with wanted
Diffstat (limited to 'doc/git-annex-required.mdwn')
-rw-r--r--doc/git-annex-required.mdwn12
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/git-annex-required.mdwn b/doc/git-annex-required.mdwn
index cde3cd6ab..8239ac7d5 100644
--- a/doc/git-annex-required.mdwn
+++ b/doc/git-annex-required.mdwn
@@ -9,7 +9,7 @@ git annex required `repository [expression]`
# DESCRIPTION
When run with an expression, configures the content that is required
-to be held in the archive. See [[git-annex-preferred-content]](1)
+to be held in the archive.
For example:
@@ -18,10 +18,20 @@ For example:
Without an expression, displays the current required content setting
of the repository.
+While [[git-annex-wanted]] is just a preference,
+[[git-annex-required]] designates content that should really not be
+removed. For example a file that is `wanted` can be removed with `git
+annex drop`, but if that file is `required`, it would need to be
+removed with `git annex drop --force`.
+
# SEE ALSO
[[git-annex]](1)
+[[git-annex-wanted]](1)
+
+[[git-annex-preferred-content]](1)
+
# AUTHOR
Joey Hess <id@joeyh.name>