# HG changeset patch # User Steve Losh # Date 1278992472 14400 # Node ID 84fc0674789f8e908a2b666af89081b7c7a1fe3a # Parent 4ab3f1cb454af94ae0c72a71cbe85da8283d773e hg-review: Update documentation. diff -r 4ab3f1cb454a -r 84fc0674789f hg-review/_sources/api.txt --- a/hg-review/_sources/api.txt Mon Jul 12 23:29:15 2010 -0400 +++ b/hg-review/_sources/api.txt Mon Jul 12 23:41:12 2010 -0400 @@ -19,11 +19,44 @@ subprocesses to avoid breaking, but this is a tradeoff that the author feels is worth making. -Data Repository ---------------- +Data Repository Layout +---------------------- + +The structure of hg-review's data repository looks like this:: + + your-project/ + | + +-- .hg/ + | | + | +-- review + | | | + | | +-- {{ changeset hash }} + | | | | + | | | +-- .exists + | | | | + | | | +-- comments + | | | | | + | | | | +-- {{ comment hash }} + | | | | | + | | | | `-- other comments... + | | | | + | | | +-- signoffs + | | | | + | | | +-- {{ signoff hash }} + | | | | + | | | `-- other signoffs ... + | | | + | | `-- other changesets ... + | | + | `-- other files ... + | + `-- other files ... File Formats ------------ +Command Line Interface +---------------------- + Python API ---------- diff -r 4ab3f1cb454a -r 84fc0674789f hg-review/api.html --- a/hg-review/api.html Mon Jul 12 23:29:15 2010 -0400 +++ b/hg-review/api.html Mon Jul 12 23:41:12 2010 -0400 @@ -62,12 +62,44 @@ 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

+
+

Data Repository Layout

+

The structure of hg-review’s data repository looks like this:

+
your-project/
+|
++-- .hg/
+|   |
+|   +-- review
+|   |   |
+|   |   +-- {{ changeset hash }}
+|   |   |   |
+|   |   |   +-- .exists
+|   |   |   |
+|   |   |   +-- comments
+|   |   |   |   |
+|   |   |   |   +-- {{ comment hash }}
+|   |   |   |   |
+|   |   |   |   `-- other comments...
+|   |   |   |
+|   |   |   +-- signoffs
+|   |   |       |
+|   |   |       +-- {{ signoff hash }}
+|   |   |       |
+|   |   |       `-- other signoffs ...
+|   |   |
+|   |   `-- other changesets ...
+|   |
+|   `-- other files ...
+|
+`-- other files ...
+

File Formats

+
+

Command Line Interface

+

Python API

@@ -82,8 +114,9 @@

Table Of Contents