add xmppgit command; roughed out xmpp push protocol and design

1 files changed, 24 insertions, 0 deletions

diff --git a/doc/design/assistant/xmpp.mdwn b/doc/design/assistant/xmpp.mdwn
index 3c8864021..84d3a5c0e 100644
--- a/doc/design/assistant/xmpp.mdwn
+++ b/doc/design/assistant/xmpp.mdwn
@@ -54,6 +54,30 @@ For pairing, a chat message is sent, containing:
 
 	<git-annex xmlns='git-annex' pairing="PairReq|PairAck|PairDone uuid" />
 
+### git push over XMPP
+
+To request that a peer push to us, a chat message can be sent:
+
+	<git-annex xmlns='git-annex' startpush="" />
+
+When a peer is ready to send a git push, it sends:
+
+	<git-annex xmlns='git-annex' startingpush="" />
+
+The receiver runs `git receive-pack`, and sends back its output in
+one or more chat messages:
+
+	<git-annex xmlns='git-annex' rp="007b27ca394d26a05d9b6beefa1b07da456caa2157d7 refs/heads/git-annex report-status delete-refs side-band-64k quiet ofs-delta" />
+
+The sender replies with the data from `git push`:
+
+	<git-annex xmlns='git-annex' sp="data" />
+
+When `git receive-pack` edits, the receiver indicates its exit
+status:
+
+	<git-annex xmlns='git-annex' rpdone="0" />
+
 ### security
 
 Data git-annex sends over XMPP will be visible to the XMPP