~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Martin Pool
  • Date: 2005-06-22 08:12:31 UTC
  • Revision ID: mbp@sourcefrog.net-20050622081231-630e514240ccb87a
- new exception NotVersionedError
- raise this from Inventory.add_path if parent isnt versioned

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
 
 
39
20
* Add of a file that was present in the base revision should put back
40
21
  the previous file-id.
41
22
 
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
 
 
46
23
* Handle diff of files which do not have a trailing newline; probably
47
24
  requires patching difflib to get it exactly right, or otherwise
48
25
  calling out to GNU diff.
49
26
 
50
 
* Should be able to copy files between branches to preserve their
51
 
  file-id (and perhaps eventually parentage.)
 
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)
52
38
 
53
39
* -r option should take a revision-id as well as a revno.
54
40
 
 
41
* ``bzr info`` could show space used by working tree, versioned files,
 
42
  unknown and ignored files. 
 
43
 
55
44
* ``bzr info`` should count only people with distinct email addresses as
56
45
  different committers.  (Or perhaps only distinct userids?)
57
46
 
75
64
* ``bzr status DIR`` should give status on all files under that
76
65
  directory.
77
66
 
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)
 
67
* ``bzr log DIR`` should give changes to any files within DIR.
 
68
 
 
69
* Check all commands have decent help.
81
70
 
82
71
* ``bzr inventory -r REV`` and perhaps unify this with ``bzr ls``,
83
72
  giving options to display ids, types, etc.
84
73
 
 
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
  
85
83
* RemoteBranch could maintain a cache either in memory or on disk.  We
86
84
  know more than an external cache might about which files are
87
85
  immutable and which can vary.  On the other hand, it's much simpler
112
110
  Nice for humans; less good for machine parsing.
113
111
 
114
112
* Patches should probably use only forward slashes, even on Windows,
115
 
  otherwise Unix patch can't apply them. (?)
 
113
  otherwise Unix patch can't apply them. (?) 
116
114
 
117
115
* Branch.update_revisions() inefficiently fetches revisions from the
118
116
  remote server twice; once to find out what text and inventory they
119
117
  need and then again to actually get the thing.  This is a bit
120
 
  inefficient.
 
118
  inefficient. 
121
119
 
122
120
  One complicating factor here is that we don't really want to have
123
121
  revisions present in the revision-store until all their constituent
127
125
  methods return object, but what we really want is the raw XML, which
128
126
  can be popped into our own store.  That needs to be refactored.
129
127
 
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.
 
128
* ``bzr status FOO`` where foo is ignored should say so.
 
129
 
 
130
* ``bzr mkdir A...`` should just create and add A.
 
131
  
 
132
 
190
133
 
191
134
Medium things
192
135
-------------
193
136
 
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.
 
137
* Merge revert patch.
 
138
 
 
139
* ``bzr mv`` that does either rename or move as in Unix.
201
140
 
202
141
* More efficient diff of only selected files.  We should be able to
203
142
  just get the id for the selected files, look up their location and
204
143
  diff just those files.  No need to traverse the entire inventories.
205
144
 
 
145
* ``bzr status DIR`` or ``bzr diff DIR`` should report on all changes
 
146
  under that directory.
 
147
 
206
148
* Fix up Inventory objects to represent root object as an entry.
207
149
 
208
150
* Don't convert entire entry from ElementTree to an object when it is
214
156
 
215
157
* More test cases.
216
158
 
217
 
  - ``missing`` command
218
 
 
219
159
  - Selected-file commit
220
160
 
221
161
  - Impossible selected-file commit: adding things in non-versioned
232
172
  At the very least we could run diffstat over the diff, or perhaps
233
173
  read the status output from patch.  Just knowing which files might
234
174
  be modified would be enough to guide the add and commit.
235
 
 
 
175
  
236
176
  Given this we might be able to import patches at 1/second or better.
237
177
 
 
178
* Get branch over http.
 
179
 
 
180
* Pull pure updates over http.
 
181
 
238
182
* revfile compression.
239
183
 
240
 
* Split inventory into per-directory files?
 
184
* Split inventory into per-directory files.
241
185
 
242
186
* Fix ignore file parsing:
243
187
 
270
214
 
271
215
* Handle symlinks in the working directory; at the very least it
272
216
  should be possible for them to be present and ignored/unknown
273
 
  without causing assertion failures.
 
217
  without causing assertion failures. 
274
218
 
275
219
  Eventually symlinks should be versioned.
276
220
 
278
222
  if the subdirectory is not already versioned.   Perhaps also require
279
223
  a ``--nested`` to protect against confusion.
280
224
 
281
 
* Branch names?
 
225
* Branch names? 
282
226
 
283
227
* More test framework:
284
228
 
285
229
  - Class that describes the state of a working tree so we can just
286
230
    assert it's equal.
