~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: John Arbash Meinel
  • Date: 2005-09-15 21:35:53 UTC
  • mfrom: (907.1.57)
  • mto: (1393.2.1)
  • mto: This revision was merged to the branch mainline in revision 1396.
  • Revision ID: john@arbash-meinel.com-20050915213552-a6c83a5ef1e20897
(broken) Transport work is merged in. Tests do not pass yet.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
                                                 -*- indented-text -*-
 
1
.. -*- mode: indented-text; compile-command: "make -C doc" -*-
 
2
 
 
3
 
 
4
*******************
 
5
Things to do in bzr
 
6
*******************
 
7
 
2
8
 
3
9
See also various low-level TODOs in the source code.  Try looking in
4
10
the list archive or on gmane.org for previous discussion of these
11
17
Small things
12
18
------------
13
19
 
 
20
* ``bzr status`` should show some description of patches that are merged but 
 
21
  not yet committed.  Preferably in a very compact format so that they
 
22
  just fit on a single line; this could also be used for say ``log
 
23
  --tiny``::
 
24
 
 
25
  2005-11-05      mbp  Flowers for stephane
 
26
 
 
27
* print a message at the end of running the tests telling them that the
 
28
  test log and output exists but can be removed
 
29
 
 
30
* tests for running the commit editor, and fix problem of not passing in 
 
31
  multiple arguments
 
32
 
 
33
* Merging add of a new file clashing with an existing file doesn't
 
34
  work; add gets an error that it's already versioned and the merge
 
35
  aborts.
 
36
 
 
37
* Merge should ignore the destination's working directory, otherwise
 
38
  we get an error about the statcache when pulling from a remote
 
39
  branch.
 
40
 
14
41
* Add of a file that was present in the base revision should put back
15
42
  the previous file-id.
16
43
 
 
44
* Not sure I'm happy with needing to pass a root id to EmptyTree;
 
45
  comparing anything against an EmptyTree with no root should have the
 
46
  same effect(?)
 
47
 
17
48
* Handle diff of files which do not have a trailing newline; probably
18
49
  requires patching difflib to get it exactly right, or otherwise
19
50
  calling out to GNU diff.
20
51
 
21
 
* Import ElementTree update patch.
22
 
 
23
 
* Syntax should be "bzr export -r REV".
24
 
 
25
 
* "cat -rREV FILE"
26
 
 
27
 
* Plugins that provide commands.  By just installing a file into some
28
 
  directory (e.g. /usr/share/bzr/plugins) it should be possible to
29
 
  create new top-level commands ("bzr frob").  Extensions can be
30
 
  written in either Python (in which case they use the bzrlib API) or
31
 
  in a separate process (in sh, C, whatever).   It should be possible
32
 
  to get help for plugin commands.
33
 
 
34
 
* Smart rewrap text in help messages to fit in $COLUMNS (or equivalent
35
 
  on Windows)
 
52
* Should be able to copy files between branches to preserve their
 
53
  file-id (and perhaps eventually parentage.)
36
54
 
37
55
* -r option should take a revision-id as well as a revno.
38
56
 
39
 
* "bzr info" could show space used by working tree, versioned files,
40
 
  unknown and ignored files. 
 
57
* allow ``bzr st -r 300`` to show a summary of changes since then.
41
58
 
42
 
* "bzr info" should count only people with distinct email addresses as
 
59
* ``bzr info`` should count only people with distinct email addresses as
43
60
  different committers.  (Or perhaps only distinct userids?)
44
61
 
45
 
* Tidier error for EPIPE: should be just "bzr: broken pipe" with no
46
 
  other details because debugging information is rarely interesting.
47
 
 
48
 
* On Windows, command-line arguments should be glob-expanded__,
 
62
* On Windows, command-line arguments should be `glob-expanded`__,
49
63
  because the shell doesn't do this.  However, there are probably some
50
64
  commands where this shouldn't be done, such as 'bzr ignore', because
51
65
  we want to accept globs.
52
66
 
 
67
* ``bzr ignore`` command that just adds a line to the ``.bzrignore`` file
 
68
  and makes it versioned.  Fix this to break symlinks.
 
69
 
 
70
* Any useful sanity checks in 'bzr ignore'?  Perhaps give a warning if
 
71
  they try to add a single file which is already versioned, or if they
 
72
  add a pattern which already exists, or if it looks like they gave an
 
73
  unquoted glob.
 
74
 
