# HG changeset patch # User Steve Losh # Date 1278992319 14400 # Node ID 959fb4d581f62af6bb632a6383a6fbea90c94129 # Parent 6c9b5986c7e133ed9211c979b12d63876f0560ac docs/api: add the repo layout in ascii art diff -r 6c9b5986c7e1 -r 959fb4d581f6 docs/api.rst --- 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 ----------