# HG changeset patch
# User Steve Losh
# Date 1278991755 14400
# Node ID 4ab3f1cb454af94ae0c72a71cbe85da8283d773e
# Parent ff965bcaa2af9b2373259d41c510dc6cdc711332
hg-review: Update documentation.
diff -r ff965bcaa2af -r 4ab3f1cb454a hg-review/.buildinfo
--- a/hg-review/.buildinfo Sat Jul 10 13:57:04 2010 -0400
+++ b/hg-review/.buildinfo Mon Jul 12 23:29:15 2010 -0400
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: f3b94c01fe640fdba1ea8a00e1ad3880
+config: 52b5aee6d9021061dca6adea6e3057e9
tags: fbb0d17656682115ca4d033fb2f83ba1
diff -r ff965bcaa2af -r 4ab3f1cb454a hg-review/_sources/api.txt
--- a/hg-review/_sources/api.txt Sat Jul 10 13:57:04 2010 -0400
+++ b/hg-review/_sources/api.txt Mon Jul 12 23:29:15 2010 -0400
@@ -1,6 +1,24 @@
API
===
+hg-review takes Mercurial's approach to API stability:
+
+* The command line interface is fairly stable and will not break often.
+* File formats will not change often.
+* The internal implementation may change frequently -- there are no guarantees
+ of stability.
+
+Providing a stable CLI means that (possibly non-GPL) programs can interact with
+hg-review easily without fear of constant breaking.
+
+Stable file formats mean that older versions of hg-review will be able to work
+with review data from newer versions (albeit with reduced functionality).
+
+*Not* providing a stable internal implementation allows hg-review's code to be
+kept clean and elegant. It means that Python programs will needs to use
+subprocesses to avoid breaking, but this is a tradeoff that the author feels is
+worth making.
+
Data Repository
---------------
diff -r ff965bcaa2af -r 4ab3f1cb454a hg-review/_sources/index.txt
--- a/hg-review/_sources/index.txt Sat Jul 10 13:57:04 2010 -0400
+++ b/hg-review/_sources/index.txt Mon Jul 12 23:29:15 2010 -0400
@@ -60,7 +60,7 @@
.. toctree::
:maxdepth: 2
- dev
+ api
hacking
licensing
diff -r ff965bcaa2af -r 4ab3f1cb454a hg-review/_sources/webui.txt
--- a/hg-review/_sources/webui.txt Sat Jul 10 13:57:04 2010 -0400
+++ b/hg-review/_sources/webui.txt Mon Jul 12 23:29:15 2010 -0400
@@ -116,6 +116,7 @@
ANON_USER = 'Anonymous '
SITE_ROOT = 'http://yoursite.com/optional/path'
TITLE = 'Your Project'
+ PROJECT_URL = 'http://bitbucket.org/your/project/' # or None
All that's left is to point your WSGI server at this script and fire it up. How
you do that depends on your WSGI server. A sample configuration file for
diff -r ff965bcaa2af -r 4ab3f1cb454a hg-review/api.html
--- a/hg-review/api.html Sat Jul 10 13:57:04 2010 -0400
+++ b/hg-review/api.html Mon Jul 12 23:29:15 2010 -0400
@@ -20,6 +20,7 @@
+
@@ -30,6 +31,9 @@
index
hg-review takes Mercurial’s approach to API stability:
+
+
The command line interface is fairly stable and will not break often.
+
File formats will not change often.
+
The internal implementation may change frequently – there are no guarantees
+of stability.
+
+
Providing a stable CLI means that (possibly non-GPL) programs can interact with
+hg-review easily without fear of constant breaking.
+
Stable file formats mean that older versions of hg-review will be able to work
+with review data from newer versions (albeit with reduced functionality).
+
Not providing a stable internal implementation allows hg-review’s code to be
+kept clean and elegant. It means that Python programs will needs to use
+subprocesses to avoid breaking, but this is a tradeoff that the author feels is
+worth making.