53
75
__ http://mail.python.org/pipermail/python-list/2001-April/037847.html
54
76
 
 
77
* Separate read and write version checks?
 
78
 
 
79
* ``bzr status DIR`` should give status on all files under that
 
80
  directory.
 
81
 
 
82
* ``bzr log DIR`` should give changes to any files within DIR; at the
 
83
  moment it only lists things which modify the specific named file
 
84
  (and not its contents)
 
85
 
 
86
* ``bzr inventory -r REV`` and perhaps unify this with ``bzr ls``,
 
87
  giving options to display ids, types, etc.
 
88
 
 
89
* Split BzrError into various more specific subclasses for different
 
90
  errors people might want to catch.
 
91
 
 
92
* If the export destination ends in '.tar', '.tar.gz', etc then create
 
93
  a tarball instead of a directory.  (Need to actually make a
 
94
  temporary directory and then tar that up.)
 
95
 
 
96
  http://www.gelato.unsw.edu.au/archives/git/0504/2194.html
 
97
 
 
98
* RemoteBranch could maintain a cache either in memory or on disk.  We
 
99
  know more than an external cache might about which files are
 
100
  immutable and which can vary.  On the other hand, it's much simpler
 
101
  to just use an external proxy cache.
 
102
 
 
103
  Perhaps ~/.bzr/http-cache.  Baz has a fairly simple cache under
 
104
  ~/.arch-cache, containing revision information encoded almost as a
 
105
  bunch of archives.  Perhaps we could simply store full paths.
 
106
 
 
107
* Maybe also store directories in the statcache so that we can quickly
 
108
  identify that they still exist.
 
109
 
 
110
* Diff should show timestamps; for files from the working directory we
 
111
  can use the file itself; for files from a revision we should use the
 
112
  commit time of the revision.
 
113
 
 
114
* Perhaps split command infrastructure from the actual command
 
115
  definitions.
 
116
 
 
117
* Cleaner support for negative boolean options like --no-recurse.
 
118
 
 
119
* Statcache should possibly map all file paths to / separators
 
120
 
 
121
* quotefn doubles all backslashes on Windows; this is probably not the
 
122
  best thing to do.  What would be a better way to safely represent
 
123
  filenames?  Perhaps we could doublequote things containing spaces,
 
124
  on the principle that filenames containing quotes are unlikely?
 
125
  Nice for humans; less good for machine parsing.
 
126
 
 
127
* Patches should probably use only forward slashes, even on Windows,
 
128
  otherwise Unix patch can't apply them. (?)
 
129
 
 
130
* Branch.update_revisions() inefficiently fetches revisions from the
 
131
  remote server twice; once to find out what text and inventory they
 
132
  need and then again to actually get the thing.  This is a bit
 
133
  inefficient.
 
134
 
 
135
  One complicating factor here is that we don't really want to have
 
136
  revisions present in the revision-store until all their constituent
 
137
  parts are also stored.
 
138
 
 
139
  The basic problem is that RemoteBranch.get_revision() and similar
 
140
  methods return object, but what we really want is the raw XML, which
 
141
  can be popped into our own store.  That needs to be refactored.
 
142
 
 
143
* ``bzr status FOO`` where foo is ignored should say so.
 
144
 
 
145
* ``bzr mkdir A...`` should just create and add A.
 
146
 
 
147
* Guard against repeatedly merging any particular patch.
 
148
 
 
149
* More options for diff:
 
150
 
 
151
  - diff two revisions of the same tree
 
152
 
 
153
  - diff two different branches, optionally at different revisions
 
154
 
 
155
  - diff a particular file in another tree against the corresponding
 
156
    version in this tree (which should be the default if the second
 
157
    parameter is a tree root)
 
158
 
 
159
  - diff everything under a particular directory, in any of the above
 
160
    ways
 
161
 
 
162
  - diff two files inside the same tree, even if they have different
 
163
    ids
 
164
 
 
165
  - and, of course, tests for all this
 
166
 
 
167
* ``bzr add`` with no arguments should probably be the same as ``bzr add .``
 
168
 
 
169
* Reproducible performance benchmark to measure whether performance is 
 
170
  getting better or worse.
 
171
 
 
172
* ``bzr log -m foo`` should perhaps error if nothing matches?
 
173
 
 
174
* ``bzr diff -r 30 -r 40 foo.c`` or ``bzr diff -r30..40 foo.c``
 
175
 
 
176
  If diffing between two branches then we probably want two -r
 
177
  options, since the revisions don't form a range that can be
 
