~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Martin Pool
  • Date: 2006-11-03 01:52:12 UTC
  • mto: This revision was merged to the branch mainline in revision 2119.
  • Revision ID: mbp@sourcefrog.net-20061103015212-1e5f881c2152d79f
Review comments

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
 
* Syntax should be ``bzr export -r REV``.
30
 
 
31
 
* Plugins that provide commands.  By just installing a file into some
32
 
  directory (e.g. ``/usr/share/bzr/plugins``) it should be possible to
33
 
  create new top-level commands (``bzr frob``).  Extensions can be
34
 
  written in either Python (in which case they use the bzrlib API) or
35
 
  in a separate process (in sh, C, whatever).   It should be possible
36
 
  to get help for plugin commands.
37
 
 
38
 
* Smart rewrap text in help messages to fit in $COLUMNS (or equivalent
39
 
  on Windows)
 
50
* Should be able to copy files between branches to preserve their
 
51
  file-id (and perhaps eventually parentage.)
40
52
 
41
53
* -r option should take a revision-id as well as a revno.
42
54
 
43
 
* ``bzr info`` could show space used by working tree, versioned files,
44
 
  unknown and ignored files. 
45
 
 
46
55
* ``bzr info`` should count only people with distinct email addresses as
47
56
  different committers.  (Or perhaps only distinct userids?)
48
57
 
54
63
* ``bzr ignore`` command that just adds a line to the ``.bzrignore`` file
55
64
  and makes it versioned.  Fix this to break symlinks.
56
65
 
57
 
* ``bzr help commands`` should give a one-line summary of each command.
58
 
 
59
66
* Any useful sanity checks in 'bzr ignore'?  Perhaps give a warning if
60
67
  they try to add a single file which is already versioned, or if they
61
68
  add a pattern which already exists, or if it looks like they gave an
63
70
 
64
71
__ http://mail.python.org/pipermail/python-list/2001-April/037847.html
65
72
 
66
 
* Read and write locks on branch while it's open.
67
 
 
68
73
* Separate read and write version checks?
69
74
 
70
 
* ``bzr status FILE...``
71
 
 
72
 
* Check all commands have decent help.
73
 
 
74
 
* Autogenerate argument/option help.
 
75
* ``bzr status DIR`` should give status on all files under that
 
76
  directory.
 
77
 
 
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)
75
81
 
76
82
* ``bzr inventory -r REV`` and perhaps unify this with ``bzr ls``,
77
83
  giving options to display ids, types, etc.
78
84
 
79
 
* Atomic file class that renames into place when it's closed.
80
 
 
 
85
* RemoteBranch could maintain a cache either in memory or on disk.  We
 
86
  know more than an external cache might about which files are
 
87
  immutable and which can vary.  On the other hand, it's much simpler
 
88
  to just use an external proxy cache.
 
89
 
 
90
  Perhaps ~/.bzr/http-cache.  Baz has a fairly simple cache under
 
91
  ~/.arch-cache, containing revision information encoded almost as a
 
92
  bunch of archives.  Perhaps we could simply store full paths.
 
93
 
 
94
* Maybe also store directories in the statcache so that we can quickly
 
95
  identify that they still exist.
 
96
 
 
97
* Diff should show timestamps; for files from the working directory we
 
98
  can use the file itself; for files from a revision we should use the
 
99
  commit time of the revision.
 
100
 
 
101
* Perhaps split command infrastructure from the actual command
 
102
  definitions.
 
103
 
 
104
* Cleaner support for negative boolean options like --no-recurse.
 
105
 
 
106
* Statcache should possibly map all file paths to / separators
 
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.
81
190
 
82
191
Medium things
83
192
-------------
84
193
 
85
 
* Display command grammar in help messages rather than hardcoding it.
86
 
 
87
 
* Change command functions into Command() objects, like in hct, and
88
 
  then the grammar can be described directly in there.  Since all