287
231
 
 
232
* There are too many methods on Branch() that really manipulate the
 
233
  WorkingTree.  They should be moved across.  
 
234
 
 
235
  Also there are some methods which are duplicated on Tree and
 
236
  Inventory objects, and it should be made more clear which ones are
 
237
  proxies and which ones behave differently, and how.
 
238
 
288
239
* Try using XSLT to add some formatting to REST-generated HTML.  Or
289
240
  maybe write a small Python program that specifies a header and foot
290
241
  for the pages and calls into the docutils libraries.
306
257
 
307
258
  - Hold the ElementTree in memory in the Inventory object and work
308
259
    directly on that, rather than converting into Python objects every
309
 
    time it is read in.  Probably still expose it through some kind of
 
260
    time it is read in.  Probably still exposoe it through some kind of
310
261
    object interface though, but perhaps that should just be a proxy
311
262
    for the elements.
312
263
 
313
 
  - Less special cases for the root directory.
 
264
  - Less special cases for the root directory. 
314
265
 
315
266
* Perhaps inventories should remember the revision in which each file
316
267
  was last changed, as well as its current state?  This is a bit
318
269
 
319
270
* stat cache should perhaps only stat files as necessary, rather than
320
271
  doing them all up-front.  On the other hand, that disallows the
321
 
  optimization of stating them in inode order.
 
272
  opimization of stating them in inode order.
322
273
 
323
274
* It'd be nice to pipeline multiple HTTP requests.  Often we can
324
275
  predict what will be wanted in future: all revisions, or all texts
325
 
  in a particular revision, etc.
 
276
  in a particular revision, etc.  
326
277
 
327
278
  urlgrabber's docs say they are working on batched downloads; we
328
279
  could perhaps ride on that or just create a background thread (ew).
329
280
 
330
281
* Paranoid mode where we never trust SHA-1 matches.
331
282
 
 
283
* Don't commit if there are no changes unless forced.
 
284
 
332
285
* --dry-run mode for commit?  (Or maybe just run with
333
286
  check-command=false?)
334
287
 
340
293
* XML attributes might have trouble with filenames containing \n and
341
294
  \r.  Do we really want to support this?  I think perhaps not.
342
295
 
 
296
* Remember execute bits, so that exports will work OK.
 
297
 
343
298
* Unify smart_add and plain Branch.add(); perhaps smart_add should
344
299
  just build a list of files to add and pass that to the regular add
345
300
  function.
346
301
 
347
302
* Function to list a directory, saying in which revision each file was
348
 
  last modified.  Useful for web and GUI interfaces, and slow to
 
303
  last modified.  Useful for web and gui interfaces, and slow to
349
304
  compute one file at a time.
350
 
  
351
 
  This will be done when we track file texts by referring to the
352
 
  version that created them. 
 
305
 
 
306
* unittest is standard, but the results are kind of ugly; would be
 
307
  nice to make it cleaner.
353
308
 
354
309
* Check locking is correct during merge-related operations.
355
310
 
356
311
* Perhaps attempts to get locks should timeout after some period of
357
312
  time, or at least display a progress message.
358
313
 
 
314
* Split out upgrade functionality from check command into a separate
 
315
  ``bzr upgrade``.
 
316
 
359
317
* Don't pass around command classes but rather pass objects.  This'd
360
318
  make it cleaner to construct objects wrapping external commands.
361
319
 
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
 
 
374
 
* ``bzrlib.lazy_import.lazy_import`` could check to see if a given
375
 
  module has already been imported (look at ``sys.modules``). If it
376
 
  has, then just import it directly, rather than creating a lazy
377
 
  object.
378
 
 
379
320
 
380
321
Large things
381
322
------------
430
371
  a temporary directory.
431
372
 
432
373
  If the commit does not actually complete, we would rather the
433
 
  content was not left behind in the stores.
 
374
  content was not left behind in the stores.  
434
375
 
435
376
* Web interface
436
377
 
443
384
  with removing the tags on the way back in.
444
385
 
445
386
* ``bzr find``
446
 
 
447
 
Selftest
448
 
--------
449
 
 
450
 
* Write some benchmark tests
451
 
 
452
 
* we could display the ids of some tests selected by time to rune, or cputime,
453
 
  rusage. 
454
 
 
455
 
* We could run tests multiple times and report deviation/slowest/fastest.
456
 
 
457
 
* Gather lsprofile output for each test individually - log that somewhere.
458
 
 
459
 
* Should plugins be able to offer benchmark tests ?
460
 
 
461
 
CHANGESETS
462
 
----------
463
 
Ensure changeset command behaves properly w/revisions (e.g. 0)
464
 
Figure out whether testament-related bug is my problem
465
 
Get rid of the 'old' directory
466
 
Bundle signatures
467
 
What to do about ghost ancestors in remote branch that are present locally?