178
  evaluated on either one.
 
179
 
 
180
* bzr diff shouldn't diff binary files
 
181
 
 
182
* setup.py install when run from a bzr tree should freeze the tree
 
183
  revision-id into the installed bzr.
 
184
 
 
185
* bzr script should trap ImportError and perhaps give a better error
 
186
  message?
 
187
 
 
188
* revert after a merge should possibly remove all the BASE/THIS/OTHER
 
189
  files to get you back to where you were.
 
190
 
 
191
* files that are added and then deleted are still reported as added
 
192
 
 
193
* stores should raise KeyError, not IndexError
 
194
 
 
195
* merging from a remote branch seems to sometimes raise errors not
 
196
  present locally
 
197
 
 
198
* should be possible to give a related branch when pulling from a
 
199
  remote branch to make things faster
 
200
 
 
201
* sometimes gives "conflicting add" even when the contents are in fact
 
202
  the same???
 
203
 
 
204
* BZRDIR should be in branch.py not __init__.py.
 
205
 
 
206
* ``status `` should accept a -r option to show changes relative to a revision,
 
207
  or between revisions
 
208
 
55
209
Medium things
56
210
-------------
57
211
 
58
 
* Selective commit of only some files.
59
 
 
60
 
* Faster diff/status.  
61
 
 
62
 
  Status should be handled differently because it needs to report on
63
 
  deleted and unknown files.  diff only needs to deal with versioned
64
 
  files.
65
 
 
66
 
* Merge Aaron's merge code.
67
 
 
68
 
* Merge revert patch.
69
 
 
70
 
* Turn on stat cache code, and add optimization about avoiding
71
 
  dangerous cache entries.
72
 
 
73
 
* mv command?
74
 
 
75
 
* More efficient diff of only selected files.
 
212
* ~/.bzr.log is not written anymore for some reason.
 
213
 
 
214
* merge should add all revision and inventory XML to the local store.
 
215
 
 
216
* check should give a warning for revisions that are named in the
 
217
  chain but not actually present in the store.
 
218
 
 
219
* remove anything outside of the branch implementation that directly
 
220
  accesses the stores.
 
221
 
 
222
* More efficient diff of only selected files.  We should be able to
 
223
  just get the id for the selected files, look up their location and
 
224
  diff just those files.  No need to traverse the entire inventories.
 
225
 
 
226
* ``bzr status DIR`` or ``bzr diff DIR`` should report on all changes
 
227
  under that directory.
76
228
 
77
229
* Fix up Inventory objects to represent root object as an entry.
78
230
 
79
 
* Don't convert entire entry from 
 
231
* Don't convert entire entry from ElementTree to an object when it is
 
232
  read in, but rather wait until the program actually wants to know
 
233
  about that node.
80
234
 
81
235
* Extract changes from one revision to the next to a text form
82
236
  suitable for transmission over email.
83
237
 
84
238
* More test cases.
85
239
 
 
240
  - ``missing`` command
 
241
 
 
242
  - Selected-file commit
 
243
 
 
244
  - Impossible selected-file commit: adding things in non-versioned
 
245
    directories, crossing renames, etc.
 
246
 
86
247
* Write a reproducible benchmark, perhaps importing various kernel versions.
87
248
 
88
 
* Change test.sh from Bourne shell into something in pure Python so
89
 
  that it can be more portable.
90
 
 
91
249
* Directly import diffs!  It seems a bit redundant to need to rescan
92
250
  the directory to work out what files diff added/deleted/changed when
93
251
  all the information is there in the diff in the first place.
97
255
  At the very least we could run diffstat over the diff, or perhaps
98
256
  read the status output from patch.  Just knowing which files might
99
257
  be modified would be enough to guide the add and commit.
100
 
  
 
258
 
101
259
  Given this we might be able to import patches at 1/second or better.
102
260
 
103
 
* Get branch over http.
104
 
 
105
 
* Pull pure updates over http.
106
 
 
107
261
* revfile compression.
108
262
 
109
 
* Split inventory into per-directory files.
 
263
* Split inventory into per-directory files?
110
264
 
111
265
* Fix ignore file parsing:
112
266
 
116
270
 
117
271
  - perhaps a pattern that matches only directories or non-directories
118
272
 
119
 
* Expansion of $Id$ keywords within working files.  Perhaps do this in
120
 
  exports first as a simpler case because then we don't need to deal
121
 
  with removing the tags on the way back in.
 