89
 
  option definitions are global we can define them just once and
90
 
  reference them from each command.
91
 
 
92
 
* Selective commit of only some files.
93
 
 
94
 
* Faster diff/status.  
95
 
 
96
 
  Status should be handled differently because it needs to report on
97
 
  deleted and unknown files.  diff only needs to deal with versioned
98
 
  files.
99
 
 
100
 
* Merge Aaron's merge code.
101
 
 
102
 
* Merge revert patch.
103
 
 
104
 
* Turn on stat cache code, and add optimization about avoiding
105
 
  dangerous cache entries.
106
 
 
107
 
* ``bzr mv`` that does either rename or move as in Unix.
108
 
 
109
 
* More efficient diff of only selected files.
 
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.
 
201
 
 
202
* More efficient diff of only selected files.  We should be able to
 
203
  just get the id for the selected files, look up their location and
 
204
  diff just those files.  No need to traverse the entire inventories.
110
205
 
111
206
* Fix up Inventory objects to represent root object as an entry.
112
207
 
113
 
* Don't convert entire entry from 
 
208
* Don't convert entire entry from ElementTree to an object when it is
 
209
  read in, but rather wait until the program actually wants to know
 
210
  about that node.
114
211
 
115
212
* Extract changes from one revision to the next to a text form
116
213
  suitable for transmission over email.
117
214
 
118
215
* More test cases.
119
216
 
 
217
  - ``missing`` command
 
218
 
 
219
  - Selected-file commit
 
220
 
 
221
  - Impossible selected-file commit: adding things in non-versioned
 
222
    directories, crossing renames, etc.
 
223
 
120
224
* Write a reproducible benchmark, perhaps importing various kernel versions.
121
225
 
122
 
* Change test.sh from Bourne shell into something in pure Python so
123
 
  that it can be more portable.
124
 
 
125
226
* Directly import diffs!  It seems a bit redundant to need to rescan
126
227
  the directory to work out what files diff added/deleted/changed when
127
228
  all the information is there in the diff in the first place.
131
232
  At the very least we could run diffstat over the diff, or perhaps
132
233
  read the status output from patch.  Just knowing which files might
133
234
  be modified would be enough to guide the add and commit.
134
 
  
 
235
 
135
236
  Given this we might be able to import patches at 1/second or better.
136
237
 
137
 
* Get branch over http.
138
 
 
139
 
* Pull pure updates over http.
140
 
 
141
238
* revfile compression.
142
239
 
143
 
* Split inventory into per-directory files.
 
240
* Split inventory into per-directory files?
144
241
 
145
242
* Fix ignore file parsing:
146
243
 
153
250
* Consider using Python logging library as well as/instead of
154
251
  bzrlib.trace.
155
252
 
 
253
* Commands should give some progress indication by default.
 
254
 
 
255
  - But quieten this with ``--silent``.
 
256
 
156
257
* Change to using gettext message localization.
157
258
 
158
259
* Make a clearer separation between internal and external bzrlib
169
270
 
170
271
* Handle symlinks in the working directory; at the very least it
171
272
  should be possible for them to be present and ignored/unknown
172
 
  without causing assertion failures. 
 
273
  without causing assertion failures.
173
274
 
174
275
  Eventually symlinks should be versioned.
175
276
 
177
278
  if the subdirectory is not already versioned.   Perhaps also require
178
279
  a ``--nested`` to protect against confusion.
179
280
 
180
 
* Branch names? 
181
 
 
182
 
 
 
281
* Branch names?
 
282
 
 
283
* More test framework:
 
284
 
 
285
  - Class that describes the state of a working tree so we can just
 
286
    assert it's equal.
 
287
 
 
288
* Try using XSLT to add some formatting to REST-generated HTML.  Or
 
289
  maybe write a small Python program that specifies a header and foot
 
290
  for the pages and calls into the docutils libraries.
 
291
 
 
292
* --format=xml for log, status and other commands.
 
