~ubuntu-branches/debian/sid/trac-bzr/sid

« back to all changes in this revision

Viewing changes to README

  • Committer: Bazaar Package Importer
  • Author(s): Chris Lamb
  • Date: 2007-03-09 03:58:13 UTC
  • Revision ID: james.westby@ubuntu.com-20070309035813-ouzb56usywzt0s7q
Tags: upstream-0.2+bzr31
ImportĀ upstreamĀ versionĀ 0.2+bzr31

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Multi-branch Bazaar plugin for Trac
 
2
###################################
 
3
 
 
4
This plugin is based on earlier plugins.  Its main innovation is to make
 
5
multiple branches available, the way Trac normally does.
 
6
 
 
7
 
 
8
Features
 
9
========
 
10
Supports all major Trac views and "changeset:" notation.
 
11
 
 
12
Allows a collection of branches to be treated as a "trac repository",
 
13
regardless of whether they are related or in the same bzr repository.
 
14
 
 
15
Follows symlinks to branches
 
16
 
 
17
 
 
18
Requirements
 
19
============
 
20
 
 
21
Python 2.4
 
22
----------
 
23
This plugin uses bzrlib directly, so it requires Python 2.4 or greater.
 
24
 
 
25
Bazzar 1.3
 
26
----------
 
27
This has been tested with Bazaar 1.3.  Earlier versions may or may not work.
 
28
 
 
29
 
 
30
Configuration
 
31
=============
 
32
After installing, you'll want to set the following values:
 
33
 
 
34
components
 
35
----------
 
36
This should include "tracbzr.* = enabled"
 
37
 
 
38
repository_dir
 
39
--------------
 
40
This should point at the directory containing your branches.  This directory
 
41
does not have to be a repository.  trac+bzr doesn't require branches to
 
42
be related, though that is permitted, of course.
 
43
 
 
44
repository_type
 
45
---------------
 
46
This should be "bzr".
 
47
 
 
48
You can also use "bzr+debug" for debug mode.  In debug mode, all
 
49
repository operations are logged to the standard log output.  (Turning this on
 
50
for one repository_dir may enable it for all of them.)
 
51
 
 
52
 
 
53
Limitations
 
54
===========
 
55
 
 
56
Bogus changesets
 
57
----------------
 
58
This plugin introduces the bogus changeset "current:", which is used as
 
59
the last-revision for directories that are not branches.  It also provides
 
60
"null:", which is part of Bazaar's theoretical model, but usually hidden.
 
61
 
 
62
Hidden Nested Branches
 
63
----------------------
 
64
Because Trac, like Subversion, doesn't differentiate between "source file
 
65
namespace" and "branch namespace", it is impossible to view branches whose
 
66
directories are directly inside other branches' directories.
 
67
 
 
68
Speed issues
 
69
------------
 
70
Some user-level operations are rather slow, because Trac's assumptions
 
71
about which repository operations are cheap vs expensive doesn't match Bazaar's
 
72
design.  In particular, Bzr doesn't track "which revision last modified files
 
73
in this directory."  In theory, this can be solved by caching the results of 
 
74
expensive operations.
 
75
 
 
76
Revision Order
 
77
--------------
 
78
Changesets are sorted by timestamp, so clock skew may cause some changesets
 
79
to be displayed out-of order.  Changesets have only a partial ordering anyhow,
 
80
and this was deemed faster.
 
81
 
 
82
Bracket syntax
 
83
--------------
 
84
Trac appears not to recognize bzr revision strings in its bracket notation,
 
85
e.g. [tree,25].  However, you can use the changeset notation instead, e.g.
 
86
changeset:tree,25.