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

« back to all changes in this revision

Viewing changes to README

  • Committer: Bazaar Package Importer
  • Author(s): Jelmer Vernooij
  • Date: 2010-08-14 18:21:23 UTC
  • mfrom: (1.1.5 upstream)
  • Revision ID: james.westby@ubuntu.com-20100814182123-16lchyp1jsow385b
Tags: 0.4.1-1
* New upstream release.
* Bump standards version to 3.9.1 (no changes).

Show diffs side-by-side

added added

removed removed

Lines of Context:
14
14
| Copyright (C) 2006 Jelmer Vernooij <jelmer@samba.org>
15
15
| Copyright (C) 2006 Lukas Lalinsky <lalinsky@gmail.com>
16
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>
 
17
| Copyright (C) 2006,2007 Panoramic Feedback <abentley@panoramicfeedback.com>
 
18
| Copyright (C) 2006,2008,2009 Jelmer Vernooij <jelmer@samba.org>
 
19
| Copyright (C) 2009,2010 Martin von Gagern <Martin.vGagern@gmx.net>
19
20
| All rights reserved.
20
21
 
21
22
This program is free software; you can redistribute it and/or modify
97
98
  This plugin uses bzrlib directly, so it requires Python 2.4 or greater.
98
99
 
99
100
Trac 0.10
100
 
  Some features may only work with Trac 0.11.
101
 
  Trac 0.12 isn't officially supported (yet).
 
101
  Some features may only work with Trac 0.11 or even Trac 0.12.
102
102
 
103
103
Bazaar 2.0
104
104
  This plugin should work with Bazaar 2.0.
127
127
As an alternative, you can enable or disable specific components
128
128
providing specific features, e.g. in order to disable the wiki macro
129
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.
 
130
Use the Trac web admin plugin interface (Trac 0.11 or later) or have a
 
131
look at the sources to find out which components are available.
132
132
 
133
133
repository_dir
134
134
..............
146
146
If you do not specify them, the following defaults will be used instead::
147
147
 
148
148
  [tracbzr]
149
 
  primary_branches = ,trunk
 
149
  primary_branches = trunk
 
150
  include_sideline_changes = True
150
151
 
151
152
primary_branches
152
153
................
166
167
 
167
168
.. _`glob patterns`: http://docs.python.org/library/fnmatch.html
168
169
 
 
170
include_sideline_changes
 
171
........................
 
172
This boolean flag selects whether or not sideline changes, i.e. those
 
173
denoted with dotted revision numbers, are included in the list of all
 
174
changes. This affects the output of the ``get_changesets`` method,
 
175
which in turn influences the events listed in the timeline view.
 
176
 
 
177
Note that there might be other plugins using that information as well,
 
178
so there might be other components beside the timeline view that get
 
179
affected by this setting.
 
180
 
 
181
Performance
 
182
===========
 
183
 
 
184
Some user-level operations are rather slow, because Trac's assumptions
 
185
about which repository operations are cheap vs expensive doesn't match
 
186
Bazaar's design.
 
187
 
 
188
Revision numbers
 
189
----------------
 
190
 
 
191
One of the problems is the mapping between revision identifiers and
 
192
revision numbers. The `Bazaar Revision Numbering Cache Plugin`__ might
 
193
help for this problem, although it's experimental and hasn't been
 
194
tested with trac-bzr extensively enough. Feedback welcome.
 
195
 
 
196
.. __: https://launchpad.net/bzr-revnocache
 
197
 
 
198
Last modifications
 
199
------------------
 
200
 
 
201
Another problem is that bzr has a different idea about the last
 
202
modification of a directory. In svn, any modifications of directory
 
203
contents is said to modify the dir as well. In bzr, only changes to
 
204
the set of files in a directory are counted.
 
205
 
 
206
Investigations are in progress about how to solve this problem,
 
207
probably through the use of caches.
 
208
 
169
209
Limitations
170
210
===========
171
211
 
181
221
namespace" and "branch namespace", it is impossible to view branches whose
182
222
directories are directly inside other branches' directories.
183
223
 
184
 
Speed issues
185
 
------------
186
 
Some user-level operations are rather slow, because Trac's assumptions
187
 
about which repository operations are cheap vs expensive doesn't match Bazaar's
188
 
design.  In particular, Bzr doesn't track "which revision last modified files
189
 
in this directory."  In theory, this can be solved by caching the results of 
190
 
expensive operations.
191
 
 
192
224
Revision order
193
225
--------------
194
226
If two changesets are not related to one another by some direct ancestry,
210
242
have to be specified and are presented in the format ``PATH_TO_BRANCH,REV``
211
243
where ``PATH_TO_BRANCH`` is the path to branch (or object within the branch
212
244
like directory or file) relative to repository_dir, with slashes ('/')
213
 
replaced with colons (',').
 
245
replaced with commas (',').
214
246
 
215
247
This is visible when browsing the branches via Trac's source browser and this
216
248
is also what you have to use in TracLinks.
217
249
 
218
 
This may be improved in the future when Trac properly supports multiple
219
 
repositories (possibly Trac 0.12, see Trac's `MultipleRepositorySupport`_
220
 
page).  Also see `trac-bzr multirepo spec`_.
 
250
This may be improved in the future when trac-bzr adds_ proper support
 
251
for the multiple repository interfaces added_ in Trac 0.12.
221
252
 
222
253
In the meantime, if you have an urgent need to address that and are able
223
254
to spend some time implementing it, have a look at HACKING document for
224
255
possible approaches in Trac 0.11 and below.
225
256
 
226
 
.. _`MultipleRepositorySupport`: http://trac.edgewall.org/wiki/MultipleRepositorySupport
227
 
.. _`trac-bzr multirepo spec`: https://blueprints.launchpad.net/trac-bzr/+spec/multirepo
 
257
.. _adds: https://blueprints.launchpad.net/trac-bzr/+spec/multirepo
 
258
.. _added: http://trac.edgewall.org/wiki/MultipleRepositorySupport
228
259
 
229
260
Unsupported download links
230
261
--------------------------