diff options
author | Joey Hess <joey@kitenet.net> | 2012-11-06 00:52:35 -0400 |
---|---|---|
committer | Joey Hess <joey@kitenet.net> | 2012-11-06 00:59:20 -0400 |
commit | 244c675db0b59c260ac93d4a96a6be2b40f148e5 (patch) | |
tree | 48d950e78b4623f5b72941dc558e2ee386568f28 /doc | |
parent | 97dec88eab69d0bf3d806bb1f4adf54c1b345f77 (diff) |
add xmppgit command; roughed out xmpp push protocol and design
Diffstat (limited to 'doc')
-rw-r--r-- | doc/design/assistant/xmpp.mdwn | 24 | ||||
-rw-r--r-- | doc/git-annex.mdwn | 4 |
2 files changed, 28 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 diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn index 33a209e76..842139c2b 100644 --- a/doc/git-annex.mdwn +++ b/doc/git-annex.mdwn @@ -486,6 +486,10 @@ subdirectories). With --force, even files whose content is not currently available will be rekeyed. Use with caution. +* xmppgit + + This command is used internally to perform git pulls over XMPP. + # OPTIONS * --force |