hg.stevelosh.com > docs.stevelosh.com

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

    <title>hg-review documentation &mdash; hg-review vpre-alpha documentation</title>
    <link rel="stylesheet" href="_static/review.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     'pre-alpha',
        COLLAPSE_MODINDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="hg-review vpre-alpha documentation" href="#" />
    <link rel="next" title="Overview" href="overview.html" />
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="overview.html" title="Overview"
             accesskey="N">next</a> |</li>
        <li><a href="#">hg-review vpre-alpha documentation</a> &raquo;</li>
      </ul>
    </div>

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">

  <div class="section" id="hg-review-documentation">
<h1>hg-review documentation<a class="headerlink" href="#hg-review-documentation" title="Permalink to this headline">¶</a></h1>
<p>hg-review is a <a class="reference external" href="http://hg-scm.org">Mercurial</a> extension for performing
distributed <a class="reference external" href="http://en.wikipedia.org/wiki/Code_review">code review</a>.</p>
<p>&#8220;Distributed code review&#8221; means you can do cool stuff like this:</p>
<div align="center" class="align-center"><img alt="hg-review overview diagram" class="align-center" src="_images/overview.png" /></div>
<div class="section" id="quickstart">
<h2>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this headline">¶</a></h2>
<p>If you&#8217;re impatient and want to play with hg-review right away, here&#8217;s what you
need to do.</p>
<p>First, clone the extension somewhere:</p>
<div class="highlight-python"><pre>hg clone http://bitbucket.org/sjl/hg-review/</pre>
</div>
<p>Then add it to your <tt class="docutils literal"><span class="pre">~/.hgrc</span></tt> file:</p>
<div class="highlight-python"><pre>[extensions]
review = [path to]/hg-review/review/</pre>
</div>
<p>Now you need a repository that has code review enabled.  Luckily, you&#8217;ve
already got one &#8211; hg-review uses itself for code review.</p>
<p><tt class="docutils literal"><span class="pre">cd</span></tt> into the directory you cloned hg-review to and start the web interface:</p>
<div class="highlight-python"><pre>cd hg-review
hg review --web</pre>
</div>
<p>Open <a class="reference external" href="http://localhost:8080/">http://localhost:8080/</a> in your browser of choice and poke around. Check
out the <a class="reference external" href="overview.html"><em>Overview</em></a> when you&#8217;re ready to learn more.</p>
</div>
<div class="section" id="user-s-guide">
<h2>User&#8217;s Guide<a class="headerlink" href="#user-s-guide" title="Permalink to this headline">¶</a></h2>
<p>If you want to use hg-review for anything more than some simple poking around,
this is the place to start.</p>
<ul>
<li class="toctree-l1"><a class="reference external" href="overview.html">Overview</a><ul>
<li class="toctree-l2"><a class="reference external" href="overview.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference external" href="overview.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference external" href="overview.html#reporting-bugs">Reporting Bugs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference external" href="concepts.html">Concepts</a><ul>
<li class="toctree-l2"><a class="reference external" href="concepts.html#code-review-basics">Code Review Basics</a></li>
<li class="toctree-l2"><a class="reference external" href="concepts.html#other-code-review-tools">Other Code Review Tools</a></li>
<li class="toctree-l2"><a class="reference external" href="concepts.html#distributed-code-review">Distributed Code Review</a></li>
<li class="toctree-l2"><a class="reference external" href="concepts.html#review-data">Review Data</a></li>
<li class="toctree-l2"><a class="reference external" href="concepts.html#repository-structure">Repository Structure</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference external" href="webui.html">Web Interface</a><ul>
<li class="toctree-l2"><a class="reference external" href="webui.html#running-locally">Running Locally</a></li>
<li class="toctree-l2"><a class="reference external" href="webui.html#deployment-to-a-server">Deployment to a Server</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference external" href="cli.html">Command Line Interface</a><ul>
<li class="toctree-l2"><a class="reference external" href="cli.html#review"><tt class="docutils literal"><span class="pre">review</span></tt></a></li>
<li class="toctree-l2"><a class="reference external" href="cli.html#init"><tt class="docutils literal"><span class="pre">--init</span></tt></a></li>
<li class="toctree-l2"><a class="reference external" href="cli.html#comment"><tt class="docutils literal"><span class="pre">--comment</span></tt></a></li>
<li class="toctree-l2"><a class="reference external" href="cli.html#signoff"><tt class="docutils literal"><span class="pre">--signoff</span></tt></a></li>
<li class="toctree-l2"><a class="reference external" href="cli.html#edit"><tt class="docutils literal"><span class="pre">--edit</span></tt></a></li>
<li class="toctree-l2"><a class="reference external" href="cli.html#check"><tt class="docutils literal"><span class="pre">--check</span></tt></a></li>
<li class="toctree-l2"><a class="reference external" href="cli.html#web"><tt class="docutils literal"><span class="pre">--web</span></tt></a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="developer-s-guide">
<h2>Developer&#8217;s Guide<a class="headerlink" href="#developer-s-guide" title="Permalink to this headline">¶</a></h2>
<p>If you want to integrate hg-review with your own application or Mercurial
extension, or hack on hg-review itself, this is what you need to know.</p>
<ul>
<li class="toctree-l1"><a class="reference external" href="api.html">API</a><ul>
<li class="toctree-l2"><a class="reference external" href="api.html#data-repository-layout">Data Repository Layout</a></li>
<li class="toctree-l2"><a class="reference external" href="api.html#file-formats">File Formats</a></li>
<li class="toctree-l2"><a class="reference external" href="api.html#command-line-interface">Command Line Interface</a></li>
<li class="toctree-l2"><a class="reference external" href="api.html#internal-python-api">Internal Python API</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference external" href="hacking.html">Hacking hg-review</a><ul>
<li class="toctree-l2"><a class="reference external" href="hacking.html#rough-guidelines">Rough Guidelines</a></li>
<li class="toctree-l2"><a class="reference external" href="hacking.html#layout">Layout</a></li>
<li class="toctree-l2"><a class="reference external" href="hacking.html#testing">Testing</a></li>
<li class="toctree-l2"><a class="reference external" href="hacking.html#documentation">Documentation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference external" href="licensing.html">Licensing</a></li>
</ul>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <h3><a href="#">Table Of Contents</a></h3>
            <ul>
