~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Robey Pointer
  • Date: 2007-01-02 07:14:03 UTC
  • Revision ID: robey@lag.net-20070102071403-3i0jr7p56z12z9b2
heh, duh.  i can't leave the shelf files open from multiple threads at once.
the shelf files in changecache and textindex are now only opened when they
are being used (and the lockfile is held), and closed afterwards.  no more
branches stomping on each other when they share cache/index.  in the process,
i made the textindex chew through 100 revisions at once now instead of 1.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
loggerhead
2
 
 
3
 
This is a TurboGears (http://www.turbogears.org) project. It can be
4
 
started by running the start-loggerhead.py script.
 
 
b'\\ No newline at end of file'
 
1
LOGGERHEAD
 
2
==========
 
3
 
 
4
[ version 1.0 for bazaar 0.13 ]
 
5
 
 
6
Loggerhead is a web viewer for bazaar branches.  It can be used to navigate
 
7
a branch history, annotate files, perform searches... all the usual things.
 
8
 
 
9
This is a TurboGears (http://www.turbogears.org) project.  It can be
 
10
started by running the 'start-loggerhead.py' script.
 
11
 
 
12
If you're not familiar with turbogears, the easiest way to get this script
 
13
started is to run it via::
 
14
 
 
15
    $ nohup ./start-loggerhead.py &
 
16
    
 
17
and add the following lines to your apache configuration::
 
18
 
 
19
    <Location "/branches/">
 
20
        ProxyPass http://127.0.0.1:8080/
 
21
        ProxyPassReverse http://127.0.0.1:8080/
 
22
    </Location>
 
23
    
 
24
The port configuration is in "dev.cfg".
 
25
 
 
26
The config file is "loggerhead.conf".  In there, you can configure projects,
 
27
and branches per project.  The idea is that you could be publishing several
 
28
(possibly unrelated) projects through the same loggerhead instance, and 
 
29
several branches for the same project.
 
30
 
 
31
 
 
32
CACHES
 
33
------
 
34
 
 
35
To speed up most operations, loggerhead will start creating two caches per
 
36
branch when it first launches:
 
37
 
 
38
    - a revision data cache
 
39
    - a text searching cache
 
40
 
 
41
You can put the cache folder anywhere, but I find that a folder under
 
42
the branch's .bzr/ folder is the simplest place.
 
43
 
 
44
The caches for a branch with 10,000 revisions take about 15 minutes each
 
45
on my machine, but YMMV.  Once they are built, they update every six hours
 
46
or so but usually finish quickly (or instantly) after the initial creation.
 
47
Until the revision cache is built, all operations will be slow.
 
48
 
 
49
You may update the bazaar branch at any time (for example, from a cron).
 
50
Loggerhead will notice and refresh, and bazaar uses its own branch locking
 
51
to prevent corruption.
 
52
 
 
53
 
 
54
SUPPORT
 
55
-------
 
56
 
 
57
This is loosely based on bazaar-webserve, which was loosely based on hgweb.
 
58
Discussion should take place on the bazaar-dev mailing list.
 
59