273
* Consider using Python logging library as well as/instead of
 
274
  bzrlib.trace.
 
275
 
 
276
* Commands should give some progress indication by default.
 
277
 
 
278
  - But quieten this with ``--silent``.
 
279
 
 
280
* Change to using gettext message localization.
 
281
 
 
282
* Make a clearer separation between internal and external bzrlib
 
283
  interfaces.  Make internal interfaces use protected names.  Write at
 
284
  least some documentation for those APIs, probably as docstrings.
 
285
 
 
286
  Consider using ZopeInterface definitions for the external interface;
 
287
  I think these are already used in PyBaz.  They allow automatic
 
288
  checking of the interface but may be unfamiliar to general Python
 
289
  developers, so I'm not really keen.
 
290
 
 
291
* Commands to dump out all command help into a manpage or HTML file or
 
292
  whatever.
 
293
 
 
294
* Handle symlinks in the working directory; at the very least it
 
295
  should be possible for them to be present and ignored/unknown
 
296
  without causing assertion failures.
 
297
 
 
298
  Eventually symlinks should be versioned.
 
299
 
 
300
* Allow init in a subdirectory to create a nested repository, but only
 
301
  if the subdirectory is not already versioned.   Perhaps also require
 
302
  a ``--nested`` to protect against confusion.
 
303
 
 
304
* Branch names?
 
305
 
 
306
* More test framework:
 
307
 
 
308
  - Class that describes the state of a working tree so we can just
 
309
    assert it's equal.
 
310
 
 
311
* There are too many methods on Branch() that really manipulate the
 
312
  WorkingTree.  They should be moved across.
 
313
 
 
314
  Also there are some methods which are duplicated on Tree and
 
315
  Inventory objects, and it should be made more clear which ones are
 
316
  proxies and which ones behave differently, and how.
 
317
 
 
318
* Try using XSLT to add some formatting to REST-generated HTML.  Or
 
319
  maybe write a small Python program that specifies a header and foot
 
320
  for the pages and calls into the docutils libraries.
 
321
 
 
322
* --format=xml for log, status and other commands.
 
323
 
 
324
* Attempting to explicitly add a file that's already added should give
 
325
  a warning; however there should be no warning for directories (since
 
326
  we scan for new children) or files encountered in a directory that's
 
327
  being scanned.
 
328
 
 
329
* Better handling of possible collisions on case-losing filesystems;
 
330
  make sure a single file does not get added twice under different
 
331
  names.
 
332
 
 
333
* Clean up XML inventory:
 
334
 
 
335
  - Use nesting rather than parent_id pointers.
 
336
 
 
337
  - Hold the ElementTree in memory in the Inventory object and work
 
338
    directly on that, rather than converting into Python objects every
 
339
    time it is read in.  Probably still exposoe it through some kind of
 
340
    object interface though, but perhaps that should just be a proxy
 
341
    for the elements.
 
342
 
 
343
  - Less special cases for the root directory.
 
344
 
 
345
* Perhaps inventories should remember the revision in which each file
 
346
  was last changed, as well as its current state?  This is a bit
 
347
  redundant but might often be interested to know.
 
348
 
 
349
* stat cache should perhaps only stat files as necessary, rather than
 
350
  doing them all up-front.  On the other hand, that disallows the
 
351
  opimization of stating them in inode order.
 
352
 
 
353
* It'd be nice to pipeline multiple HTTP requests.  Often we can
 
354
  predict what will be wanted in future: all revisions, or all texts
 
355
  in a particular revision, etc.
 
356
 
 
357
  urlgrabber's docs say they are working on batched downloads; we
 
358
  could perhaps ride on that or just create a background thread (ew).
 
359
 
 
360
* Paranoid mode where we never trust SHA-1 matches.
 
361
 
 
362
* Don't commit if there are no changes unless forced.
 
363
 
 
364
* --dry-run mode for commit?  (Or maybe just run with
 
365
  check-command=false?)
 
366
 
 
367
* Generally, be a bit more verbose unless --silent is specified.
 
368
 
 
369
* Function that finds all changes to files under a given directory;
 
370
  perhaps log should use this if a directory is given.
 
371
 
 
372
* XML attributes might have trouble with filenames containing \n and
 
373
  \r.  Do we really want to support this?  I think perhaps not.
 
374
 
 
375
* Remember execute bits, so that exports will work OK.
 
376
 
 
377
* Unify smart_add and plain Branch.add(); perhaps smart_add should
 