<li><a class="reference external" href="#">hg-review documentation</a><ul>
<li><a class="reference external" href="#quickstart">Quickstart</a></li>
<li><a class="reference external" href="#user-s-guide">User&#8217;s Guide</a><ul>
</ul>
</li>
<li><a class="reference external" href="#developer-s-guide">Developer&#8217;s Guide</a><ul>
</ul>
</li>
</ul>
</li>
</ul>

            <h4>Next topic</h4>
            <p class="topless"><a href="overview.html"
                                  title="next chapter">Overview</a></p>
            <h3>This Page</h3>
            <ul class="this-page-menu">
              <li><a href="_sources/index.txt"
                     rel="nofollow">Show Source</a></li>
            </ul>
          <div id="searchbox" style="display: none">
            <h3>Quick search</h3>
              <form class="search" action="search.html" method="get">
                <input type="text" name="q" size="18" />
                <input type="submit" value="Go" />
                <input type="hidden" name="check_keywords" value="yes" />
                <input type="hidden" name="area" value="default" />
              </form>
              <p class="searchtip" style="font-size: 90%">
              Enter search terms or a module, class or function name.
              </p>
          </div>
          <script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="overview.html" title="Overview"
             >next</a> |</li>
        <li><a href="#">hg-review vpre-alpha documentation</a> &raquo;</li>
      </ul>
    </div>
    <div class="footer">
      &copy; Copyright 2010, Steve Losh and contributors.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.7.
    </div>
  </body>
</html>
author	Steve Losh <steve@stevelosh.com>
date	Thu, 13 Jun 2024 13:05:28 -0400
parents	4d3e09234d86
children	(none)