← Back to branch summary

~loggerhead-team/loggerhead/trunk-rich

« back to all changes in this revision

Viewing changes to README.txt

  • Committer: Launchpad Patch Queue Manager
  • Date: 2008-02-29 04:43:52 UTC
  • mfrom: (146.1.5 release-prep)
  • Revision ID: launchpad@pqm.canonical.com-20080229044352-zoweuygtkq7uwo37
[r=jml] updates to README.txt and NEWS before release

Show diffs side-by-side

added added

removed removed

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