docs/api: add the repo layout in ascii art
| author |
Steve Losh <steve@stevelosh.com> |
| date |
Mon, 12 Jul 2010 23:38:39 -0400 |
| parents |
6c9b5986c7e1
|
| children |
d3edf7c43e7a
|
| branches/tags |
initial-docs |
| files |
docs/api.rst |
Changes
--- a/docs/api.rst Mon Jul 12 23:28:47 2010 -0400
+++ b/docs/api.rst Mon Jul 12 23:38:39 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
----------