diff options
author | Joey Hess <joeyh@joeyh.name> | 2015-04-18 16:04:25 -0400 |
---|---|---|
committer | Joey Hess <joeyh@joeyh.name> | 2015-04-18 16:04:35 -0400 |
commit | ea2180a6c141411f8ebdd041f065fae54ff2f780 (patch) | |
tree | ef19371742d05d8f2562ee49abc20db315983000 /doc | |
parent | 56e6d094aafd0df4b6e9f7abb83ff87b352aead5 (diff) |
required: New command, like wanted, but for required content.
Also refactored some code to reduce duplication.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/git-annex-preferred-content.mdwn | 7 | ||||
-rw-r--r-- | doc/git-annex.mdwn | 8 | ||||
-rw-r--r-- | doc/required_content.mdwn | 3 | ||||
-rw-r--r-- | doc/todo/command_line_interface_for_required_content_setthings.mdwn | 2 |
4 files changed, 19 insertions, 1 deletions
diff --git a/doc/git-annex-preferred-content.mdwn b/doc/git-annex-preferred-content.mdwn index 95dae8c14..49512f465 100644 --- a/doc/git-annex-preferred-content.mdwn +++ b/doc/git-annex-preferred-content.mdwn @@ -10,6 +10,13 @@ using `git annex vicfg` or `git annex wanted`. They are used by the `--auto` option, by `git annex sync --content`, and by the git-annex assistant. +While preferred content expresses a preference, it can be overridden +by simply using `git annex drop`. On the other hand, required content +settings are enforced; `git annex drop` will refuse to drop a file if +doing so would violate its required content settings. A repository's +required content can be configured using `git annex vicfg` or +`git annex required`. + Preferred content expressions are similar, but not identical to the [[git-annex-matching-options]](1), just without the dashes. For example: diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn index 6fd10aed0..3dc54a308 100644 --- a/doc/git-annex.mdwn +++ b/doc/git-annex.mdwn @@ -264,8 +264,16 @@ subdirectories). * `groupwanted groupname [expression]` + Get or set groupwanted expression. + See [[git-annex-groupwanted]](1) for details. +* `required repository [expression]` + + Get or set required content expression. + + See [[git-annex-required]](1) for details. + * `schedule repository [expression]` Get or set scheduled jobs. diff --git a/doc/required_content.mdwn b/doc/required_content.mdwn index 91c5614a8..e17951d9d 100644 --- a/doc/required_content.mdwn +++ b/doc/required_content.mdwn @@ -6,7 +6,8 @@ archival repositories, and also require that one copy be stored offsite. The format of required content expressions is the same as [[preferred_content]] expressions. -Required content settings can be edited using `git annex vicfg`. +Required content settings can be edited using `git annex vicfg` +or set using `git annex required`. Each repository can have its own settings, and other repositories will try to honor those settings when interacting with it. diff --git a/doc/todo/command_line_interface_for_required_content_setthings.mdwn b/doc/todo/command_line_interface_for_required_content_setthings.mdwn index 1334b151a..30889f8bb 100644 --- a/doc/todo/command_line_interface_for_required_content_setthings.mdwn +++ b/doc/todo/command_line_interface_for_required_content_setthings.mdwn @@ -9,3 +9,5 @@ used feature, and vicfg can already configure it. one when it comes to that. Oh well.) --[[Joey]] + +> [[done]] --[[Joey]] |