Updates.

2 files changed, 63 insertions, 20 deletions

diff --git a/doc/er-diagram.dia b/doc/er-diagram.dia
index 79c1bb6..cbff809 100644
--- a/doc/er-diagram.dia
+++ b/doc/er-diagram.dia
diff --git a/doc/notes.txt b/doc/notes.txt
index 29062c8..2611699 100644
--- a/doc/notes.txt
+++ b/doc/notes.txt
@@ -28,6 +28,69 @@ A -timestamp value t has the following semantics:
 Note: The -sha1 option requires exact matching and is thus less powerful than -timestamp.
 
 
+----------------------------------
+
+Use case 1: Add a benchmark:
+
+    ./bmc add -benchmark <test case> <test function> <data tag>
+
+----------------------------------
+
+Use case 2: Add a metric:
+
+    ./bmc add -metric <metric>
+
+    Note: walltime, cputicks, callgrind, and events should be added upon installation.
+
+----------------------------------
+
+Use case 3: Add a platform:
+
+    ./bmc add -platform <platform>
+
+    Notes:
+    - The platform typically identifies a particular OS/compiler combination.
+    - The official platforms supported by Qt (linux-g++, solaris-cc-64 etc.) should
+      be added upon installation.
+
+----------------------------------
+
+Use case 4: Add a host:
+
+    ./bmc add -host <host> [<details>]
+
+  Note: The host identifies a physical machine.
+
+----------------------------------
+
+Use case 5: Add a branch:
+
+    ./bmc add -branch <git repo> <git branch>
+
+    Note: qt/master, qt/45, qt/46, qt/... should be added upon installation.
+
+----------------------------------
+
+Use case 6: Add new results:
+
+    ./bmc add -results <xml file> <platform> <host> <product git repo> [<product git dir>]
+
+    Notes:
+       - <product git dir> must refer to a directory accessible from the local
+         file system and the git command needs to be installed (i.e. the program
+         needs to run git commands from <product git dir>).
+         By default, <product git dir> is the current directory.
+       - The new results are assumed to have been generated using a product
+         built from a clean checkout of the current head commit of the current git branch
+         in <product git dir>.
+       - The sha1 to be stored in the database is assumed to be the current head commit in
+         <product git dir> (extracted running 'git log -1 HEAD --pretty=format:"%H"').
+       - The timestamp to be stored in the database is the Unix timestamp of the committer
+         date (extracted running 'git log -1 HEAD --pretty=format:"%ct"').
+       - <product git repo> must be passed explicitly since it cannot in general
+         be derived from <product git dir> (e.g. in the case of a local, standalone
+         repository).
+
 ----------------------
 
 Use case 1: Compare results for a given branch since a given snapshot:
@@ -54,26 +117,6 @@ Use case 3: Compare a result of a given branch directly to an unregistered
     value/iterations pair that matches the benchmark and metric in the
     BMCONTEXT.
 
-----------------------------------
-
-Use case 4: Add new results:
-
-    ./bmc add -results <xml file> -platform <platform> -host <host> \
-        -gitrepo <product git repo> [-gitdir <product git dir>]
-
-    Notes:
-       - <product git dir> must refer to a directory accessible from the local
-         file system. By default, <product git dir> is the current directory.
-       - The new results are assumed to have been generated using a product
-         built from a clean checkout of the current head commit of the current git branch
-         in <product git dir>.
-       - The sha1 of the snapshot is assumed to be the current head commit.
-       - The timestamp of the snapshot is derived from the combination of the git branch
-         and <product sha1> in <product git dir> (using the 'git show ... --pretty=raw' command).
-       - <product git repo> must be passed explicitly since it cannot in general
-         be derived from <product git dir> (e.g. in the case of a local, standalone
-         repository).
-
 
 ----------------------------------