more notes in the docs twisty
authorMark Hammond <mhammond@skippinet.com.au>
Tue, 07 Apr 2009 12:37:27 +1000
branchtwisty
changeset 165 d1fa17b9c0f07cece52748edddac414115551a0c
parent 164 5d71ca63ba33c9b8b54e91cddc2894657cb7d585
child 166 194c2a8c0d184bb7590d12112cb74cbcad7cba07
push id1
push userroot
push dateWed, 08 Apr 2009 01:46:05 +0000
more notes in the docs
docs/INSTALL
--- a/docs/INSTALL
+++ b/docs/INSTALL
@@ -102,19 +102,47 @@ Test everything using the 'test suite' (
   can get quite verbose; you can also say -l log.name=debug to set a specific
   log to debug.
 
   See --help for more.
 
 
 Get *real* messages:
 
-  % run-raindrop.py sync-messages process
+  % run-raindrop.py sync-messages
+  % run-raindrop.py process
 
 (reload http://127.0.0.1:5984/_utils/index.html to see stuff in the messages view)
 
 Go to http://127.0.0.1:5984/junius/files/index.xhtml and do autocomplete to do
-searches.
+searches.  If you have many documents, please be patient as the views are
+generated for the first time.
 
 You can edit any of the files in the 'schema' or 'client' directories, and
 when run-raindrop is next started, the changes to these files will be detected
 and they will be sent to the database.  We don't detect the changes while we
-are running though - you must restart.
+are running though, only at startup.
+
+Unprocessing:
+
+To delete all the intermediate messages in the DB, execute:
+
+  % run-raindrop.py unprocess
+
+The next time you execute a 'process' command, all your messages will be
+processed from the start.
+
+
+Error handling:
+
+If there is an error during a 'process' operation (ie, an exception in the
+converter), we will write an 'error document' and continue processing the
+work queue.  We don't make a very loud noise at the end when this happens -
+you need to notice it in the log output as it is running.  At any time you
+can execute:
+
+  % run-raindrop.py retry-errors
+
+To re-process those messages - but this will generally result in exactly the
+same error unless the converter has been fixed to deal with the condition
+causing the error.  Alternatively, execute 'unprocess' to force reprocessing
+of all messages, not only those which previously caused an error.
+