diff mercurial/help/internals/wireprotocol.txt @ 37537:be5d4749edc0

wireproto: port pushkey command to wire protocol version 2 It doesn't do output redirection yet. And I'd love to generally overhaul the pushkey protocol for wire protocol version 2. But this will be a bit of effort. Let's do it as a follow-up. Differential Revision: https://phab.mercurial-scm.org/D3204
author Gregory Szorc <gregory.szorc@gmail.com>
date Fri, 06 Apr 2018 17:39:40 -0700
parents 69e46c1834ac
children 89fed81bbb6c
line wrap: on
line diff
--- a/mercurial/help/internals/wireprotocol.txt	Fri Apr 06 17:21:16 2018 -0700
+++ b/mercurial/help/internals/wireprotocol.txt	Fri Apr 06 17:39:40 2018 -0700
@@ -1777,3 +1777,22 @@
 The response is a map with bytestring keys and values.
 
 TODO consider using binary to represent nodes in certain pushkey namespaces.
+
+pushkey
+-------
+
+Set a value using the ``pushkey`` protocol.
+
+The command receives the following arguments:
+
+namespace
+   (bytestring) Pushkey namespace to operate on.
+key
+   (bytestring) The pushkey key to set.
+old
+   (bytestring) Old value for this key.
+new
+   (bytestring) New value for this key.
+
+TODO consider using binary to represent nodes is certain pushkey namespaces.
+TODO better define response type and meaning.