293
 
 
294
* Attempting to explicitly add a file that's already added should give
 
295
  a warning; however there should be no warning for directories (since
 
296
  we scan for new children) or files encountered in a directory that's
 
297
  being scanned.
 
298
 
 
299
* Better handling of possible collisions on case-losing filesystems;
 
300
  make sure a single file does not get added twice under different
 
301
  names.
 
302
 
 
303
* Clean up XML inventory:
 
304
 
 
305
  - Use nesting rather than parent_id pointers.
 
306
 
 
307
  - Hold the ElementTree in memory in the Inventory object and work
 
308
    directly on that, rather than converting into Python objects every
 
309
    time it is read in.  Probably still expose it through some kind of
 
310
    object interface though, but perhaps that should just be a proxy
 
311
    for the elements.
 
312
 
 
313
  - Less special cases for the root directory.
 
314
 
 
315
* Perhaps inventories should remember the revision in which each file
 
316
  was last changed, as well as its current state?  This is a bit
 
317
  redundant but might often be interested to know.
 
318
 
 
319
* stat cache should perhaps only stat files as necessary, rather than
 
320
  doing them all up-front.  On the other hand, that disallows the
 
321
  optimization of stating them in inode order.
 
322
 
 
323
* It'd be nice to pipeline multiple HTTP requests.  Often we can
 
324
  predict what will be wanted in future: all revisions, or all texts
 
325
  in a particular revision, etc.
 
326
 
 
327
  urlgrabber's docs say they are working on batched downloads; we
 
328
  could perhaps ride on that or just create a background thread (ew).
 
329
 
 
330
* Paranoid mode where we never trust SHA-1 matches.
 
331
 
 
332
* --dry-run mode for commit?  (Or maybe just run with
 
333
  check-command=false?)
 
334
 
 
335
* Generally, be a bit more verbose unless --silent is specified.
 
336
 
 
337
* Function that finds all changes to files under a given directory;
 
338
  perhaps log should use this if a directory is given.
 
339
 
 
340
* XML attributes might have trouble with filenames containing \n and
 
341
  \r.  Do we really want to support this?  I think perhaps not.
 
342
 
 
343
* Unify smart_add and plain Branch.add(); perhaps smart_add should
 
344
  just build a list of files to add and pass that to the regular add
 
345
  function.
 
346
 
 
347
* Function to list a directory, saying in which revision each file was
 
348
  last modified.  Useful for web and GUI interfaces, and slow to
 
349
  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. 
 
353
 
 
354
* Check locking is correct during merge-related operations.
 
355
 
 
356
* Perhaps attempts to get locks should timeout after some period of
 
357
  time, or at least display a progress message.
 
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
 
 
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.
183
378
 
184
379
 
185
380
Large things
216
411
  files, and respecting selective commits.  Run the pre-commit check
217
412
  (e.g. compile and run test suite) in there.
218
413
 
 
414
  Possibly this should be done by splitting the commit function into
 
415
  several parts (under a single interface).  It is already rather
 
416
  large.  Decomposition:
 
417
 
 
418
   - find tree modifications and prepare in-memory inventory
 
419
 
 
420
   - export that inventory to a temporary directory
 
421
 
 
422
   - run the test in that temporary directory
 
423
 
 
424
   - if that succeeded, continue to actually finish the commit
 
425
 
 
426
  What should be done with the text of modified files while this is
 
427
  underway?  I don't think we want to count on holding them in memory
 
428
  and we can't trust the working files to stay in one place so I
 
429
  suppose we need to move them into the text store, or otherwise into
 
430
  a temporary directory.
 
431
 
 
432
  If the commit does not actually complete, we would rather the
 
433
  content was not left behind in the stores.
 
434
 
219
435
* Web interface
220
436
 
221
437
* GUI (maybe in Python GTK+?)
227
443
  with removing the tags on the way back in.
228
444
 
229
445
* ``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?