378
  just build a list of files to add and pass that to the regular add
 
379
  function.
 
380
 
 
381
* Function to list a directory, saying in which revision each file was
 
382
  last modified.  Useful for web and gui interfaces, and slow to
 
383
  compute one file at a time.
 
384
  
 
385
  This will be done when we track file texts by referring to the
 
386
  version that created them. 
 
387
 
 
388
* Check locking is correct during merge-related operations.
 
389
 
 
390
* Perhaps attempts to get locks should timeout after some period of
 
391
  time, or at least display a progress message.
 
392
 
 
393
* Split out upgrade functionality from check command into a separate
 
394
  ``bzr upgrade``.
 
395
 
 
396
* Don't pass around command classes but rather pass objects.  This'd
 
397
  make it cleaner to construct objects wrapping external commands.
 
398
 
 
399
* Track all merged-in revisions in a versioned add-only metafile.
 
400
 
 
401
* ``pull --clobber`` should discard any local changes not present
 
402
  remotely.  Not generally what you want, but possibly useful when
 
403
  you're just mirroring another branch and want to keep tracking it
 
404
  even when they e.g. uncommit or make similar non-forward movements.
 
405
  Also for push I suppose.  Clobber may not be the best name, maybe
 
406
  ``--destroy``?
 
407
 
 
408
* ``uncommit`` command that removes a revision from the end of the
 
409
  revision-history; just doing this is enough to remove the commit,
 
410
  and a new commit will automatically be made against the
 
411
  predecessor.  This can be repeated.
 
412
 
 
413
  It only makes sense to delete from the tail of history, not from the
 
414
  end.
 
415
 
 
416
  The revision, its inventory and texts remain floating in the store.
 
417
  We should perhaps add the revision to a list of removed-commits, so
 
418
  that it can be restored or at least accounted for when checking
 
419
  consistency.  This file would not be versioned, and probably should
 
420
  not propagate when branched.
 
421
 
 
422
  If we track merged revisions then we need to update this list too.
 
423
  If the list is stored in a weave it's easy (implicit): the version
 
424
  of the list can remain but it won't be referenced anymore.  It's
 
425
  probably best to just store this list in a weave in the first place
 
426
  and be done.
122
427
 
123
428
 
124
429
Large things
125
430
------------
126
431
 
 
432
* Generate annotations from current file relative to previous
 
433
  annotations.
 
434
 
 
435
  - Is it necessary to store any kind of annotation where data was
 
436
    deleted?
 
437
 
 
438
* Update revfile_ format and make it active:
 
439
 
 
440
  - Texts should be identified by something keyed on the revision, not
 
441
    an individual text-id.  This is much more useful for annotate I
 
442
    think; we want to map back to the revision that last changed it.
 
443
 
 
444
  - Access revfile revisions through the Tree/Store classes.
 
445
 
 
446
  - Check them from check commands.
 
447
 
 
448
  - Store annotations.
 
449
 
 
450
.. _revfile: revfile.html
 
451
 
127
452
* Hooks for pre-commit, post-commit, etc.
128
453
 
129
454
  Consider the security implications; probably should not enable hooks
135
460
  files, and respecting selective commits.  Run the pre-commit check
136
461
  (e.g. compile and run test suite) in there.
137
462
 
 
463
  Possibly this should be done by splitting the commit function into
 
464
  several parts (under a single interface).  It is already rather
 
465
  large.  Decomposition:
 
466
 
 
467
   - find tree modifications and prepare in-memory inventory
 
468
 
 
469
   - export that inventory to a temporary directory
 
470
 
 
471
   - run the test in that temporary directory
 
472
 
 
473
   - if that succeeded, continue to actually finish the commit
 
474
 
 
475
  What should be done with the text of modified files while this is
 
476
  underway?  I don't think we want to count on holding them in memory
 
477
  and we can't trust the working files to stay in one place so I
 
478
  suppose we need to move them into the text store, or otherwise into
 
479
  a temporary directory.
 
480
 
 
481
  If the commit does not actually complete, we would rather the
 
482
  content was not left behind in the stores.
 
483
 
138
484
* Web interface
139
485
 
140
486
* GUI (maybe in Python GTK+?)
141
487
 
142
488
* C library interface
 
489
 
 
490
* Expansion of $Id$ keywords within working files.  Perhaps do this in
 
491
  exports first as a simpler case because then we don't need to deal
 
492
  with removing the tags on the way back in.
 
493
 
 
494
* ``bzr find``