« back to all changes in this revision
Viewing changes to README
- browse files at revision 5
- compare with another revision
- compare with revision 5
- download diff
- download tarball
- view history from revision 5
- Committer: Bazaar Package Importer
- Author(s): Jelmer Vernooij
- Date: 2009-12-25 15:37:57 UTC
- mfrom: (1.1.3 upstream)
- Revision ID: james.westby@ubuntu.com-20091225153757-n8v0lixk6pwxep36
Tags: 0.3.0-1
* New upstream release.
* Add watch file.
* Add watch file.
added
removed
README
1
===================================
1
2
Multi-branch Bazaar plugin for Trac
2
3
===================================
3
4
4
.. contents:
5
.. contents::
5
6
6
7
This plugin is based on earlier plugins. Its main innovation is to make
7
8
multiple branches available, the way Trac normally does.
8
9
9
Copyright (C) 2005 Edgewall Software
10
Copyright (C) 2005-2006 Christian Boos <cboos@neuf.fr>
11
Copyright (C) 2005 Johan Rydberg <jrydberg@gnu.org>
12
Copyright (C) 2006 Yann Hodique <hodique@lifl.fr>
13
Copyright (C) 2006 Jelmer Vernooij <jelmer@samba.org>
14
Copyright (C) 2006 Lukas Lalinsky <lalinsky@gmail.com>
15
Copyright (C) 2006 Marien Zwart <marienz@gentoo.org>
16
Copyright (C) 2006, 2007 Panoramic Feedback <abentley@panoramicfeedback.com>
17
All rights reserved.
10
| Copyright (C) 2005 Edgewall Software
11
| Copyright (C) 2005-2006 Christian Boos <cboos@neuf.fr>
12
| Copyright (C) 2005 Johan Rydberg <jrydberg@gnu.org>
13
| Copyright (C) 2006 Yann Hodique <hodique@lifl.fr>
14
| Copyright (C) 2006 Jelmer Vernooij <jelmer@samba.org>
15
| Copyright (C) 2006 Lukas Lalinsky <lalinsky@gmail.com>
16
| Copyright (C) 2006 Marien Zwart <marienz@gentoo.org>
17
| Copyright (C) 2006, 2007 Panoramic Feedback <abentley@panoramicfeedback.com>
18
| Copyright (C) 2009 Martin von Gagern <Martin.vGagern@gmx.net>
19
| All rights reserved.
18
20
19
21
This program is free software; you can redistribute it and/or modify
20
22
it under the terms of the GNU General Public License as published by
33
35
34
36
Features
35
37
========
38
39
Repository views
40
----------------
36
41
Supports all major Trac views and "changeset:" notation.
37
42
38
43
Allows a collection of branches to be treated as a "trac repository",
39
44
regardless of whether they are related or in the same bzr repository.
40
45
41
Follows symlinks to branches
42
46
Follows symlinks to branches.
47
48
Wiki Macros
49
-----------
50
51
Branches
52
........
53
The plugin provides a macro called ``[[Branches]]``
54
to list all available branches, together with some information about them,
55
like the current revision number and the time of the last commit.
56
57
58
Installation
59
============
60
Basically the `Plugins section of the Trac Guide`__ applies to the
61
installation of trac-bzr as well.
62
It gives you several options how to install a plugin.
63
64
.. __: http://trac.edgewall.org/wiki/TracPlugins
65
66
System-wide using easy_install
67
------------------------------
68
Executing the command "``easy_install TracBzr``" as root should install
69
the plugin system-wide, making it available to all trac environments
70
on that system.
71
72
Per-environment using plugin egg file
73
-------------------------------------
74
You can download the egg file corresponding to your python version and
75
place it in the ``plugins`` directory of a Trac environment.
76
77
Building from source
78
--------------------
79
If you want to build trac-bzr from source, you can either grab a
80
source release tarball or a checkout of a development branch. Many
81
development branches are `listed on launchpad`__. Once you have
82
obtained such a source tree, execute "``python setup.py install``" to
83
install the plugin system-wide, or "``python setup.py bdist_egg``" to
84
obtain an egg file for installation in a single Trac environment.
85
86
.. __: https://code.launchpad.net/trac-bzr
43
87
44
88
Requirements
45
============
89
------------
90
In order to function properly, trac-bzr requires the packages listed below.
91
92
These dependencies are not handled by setuptools, because otherwise
93
the plugin would fail to load if one of the dependencies wasn't
94
installed with setuptools or similar.
46
95
47
96
Python 2.4
48
----------
49
This plugin uses bzrlib directly, so it requires Python 2.4 or greater.
50
51
Bazaar 0.13
52
-----------
53
This has been tested with Bazaar 0.13. Earlier versions may or may not work.
54
97
This plugin uses bzrlib directly, so it requires Python 2.4 or greater.
98
99
Trac 0.10
100
Some features may only work with Trac 0.11.
101
Trac 0.12 isn't officially supported (yet).
102
103
Bazaar 2.0
104
This plugin should work with Bazaar 2.0.
105
Earlier versions may or may not work.
55
106
56
107
Configuration
57
108
=============
58
After installing, you'll want to set the following values:
109
To configure trac-bzr, you'll have to edit the ``trac.ini`` file of
110
your Trac environment.
111
112
Required configuration
113
----------------------
114
After installing, you'll want to set the following values::
115
116
[components]
117
tracbzr.* = enabled
118
119
[trac]
120
repository_type = bzr
121
repository_dir = /path/to/collection/of/bzr/branches
59
122
60
123
components
61
----------
62
This should include "tracbzr.* = enabled"
124
..........
125
This should include "``tracbzr.* = enabled``" to enable all features
126
provided by the plugin.
127
As an alternative, you can enable or disable specific components
128
providing specific features, e.g. in order to disable the wiki macro
129
provider.
130
Use the Trac 0.11 web admin plugin interface or have a look at the
131
sources to find out which components are available.
63
132
64
133
repository_dir
65
--------------
134
..............
66
135
This should point at the directory containing your branches. This directory
67
does not have to be a repository. trac+bzr doesn't require branches to
136
does not have to be a repository. trac-bzr doesn't require branches to
68
137
be related, though that is permitted, of course.
69
138
70
139
repository_type
71
---------------
140
...............
72
141
This should be "bzr".
73
142
74
You can also use "bzr+debug" for debug mode. In debug mode, all
75
repository operations are logged to the standard log output. (Turning this on
76
for one repository_dir may enable it for all of them.)
77
143
Optional configuration
144
----------------------
145
There are some optional settings you can configure for trac-bzr.
146
If you do not specify them, the following defaults will be used instead::
147
148
[tracbzr]
149
primary_branches = ,trunk
150
151
primary_branches
152
................
153
This is a comma-separated ordered list of the main branches of your project.
154
You may also specify `glob patterns`_ in this list to match multiple branches.
155
156
The Branches_ wiki macro will list branches in the order specified by this list.
157
The timeline view will try to associate changesets with branches in the
158
specified order.
159
In both cases, branches not matched by any list item will be inserted at the
160
end of the list, as if you had ended the list with ``,*``.
161
Branches matched by a single list item will be sorted alphabetically.
162
163
.. _`glob patterns`: http://docs.python.org/library/fnmatch.html
78
164
79
165
Limitations
80
166
===========
85
171
the last-revision for directories that are not branches. It also provides
86
172
"null:", which is part of Bazaar's theoretical model, but usually hidden.
87
173
88
Hidden Nested Branches
174
Hidden nested branches
89
175
----------------------
90
176
Because Trac, like Subversion, doesn't differentiate between "source file
91
177
namespace" and "branch namespace", it is impossible to view branches whose
99
185
in this directory." In theory, this can be solved by caching the results of
100
186
expensive operations.
101
187
102
Revision Order
188
Revision order
103
189
--------------
104
Changesets are sorted by timestamp, so clock skew may cause some changesets
105
to be displayed out-of order. Changesets have only a partial ordering anyhow,
106
and this was deemed faster.
190
If two changesets are not related to one another by some direct ancestry,
191
i.e. if neither one is an ancestor of the other, then revisions are sorted by
192
timestamp instead.
193
In case of a clock skew this can lead to inconcistent results,
194
as transitivity isn't guaranteed for this approach.
107
195
108
196
Bracket syntax
109
197
--------------
110
Trac appears not to recognize bzr revision strings in its bracket notation,
111
e.g. [tree,25]. However, you can use the changeset notation instead, e.g.
112
changeset:tree,25.
198
Trac does not to recognize bzr revision strings in its bracket notation,
199
e.g. ``[tree,25]``.
200
However, you can use the changeset notation instead, e.g.
201
``changeset:tree,25``.
113
202
114
203
File encoding
115
204
-------------
123
212
[trac]
124
213
default_charset = cp1251
125
214
215
.. cut long_description here
216
126
217
.. vim: ft=rst
218
219
.. emacs
220
Local Variables:
221
mode: rst
222
End:
Loggerhead is a web-based interface for Breezy
Version: 2.0.1