summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2014-04-05 16:04:37 -0400
committerGravatar Joey Hess <joey@kitenet.net>2014-04-05 16:10:39 -0400
commit73050592050239490beb656f2b7e3cde567df237 (patch)
treec1e900fc388af75052fd078fce2feddf75343433 /doc
parent13fe079e1a7c1ce4269c1ceb8113c3603d8abe9a (diff)
git-annex-shell: Added notifychanges command.
This will be used by the remote-daemon to quickly tell when changes have been pushed from some other repository into a ssh remote. Adjusted the remote-daemon protocol to communicate changed shas, rather than git branch refs. This way, it can easily check if a sha is new. This commit was sponsored by Carlos Trijueque Albarran.
Diffstat (limited to 'doc')
-rw-r--r--doc/design/git-remote-daemon.mdwn13
-rw-r--r--doc/git-annex-shell.mdwn5
2 files changed, 16 insertions, 2 deletions
diff --git a/doc/design/git-remote-daemon.mdwn b/doc/design/git-remote-daemon.mdwn
index 714005e6f..0658d4583 100644
--- a/doc/design/git-remote-daemon.mdwn
+++ b/doc/design/git-remote-daemon.mdwn
@@ -80,9 +80,18 @@ the webapp.
## emitted messages
-* `CHANGED $remote $ref ...`
+* `CONNECTED $remote`
- This indicates that the given refs in the named git remote have changed.
+ Send when a connection has been made with a remote.
+
+* `DISCONNECTED $remote`
+
+ Send when connection with a remote has been lost.
+
+* `CHANGED $remote $sha ...`
+
+ This indicates that refs in the named git remote have changed,
+ and indicates the new shas.
* `STATUS $remote $string`
diff --git a/doc/git-annex-shell.mdwn b/doc/git-annex-shell.mdwn
index c015a7bda..c6e8c05c0 100644
--- a/doc/git-annex-shell.mdwn
+++ b/doc/git-annex-shell.mdwn
@@ -65,6 +65,11 @@ first "/~/" or "/~user/" is expanded to the specified home directory.
This commits any staged changes to the git-annex branch.
It also runs the annex-content hook.
+* notifychanges
+
+ This is used by `git-annex remote-daemon` to be notified when
+ refs in the remote repository are changed.
+
* gcryptsetup gcryptid
Sets up a repository as a gcrypt repository.