~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Jelmer Vernooij
  • Date: 2005-10-19 09:34:39 UTC
  • mfrom: (1185.16.78)
  • mto: (1185.16.102)
  • mto: This revision was merged to the branch mainline in revision 1488.
  • Revision ID: jelmer@samba.org-20051019093439-e1d8e3508d1ba46b
MergeĀ fromĀ Martin

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