~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Jelmer Vernooij
  • Date: 2006-06-21 13:54:14 UTC
  • mto: (1558.14.8 Aaron's integration)
  • mto: This revision was merged to the branch mainline in revision 1803.
  • Revision ID: jelmer@samba.org-20060621135414-11a3a70e53adbb99
Install benchmarks.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.. -*- mode: indented-text; compile-command: "make -C doc" -*- 
 
1
.. -*- mode: indented-text; compile-command: "make -C doc" -*-
2
2
 
3
3
 
4
4
*******************
17
17
Small things
18
18
------------
19
19
 
 
20
* Fix tests so that import errors caused by modules don't produce false reports
 
21
  that the tests themselves don't exist.
 
22
 
 
23
* Fix tests so that one test failure doesn't prevent other tests from running
 
24
 
 
25
* print a message at the end of running the tests telling them that the
 
26
  test log and output exists but can be removed
 
27
 
 
28
* tests for running the commit editor, and fix problem of not passing in 
 
29
  multiple arguments
 
30
 
 
31
* Merging add of a new file clashing with an existing file doesn't
 
32
  work; add gets an error that it's already versioned and the merge
 
33
  aborts.
 
34
 
 
35
* Merge should ignore the destination's working directory, otherwise
 
36
  we get an error about the statcache when pulling from a remote
 
37
  branch.
 
38
 
20
39
* Add of a file that was present in the base revision should put back
21
40
  the previous file-id.
22
41
 
 
42
* Not sure I'm happy with needing to pass a root id to EmptyTree;
 
43
  comparing anything against an EmptyTree with no root should have the
 
44
  same effect(?)
 
45
 
23
46
* Handle diff of files which do not have a trailing newline; probably
24
47
  requires patching difflib to get it exactly right, or otherwise
25
48
  calling out to GNU diff.
26
49
 
27
 
* Import ElementTree update patch.
28
 
 
29
 
* Plugins that provide commands.  By just installing a file into some
30
 
  directory (e.g. ``/usr/share/bzr/plugins``) it should be possible to
31
 
  create new top-level commands (``bzr frob``).  Extensions can be
32
 
  written in either Python (in which case they use the bzrlib API) or
33
 
  in a separate process (in sh, C, whatever).   It should be possible
34
 
  to get help for plugin commands.
35
 
 
36
 
* Smart rewrap text in help messages to fit in $COLUMNS (or equivalent
37
 
  on Windows)
 
50
* Should be able to copy files between branches to preserve their
 
51
  file-id (and perhaps eventually parentage.)
38
52
 
39
53
* -r option should take a revision-id as well as a revno.
40
54
 
41
 
* ``bzr info`` could show space used by working tree, versioned files,
42
 
  unknown and ignored files. 
43
 
 
44
55
* ``bzr info`` should count only people with distinct email addresses as
45
56
  different committers.  (Or perhaps only distinct userids?)
46
57
 
64
75
* ``bzr status DIR`` should give status on all files under that
65
76
  directory.
66
77
 
67
 
* ``bzr log DIR`` should give changes to any files within DIR.
68
 
 
69
 
* Check all commands have decent help.
 
78
* ``bzr log DIR`` should give changes to any files within DIR; at the
 
79
  moment it only lists things which modify the specific named file
 
80
  (and not its contents)
70
81
 
71
82
* ``bzr inventory -r REV`` and perhaps unify this with ``bzr ls``,
72
83
  giving options to display ids, types, etc.
73
84
 
74
 
* Split BzrError into various more specific subclasses for different
75
 
  errors people might want to catch.
76
 
 
77
 
* If the export destination ends in '.tar', '.tar.gz', etc then create
78
 
  a tarball instead of a directory.  (Need to actually make a
79
 
  temporary directory and then tar that up.)
80
 
 
81
 
  http://www.gelato.unsw.edu.au/archives/git/0504/2194.html
82
 
  
83
85
* RemoteBranch could maintain a cache either in memory or on disk.  We
84
86
  know more than an external cache might about which files are
85
87
  immutable and which can vary.  On the other hand, it's much simpler
103
105
 
104
106
* Statcache should possibly map all file paths to / separators
105
107
 
 
108
* quotefn doubles all backslashes on Windows; this is probably not the
 
109
  best thing to do.  What would be a better way to safely represent
 
110
  filenames?  Perhaps we could doublequote things containing spaces,
 
111
  on the principle that filenames containing quotes are unlikely?
 
112
  Nice for humans; less good for machine parsing.
 
113
 
 
114
* Patches should probably use only forward slashes, even on Windows,
 
115
  otherwise Unix patch can't apply them. (?)
 
116
 
 
117
* Branch.update_revisions() inefficiently fetches revisions from the
 
118
  remote server twice; once to find out what text and inventory they
 
119
  need and then again to actually get the thing.  This is a bit
 
120
  inefficient.
 
121
 
 
122
  One complicating factor here is that we don't really want to have
 
123
  revisions present in the revision-store until all their constituent
 
124
  parts are also stored.
 
125
 
 
126
  The basic problem is that RemoteBranch.get_revision() and similar
 
127
  methods return object, but what we really want is the raw XML, which
 
128
  can be popped into our own store.  That needs to be refactored.
 
129
 
 
130
* Guard against repeatedly merging any particular patch.
 
131
 
 
132
* More options for diff:
 
133
 
 
134
  - diff two revisions of the same tree
 
135
 
 
136
  - diff two different branches, optionally at different revisions
 
137
 
 
138
  - diff a particular file in another tree against the corresponding
 
139
    version in this tree (which should be the default if the second
 
140
    parameter is a tree root)
 
141
 
 
142
  - diff everything under a particular directory, in any of the above
 
143
    ways
 
144
 
 
145
  - diff two files inside the same tree, even if they have different
 
146
    ids
 
147
 
 
148
  - and, of course, tests for all this
 
149
 
 
150
* Reproducible performance benchmark to measure whether performance is 
 
151
  getting better or worse.
 
152
 
 
153
* ``bzr log -m foo`` should perhaps error if nothing matches?
 
154
 
 
155
* ``bzr diff -r 30 -r 40 foo.c`` or ``bzr diff -r30..40 foo.c``
 
156
 
 
157
  If diffing between two branches then we probably want two -r
 
158
  options, since the revisions don't form a range that can be
 
159
  evaluated on either one.
 
160
 
 
161
* bzr diff shouldn't diff binary files
 
162
 
 
163
* setup.py install when run from a bzr tree should freeze the tree
 
164
  revision-id into the installed bzr.
 
165
 
 
166
* bzr script should trap ImportError and perhaps give a better error
 
167
  message?
 
168
 
 
169
* revert after a merge should possibly remove all the BASE/THIS/OTHER
 
170
  files to get you back to where you were.
 
171
 
 
172
* files that are added and then deleted are still reported as added
 
173
 
 
174
* stores should raise KeyError, not IndexError
 
175
 
 
176
* merging from a remote branch seems to sometimes raise errors not
 
177
  present locally
 
178
 
 
179
* should be possible to give a related branch when pulling from a
 
180
  remote branch to make things faster
 
181
 
 
182
* sometimes gives "conflicting add" even when the contents are in fact
 
183
  the same???
 
184
 
 
185
* BZRDIR should be in branch.py not __init__.py.
 
186
 
 
187
* bzrlib.delta.compare_trees() shouldn't need to sort all of the result
 
188
  lists, since they are being added in alphabetical order. Write tests
 
189
  to guarantee this, and remove the sort() calls.
106
190
 
107
191
Medium things
108
192
-------------
109
193
 
110
 
* Merge revert patch.
111
 
 
112
 
* ``bzr mv`` that does either rename or move as in Unix.
 
194
* merge should add all revision and inventory XML to the local store.
 
195
 
 
196
* check should give a warning for revisions that are named in the
 
197
  chain but not actually present in the store.
 
198
 
 
199
* remove anything outside of the branch implementation that directly
 
200
  accesses the stores.
113
201
 
114
202
* More efficient diff of only selected files.  We should be able to
115
203
  just get the id for the selected files, look up their location and
116
204
  diff just those files.  No need to traverse the entire inventories.
117
205
 
118
 
* ``bzr status DIR`` or ``bzr diff DIR`` should report on all changes
119
 
  under that directory.
120
 
 
121
206
* Fix up Inventory objects to represent root object as an entry.
122
207
 
123
208
* Don't convert entire entry from ElementTree to an object when it is
129
214
 
130
215
* More test cases.
131
216
 
 
217
  - ``missing`` command
 
218
 
132
219
  - Selected-file commit
133
220
 
134
221
  - Impossible selected-file commit: adding things in non-versioned
145
232
  At the very least we could run diffstat over the diff, or perhaps
146
233
  read the status output from patch.  Just knowing which files might
147
234
  be modified would be enough to guide the add and commit.
148
 
  
 
235
 
149
236
  Given this we might be able to import patches at 1/second or better.
150
237
 
151
 
* Get branch over http.
152
 
 
153
 
* Pull pure updates over http.
154
 
 
155
238
* revfile compression.
156
239
 
157
 
* Split inventory into per-directory files.
 
240
* Split inventory into per-directory files?
158
241
 
159
242
* Fix ignore file parsing:
160
243
 
187
270
 
188
271
* Handle symlinks in the working directory; at the very least it
189
272
  should be possible for them to be present and ignored/unknown
190
 
  without causing assertion failures. 
 
273
  without causing assertion failures.
191
274
 
192
275
  Eventually symlinks should be versioned.
193
276
 
195
278
  if the subdirectory is not already versioned.   Perhaps also require
196
279
  a ``--nested`` to protect against confusion.
197
280
 
198
 
* Branch names? 
 
281
* Branch names?
199
282
 
200
283
* More test framework:
201
284
 
202
285
  - Class that describes the state of a working tree so we can just
203
286
    assert it's equal.
204
287
 
205
 
* There are too many methods on Branch() that really manipulate the
206
 
  WorkingTree.  They should be moved across.  
207
 
 
208
 
  Also there are some methods which are duplicated on Tree and
209
 
  Inventory objects, and it should be made more clear which ones are
210
 
  proxies and which ones behave differently, and how.
211
 
 
212
288
* Try using XSLT to add some formatting to REST-generated HTML.  Or
213
289
  maybe write a small Python program that specifies a header and foot
214
290
  for the pages and calls into the docutils libraries.
230
306
 
231
307
  - Hold the ElementTree in memory in the Inventory object and work
232
308
    directly on that, rather than converting into Python objects every
233
 
    time it is read in.  Probably still exposoe it through some kind of
 
309
    time it is read in.  Probably still expose it through some kind of
234
310
    object interface though, but perhaps that should just be a proxy
235
311
    for the elements.
236
312
 
237
 
  - Less special cases for the root directory. 
 
313
  - Less special cases for the root directory.
238
314
 
239
315
* Perhaps inventories should remember the revision in which each file
240
316
  was last changed, as well as its current state?  This is a bit
242
318
 
243
319
* stat cache should perhaps only stat files as necessary, rather than
244
320
  doing them all up-front.  On the other hand, that disallows the
245
 
  opimization of stating them in inode order.
 
321
  optimization of stating them in inode order.
246
322
 
247
323
* It'd be nice to pipeline multiple HTTP requests.  Often we can
248
324
  predict what will be wanted in future: all revisions, or all texts
249
 
  in a particular revision, etc.  
 
325
  in a particular revision, etc.
250
326
 
251
327
  urlgrabber's docs say they are working on batched downloads; we
252
328
  could perhaps ride on that or just create a background thread (ew).
253
329
 
254
330
* Paranoid mode where we never trust SHA-1 matches.
255
331
 
256
 
* Don't commit if there are no changes unless forced.
257
 
 
258
332
* --dry-run mode for commit?  (Or maybe just run with
259
333
  check-command=false?)
260
334
 
266
340
* XML attributes might have trouble with filenames containing \n and
267
341
  \r.  Do we really want to support this?  I think perhaps not.
268
342
 
269
 
* Remember execute bits, so that exports will work OK.
270
 
 
271
343
* Unify smart_add and plain Branch.add(); perhaps smart_add should
272
344
  just build a list of files to add and pass that to the regular add
273
345
  function.
274
346
 
275
347
* Function to list a directory, saying in which revision each file was
276
 
  last modified.  Useful for web and gui interfaces, and slow to
 
348
  last modified.  Useful for web and GUI interfaces, and slow to
277
349
  compute one file at a time.
278
 
 
279
 
* unittest is standard, but the results are kind of ugly; would be
280
 
  nice to make it cleaner.
 
350
  
 
351
  This will be done when we track file texts by referring to the
 
352
  version that created them. 
281
353
 
282
354
* Check locking is correct during merge-related operations.
283
355
 
284
356
* Perhaps attempts to get locks should timeout after some period of
285
357
  time, or at least display a progress message.
286
358
 
 
359
* Don't pass around command classes but rather pass objects.  This'd
 
360
  make it cleaner to construct objects wrapping external commands.
 
361
 
 
362
* Track all merged-in revisions in a versioned add-only metafile.
 
363
 
 
364
* ``uncommit`` command that removes a revision from the end of the
 
365
  revision-history; just doing this is enough to remove the commit,
 
366
  and a new commit will automatically be made against the
 
367
  predecessor.  This can be repeated.
 
368
 
 
369
  It only makes sense to delete from the tail of history.
 
370
 
 
371
  This has been implemented, but it does not remove the texts from
 
372
  the store.
 
373
 
287
374
 
288
375
Large things
289
376
------------
338
425
  a temporary directory.
339
426
 
340
427
  If the commit does not actually complete, we would rather the
341
 
  content was not left behind in the stores.  
 
428
  content was not left behind in the stores.
342
429
 
343
430
* Web interface
344
431
 
351
438
  with removing the tags on the way back in.
352
439
 
353
440
* ``bzr find``
 
441
 
 
442
Selftest
 
443
--------
 
444
 
 
445
* Write some benchmark tests
 
446
 
 
447
* we could display the ids of some tests selected by time to rune, or cputime,
 
448
  rusage. 
 
449
 
 
450
* We could run tests multiple times and report deviation/slowest/fastest.
 
451
 
 
452
* Gather lsprofile output for each test individually - log that somewhere.
 
453
 
 
454
* Should plugins be able to offer benchmark tests ?
 
455
 
 
456
CHANGESETS
 
457
----------
 
458
Ensure changeset command behaves properly w/revisions (e.g. 0)
 
459
Figure out whether testament-related bug is my problem
 
460
Get rid of the 'old' directory
 
461
Bundle signatures
 
462
What to do about ghost ancestors in remote branch that are present locally?