summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2016-02-12 16:43:51 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2016-02-12 16:43:51 -0400
commitf246621a92d2dae3d7d9d6358e6916097729f5c9 (patch)
treeadce8f8f7a453b0a28c2dc673f834c03202b61d6 /doc
parentadf01450160b6c9f003b3877fc45d32aef6ce99b (diff)
checkpresentkey: Allow to be run without an explicit remote and add --batch
* checkpresentkey: Allow to be run without an explicit remote. * checkpresentkey: Added --batch.
Diffstat (limited to 'doc')
-rw-r--r--doc/git-annex-checkpresentkey.mdwn18
-rw-r--r--doc/todo/checkpresentkey_without_explicit_remote.mdwn2
-rw-r--r--doc/todo/checkpresentkey_without_explicit_remote/comment_1_eab7b9d6d026675328d0e743a385ba8a._comment9
3 files changed, 26 insertions, 3 deletions
diff --git a/doc/git-annex-checkpresentkey.mdwn b/doc/git-annex-checkpresentkey.mdwn
index fe521cb42..5e85e569f 100644
--- a/doc/git-annex-checkpresentkey.mdwn
+++ b/doc/git-annex-checkpresentkey.mdwn
@@ -4,16 +4,28 @@ git-annex checkpresentkey - check if key is present in remote
# SYNOPSIS
-git annex checkpresentkey `key remote`
+git annex checkpresentkey `key` `[remote]`
# DESCRIPTION
This plumbing-level command verifies if the specified key's content
is present in the specified remote.
+When no remote is specified, it verifies if the key's content is present
+somewhere, checking accessible remotes until it finds the content.
+
Exits 0 if the content is verified present, or 1 if it is verified to not
-be present. If there is a problem checking the remote, the special
-exit code 100 is used, and an error message is output to stderr.
+be present. If there is a problem, the special exit code 100 is used,
+and an error message is output to stderr.
+
+# OPTIONS
+
+* `--batch`
+
+ Enables batch mode. In this mode, the `key` is not specified at the
+ command line, but the `remote` may still be. Lines containing keys are
+ read from stdin, and a line is output with "1" if the key is verified to
+ be present, and "0" otherwise.
# SEE ALSO
diff --git a/doc/todo/checkpresentkey_without_explicit_remote.mdwn b/doc/todo/checkpresentkey_without_explicit_remote.mdwn
index 372c67d70..b4fa33945 100644
--- a/doc/todo/checkpresentkey_without_explicit_remote.mdwn
+++ b/doc/todo/checkpresentkey_without_explicit_remote.mdwn
@@ -1,3 +1,5 @@
While being asked to check if file is available from "[datalad-archives]" remote I need to check if the archive's key available. Ideally I wish I could ask through the ongoing interaction protocol, but if not, I could use smth like 'git annex checkpresentkey' but that one demands specification also of a remote which to check. In my case I just want to know if that key is available from any remote, so I could confirm that the file is still present in our archives remote, i.e. that it could be retrieved later on
[[!meta author=yoh]]
+
+> [[done]]] --[[Joey]]
diff --git a/doc/todo/checkpresentkey_without_explicit_remote/comment_1_eab7b9d6d026675328d0e743a385ba8a._comment b/doc/todo/checkpresentkey_without_explicit_remote/comment_1_eab7b9d6d026675328d0e743a385ba8a._comment
new file mode 100644
index 000000000..600cae51b
--- /dev/null
+++ b/doc/todo/checkpresentkey_without_explicit_remote/comment_1_eab7b9d6d026675328d0e743a385ba8a._comment
@@ -0,0 +1,9 @@
+[[!comment format=mdwn
+ username="joey"
+ subject="""comment 1"""
+ date="2016-02-12T20:07:30Z"
+ content="""
+Makes sense, and also I will add a --batch mode to it.
+
+Done.
+"""]]