clean up protocol docs

This commit is contained in:
Joey Hess 2012-11-05 15:52:03 -04:00
parent db36b11e28
commit 85c52c4029

View file

@ -36,18 +36,23 @@ To these messages, it adds its own tag as
[extended content](http://xmpp.org/rfcs/rfc6121.html#presence-extended). [extended content](http://xmpp.org/rfcs/rfc6121.html#presence-extended).
The xml namespace is "git-annex" (not an URL because I hate wasting bandwidth). The xml namespace is "git-annex" (not an URL because I hate wasting bandwidth).
To indicate it's pushed changes to a git repo with a given UUID, To indicate it's pushed changes to a git repo with a given UUID, a message
a message that should be sent to all buddies and other clients using the account that should be sent to all buddies and other clients using the account (no
(no explicit pairing needed), a client uses a broadcast presence message with: explicit pairing needed), it uses a broadcast presence message containing:
<git-annex xmlns='git-annex' push="uuid[,uuid...]" /> <git-annex xmlns='git-annex' push="uuid[,uuid...]" />
Multiple UUIDs can be listed when multiple clients were pushed. If the Multiple UUIDs can be listed when multiple clients were pushed. If the
git repo does not have a git-annex UUID, an empty string is used. git repo does not have a git-annex UUID, an empty string is used.
For pairing, a chat message is sent, also using the git-annex tag: To query if other git-annex clients are around, a presence message is used,
containing:
<git-annex xmlns='git-annex' pairing="PairReq uuid" /> <git-annex xmlns='git-annex' query="" />
For pairing, a chat message is sent, containing:
<git-annex xmlns='git-annex' pairing="PairReq|PairAck|PairDone uuid" />
### security ### security