summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2013-10-28 14:50:17 -0400
committerGravatar Joey Hess <joey@kitenet.net>2013-10-28 14:50:17 -0400
commit50c6c7406ba4c310e3567dc7d812330ef79098d2 (patch)
tree925449e6e9382646834b75968e4d3b0b2014dd06 /doc
parenta86cd4bc8215f01ffe2ba06c63be56656d8ae7cf (diff)
add --want-get and --want-drop options
New --want-get and --want-drop options which can be used to test preferred content settings. For example, "git annex find --in . --want-drop"
Diffstat (limited to 'doc')
-rw-r--r--doc/git-annex.mdwn12
-rw-r--r--doc/preferred_content.mdwn10
-rw-r--r--doc/todo/whishlist:_git_annex_drop_--dry-run.mdwn2
3 files changed, 24 insertions, 0 deletions
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index 693ce57ee..8d27bd7a7 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -947,6 +947,18 @@ file contents are present at either of two repositories.
The size can be specified with any commonly used units, for example,
"0.5 gb" or "100 KiloBytes"
+* `--want-get`
+
+ Matches files that the preferred content settings for the repository
+ make it want to get. Note that this will match even files that are
+ already present, unless limited with eg, `--not --in .`
+
+* `--want-drop`
+
+ Matches files that the preferred content settings for the repository
+ make it want to drop. Note that this will match even files that have
+ already been dropped, unless limited with eg, `--in .`
+
* `--not`
Inverts the next file matching option. For example, to only act on
diff --git a/doc/preferred_content.mdwn b/doc/preferred_content.mdwn
index 0f284c4c1..6a5364f67 100644
--- a/doc/preferred_content.mdwn
+++ b/doc/preferred_content.mdwn
@@ -84,6 +84,16 @@ The name of the directory can be configured using
(If no directory name is configured, it uses "public" by default.)
+## testing preferred content settings
+
+To check at the command line which files are matched by preferred content
+settings, you can use the --want-get and --want-drop options.
+
+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.
+
## standard expressions
git-annex comes with some standard preferred content expressions, that can
diff --git a/doc/todo/whishlist:_git_annex_drop_--dry-run.mdwn b/doc/todo/whishlist:_git_annex_drop_--dry-run.mdwn
index 0c67d1629..6bbfd7a4d 100644
--- a/doc/todo/whishlist:_git_annex_drop_--dry-run.mdwn
+++ b/doc/todo/whishlist:_git_annex_drop_--dry-run.mdwn
@@ -1,3 +1,5 @@
It'd be useful to be able to see what `git annex drop` would do *before* asking it to drop any files.
For example, I just set up my preferred contents expressions, and I don't know if I got them right. Before dropping anything from this repo, it'd be nice to check what would happen. I know git annex drop will only drop files that are above their minimum numcopies, but I'd still like to avoid heavyweight copying in case I got my preferred contents expressions wrong.
+
+> [[done]]; added --want-get and --want-drop. --[[Joey]]