diff options
| author |  Joey Hess <joey@kitenet.net> | 2013-12-27 02:56:34 -0400 |
|---|---|---|
| committer | Joey Hess <joey@kitenet.net> | 2013-12-27 02:56:52 -0400 |
| commit | 690c690e97ecc3808755e95acd0d45bfe03ed366 (patch) | |
| tree | fa68dc564767894834caa7c221062522be66269f | |
| parent | 8ad91f287cf87b3a5a849d997de35210a0e9f2b7 (diff) | |
improve comments
| -rw-r--r-- | doc/design/external_special_remote_protocol.mdwn | 3 | ||||
| -rwxr-xr-x | doc/special_remotes/external/example.sh | 9 |
2 files changed, 8 insertions, 4 deletions
diff --git a/doc/design/external_special_remote_protocol.mdwn b/doc/design/external_special_remote_protocol.mdwn index cede16e16..86f9399c0 100644 --- a/doc/design/external_special_remote_protocol.mdwn +++ b/doc/design/external_special_remote_protocol.mdwn @@ -98,8 +98,7 @@ The following requests *must* all be supported by the special remote. Requests the transfer of a key. For Send, the File is the file to upload; for Receive the File is where to store the download. Note that the File should not influence the filename used on the remote. - The filename used should be derived from the Key, and will not contain - any whitespace. + The filename will not contain any whitespace. Multiple transfers might be requested by git-annex, but it's fine for the program to serialize them and only do one at a time. * `CHECKPRESENT Key` diff --git a/doc/special_remotes/external/example.sh b/doc/special_remotes/external/example.sh index c9412c506..c74279e3f 100755 --- a/doc/special_remotes/external/example.sh +++ b/doc/special_remotes/external/example.sh @@ -52,9 +52,14 @@ while read line; do INITREMOTE) # Do anything necessary to create resources # used by the remote. Try to be idempotent. + # # Use GETCONFIG to get any needed configuration # settings, and SETCONFIG to set any persistent # configuration settings. + # + # (Note that this is not run every time, only when + # git annex initremote or git annex enableremote is + # run.) getconfig directory mydirectory="$RET" if [ -z "$mydirectory" ]; then @@ -91,7 +96,7 @@ while read line; do RETRIEVE) # Retrieve from a location based on # the key, outputting to the file. - # XXX when easy, send PROGRESS + # XXX when easy to do, send PROGRESS calclocation "$key" if runcmd cp -v "$LOC" "$file"; then echo TRANSFER-SUCCESS RETRIEVE "$key" @@ -110,7 +115,7 @@ while read line; do if [ -d "$mydirectory" ]; then echo CHECKPRESENT-FAILURE "$key" else - # If the directory does not exist, + # When the directory does not exist, # the remote is not available. # (A network remote would similarly # fail with CHECKPRESENT-UNKNOWN |