Merge lp:~abentley/bzr-history-db/docs into lp:bzr-history-db

[Aaron Bentley]

Improve docs.

This gives clueless folks like me a starting point.

[John A Meinel (jameinel)]

This would be good if it was correct :).

You can use 'history-db-create' to initially populate a db, but if you want it used and kept up-to-date, you need to set:
 "history_db_path = /path/to/foo.db"

In your configuration settings.

It is a normal 'branch' config, so you can set it in locations.conf for specific branches, or in bazaar.conf to do all branches that you have, etc.

review: Needs Fixing

[Aaron Bentley (abentley)]

It seems like it would be most user-friendly to set that value on the branch config. Or perhaps to not accept a db location string and require the user to configure that first.

[John A Meinel (jameinel)]

If you set the value for the branch, I believe it gets used by default.

I currently just use the command line option for testing (timing how long things take, etc).

For *my* use case, I wouldn't want it set automatically, but I'm not necessarily the common case.

[lp:~abentley/bzr-history-db/docs]

133. By Aaron Bentley on 2010-10-21

Correct docs

[Aaron Bentley (abentley)]

Now with extra accuracy for your reading pleasure.

=== modified file '__init__.py'
--- __init__.py	2010-10-15 21:07:28 +0000
+++ __init__.py	2010-10-21 18:24:59 +0000
@@ -14,7 +14,13 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
-"""Store history information in a database."""
+"""Store history information in a database.
+
+Set "history_db_path" (in branch.conf, locations.conf, etc) to the location
+where you would like to store your history database.  Then use
+history-db-create to import the branch's history into the database.  The
+database will be created if it does not already exist.
+"""
 
 import time