hgext/reviewboard/README.rst
author Gregory Szorc <gps@mozilla.com>
Sat, 24 Jan 2015 19:42:03 -0800
changeset 360256 17f4091a1f7b876e4d3a4f50ef06e3886ba80e03
parent 358868 8119af77789585e0d289aba7abeda7d28c8acf61
permissions -rw-r--r--
testing: prevent double virtualenv activation The bootstrap code was potentially activating a virtualenv on top of itself. This results in the virtualenv's bin directory always being first in PATH. This threw off hg binary detection when running under --with-hg. Prevent double virtualenv activation.

================================
Review Board Mercurial Extension
================================

This extension allows Mercurial to publish Review Board reviews by
pushing to a repository.

This extension consists of both a client and server component. The
two pieces communicate with each other over the Mercurial wire
protocol during push operations. The client passes necessary
review information to the server and the server talks to a
Review Board API to create the review.

Wire Protocol
=============

The server implements a new command, ``reviewboard``. The command
input and output is a newline-delimited message.

The first line of the message is an integer version number of the
protocol version.

Request Version 1
-----------------

The lines of the request are prefixed with a line type. The following
prefixes are supported:

``bzusername``
  Bugzilla username (%XX encoded)
``bzpassword``
  Bugzilla password (%XX encoded)
``reviewidentifier``
  Primary review identifier (%XX encoded)
``csetreview``
  Describes a changeset to review.

  Consists of a 40 digit hex node of the changeset followed by an optional
  review id to update.

The server will create a review of the changesets specified using
review identifier specified to track the review.

Response Version 1
------------------

The lines of the response are prefixed with a line type. The following
prefixes are supported:

``display``
   These lines should be displayed on the client.
``reviewid``
   The identifier of the main Review Board review for this push.
``csetreview``
   Consists of the 40 digit hex node of a changeset followed by its
   review identifier.
``reviewdata``
   Contains metadata for an individual review.

   Fields are space delimited. The fields are ``review id``, ``field``,
   and ``field value``. The value is %XX encoded.