explain in the required manpage the difference with wanted

This commit is contained in:
Antoine Beaupré 2015-05-29 12:02:22 -04:00
parent 78c74c9a4f
commit 5b48c466d3

View file

@ -9,7 +9,7 @@ git annex required `repository [expression]`
# DESCRIPTION # DESCRIPTION
When run with an expression, configures the content that is required 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: For example:
@ -18,10 +18,20 @@ For example:
Without an expression, displays the current required content setting Without an expression, displays the current required content setting
of the repository. 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 # SEE ALSO
[[git-annex]](1) [[git-annex]](1)
[[git-annex-wanted]](1)
[[git-annex-preferred-content]](1)
# AUTHOR # AUTHOR
Joey Hess <id@joeyh.name> Joey Hess <id@joeyh.name>