~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Robert Collins
  • Date: 2005-08-23 06:52:09 UTC
  • mto: (974.1.50) (1185.1.10) (1092.3.1)
  • mto: This revision was merged to the branch mainline in revision 1139.
  • Revision ID: robertc@robertcollins.net-20050823065209-81cd5962c401751b
move io redirection into each test case from the global runner

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
* print a message at the end of running the tests telling them tht 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
 
20
41
* Add of a file that was present in the base revision should put back
21
42
  the previous file-id.
22
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
 
23
48
* Handle diff of files which do not have a trailing newline; probably
24
49
  requires patching difflib to get it exactly right, or otherwise
25
50
  calling out to GNU diff.
26
51
 
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
* Should be able to copy files between branches to preserve their
 
53
  file-id (and perhaps eventually parentage.)
38
54
 
39
55
* -r option should take a revision-id as well as a revno.
40
56
 
41
 
* ``bzr info`` could show space used by working tree, versioned files,
42
 
  unknown and ignored files. 
 
57
* allow ``bzr st -r 300`` to show a summary of changes since then.
43
58
 
44
59
* ``bzr info`` should count only people with distinct email addresses as
45
60
  different committers.  (Or perhaps only distinct userids?)
64
79
* ``bzr status DIR`` should give status on all files under that
65
80
  directory.
66
81
 
67
 
* ``bzr log DIR`` should give changes to any files within DIR.
68
 
 
69
 
* Check all commands have decent help.
 
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)
70
85
 
71
86
* ``bzr inventory -r REV`` and perhaps unify this with ``bzr ls``,
72
87
  giving options to display ids, types, etc.
73
88
 
74
 
* Atomic file class that renames into place when it's closed.
75
 
 
76
 
* Don't abort if ``~/.bzr.log`` can't be used.
77
 
 
78
89
* Split BzrError into various more specific subclasses for different
79
90
  errors people might want to catch.
80
91
 
83
94
  temporary directory and then tar that up.)
84
95
 
85
96
  http://www.gelato.unsw.edu.au/archives/git/0504/2194.html
86
 
  
 
97
 
87
98
* RemoteBranch could maintain a cache either in memory or on disk.  We
88
99
  know more than an external cache might about which files are
89
100
  immutable and which can vary.  On the other hand, it's much simpler
90
101
  to just use an external proxy cache.
91
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
 
92
107
* Maybe also store directories in the statcache so that we can quickly
93
108
  identify that they still exist.
94
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
 
95
204
 
96
205
Medium things
97
206
-------------
98
207
 
99
 
* Change command functions into Command() objects, like in hct, and
100
 
  then the grammar can be described directly in there.  Since all
101
 
  option definitions are global we can define them just once and
102
 
  reference them from each command.
103
 
 
104
 
* Merge Aaron's merge code.
105
 
 
106
 
* Merge revert patch.
107
 
 
108
 
* ``bzr mv`` that does either rename or move as in Unix.
 
208
* ~/.bzr.log is not written anymore for some reason.
 
209
 
 
210
* merge should add all revision and inventory XML to the local store.
 
211
 
 
212
* check should give a warning for revisions that are named in the
 
213
  chain but not actually present in the store.
 
214
 
 
215
* remove anything outside of the branch implementation that directly
 
216
  accesses the stores.
109
217
 
110
218
* More efficient diff of only selected files.  We should be able to
111
219
  just get the id for the selected files, look up their location and
116
224
 
117
225
* Fix up Inventory objects to represent root object as an entry.
118
226
 
119
 
* Don't convert entire entry from 
 
227
* Don't convert entire entry from ElementTree to an object when it is
 
228
  read in, but rather wait until the program actually wants to know
 
229
  about that node.
120
230
 
121
231
* Extract changes from one revision to the next to a text form
122
232
  suitable for transmission over email.
123
233
 
124
234
* More test cases.
125
235
 
 
236
  - ``missing`` command
 
237
 
126
238
  - Selected-file commit
127
239
 
128
240
  - Impossible selected-file commit: adding things in non-versioned
130
242
 
131
243
* Write a reproducible benchmark, perhaps importing various kernel versions.
132
244
 
133
 
* Change test.sh from Bourne shell into something in pure Python so
134
 
  that it can be more portable.
135
 
 
136
245
* Directly import diffs!  It seems a bit redundant to need to rescan
137
246
  the directory to work out what files diff added/deleted/changed when
138
247
  all the information is there in the diff in the first place.
142
251
  At the very least we could run diffstat over the diff, or perhaps
143
252
  read the status output from patch.  Just knowing which files might
144
253
  be modified would be enough to guide the add and commit.
145
 
  
 
254
 
146
255
  Given this we might be able to import patches at 1/second or better.
147
256
 
148
 
* Get branch over http.
149
 
 
150
 
* Pull pure updates over http.
151
 
 
152
257
* revfile compression.
153
258
 
154
 
* Split inventory into per-directory files.
 
259
* Split inventory into per-directory files?
155
260
 
156
261
* Fix ignore file parsing:
157
262
 
184
289
 
185
290
* Handle symlinks in the working directory; at the very least it
186
291
  should be possible for them to be present and ignored/unknown
187
 
  without causing assertion failures. 
 
292
  without causing assertion failures.
188
293
 
189
294
  Eventually symlinks should be versioned.
190
295
 
192
297
  if the subdirectory is not already versioned.   Perhaps also require
193
298
  a ``--nested`` to protect against confusion.
194
299
 
195
 
* Branch names? 
 
300
* Branch names?
196
301
 
197
302
* More test framework:
198
303
 
200
305
    assert it's equal.
201
306
 
202
307
* There are too many methods on Branch() that really manipulate the
203
 
  WorkingTree.  They should be moved across.  
 
308
  WorkingTree.  They should be moved across.
204
309
 
205
310
  Also there are some methods which are duplicated on Tree and
206
311
  Inventory objects, and it should be made more clear which ones are
231
336
    object interface though, but perhaps that should just be a proxy
232
337
    for the elements.
233
338
 
234
 
  - Less special cases for the root directory. 
 
339
  - Less special cases for the root directory.
235
340
 
236
341
* Perhaps inventories should remember the revision in which each file
237
342
  was last changed, as well as its current state?  This is a bit
243
348
 
244
349
* It'd be nice to pipeline multiple HTTP requests.  Often we can
245
350
  predict what will be wanted in future: all revisions, or all texts
246
 
  in a particular revision, etc.  
 
351
  in a particular revision, etc.
247
352
 
248
353
  urlgrabber's docs say they are working on batched downloads; we
249
354
  could perhaps ride on that or just create a background thread (ew).
250
355
 
251
 
* Should be a signature at the top of the cache file.
252
 
 
253
356
* Paranoid mode where we never trust SHA-1 matches.
254
357
 
255
358
* Don't commit if there are no changes unless forced.
262
365
* Function that finds all changes to files under a given directory;
263
366
  perhaps log should use this if a directory is given.
264
367
 
 
368
* XML attributes might have trouble with filenames containing \n and
 
369
  \r.  Do we really want to support this?  I think perhaps not.
 
370
 
 
371
* Remember execute bits, so that exports will work OK.
 
372
 
 
373
* Unify smart_add and plain Branch.add(); perhaps smart_add should
 
374
  just build a list of files to add and pass that to the regular add
 
375
  function.
 
376
 
 
377
* Function to list a directory, saying in which revision each file was
 
378
  last modified.  Useful for web and gui interfaces, and slow to
 
379
  compute one file at a time.
 
380
  
 
381
  This will be done when we track file texts by referring to the
 
382
  version that created them. 
 
383
 
 
384
* Check locking is correct during merge-related operations.
 
385
 
 
386
* Perhaps attempts to get locks should timeout after some period of
 
387
  time, or at least display a progress message.
 
388
 
 
389
* Split out upgrade functionality from check command into a separate
 
390
  ``bzr upgrade``.
 
391
 
 
392
* Don't pass around command classes but rather pass objects.  This'd
 
393
  make it cleaner to construct objects wrapping external commands.
 
394
 
 
395
* Track all merged-in revisions in a versioned add-only metafile.
 
396
 
 
397
* ``pull --clobber`` should discard any local changes not present
 
398
  remotely.  Not generally what you want, but possibly useful when
 
399
  you're just mirroring another branch and want to keep tracking it
 
400
  even when they e.g. uncommit or make similar non-forward movements.
 
401
  Also for push I suppose.  Clobber may not be the best name, maybe
 
402
  ``--destroy``?
 
403
 
 
404
* ``uncommit`` command that removes a revision from the end of the
 
405
  revision-history; just doing this is enough to remove the commit,
 
406
  and a new commit will automatically be made against the
 
407
  predecessor.  This can be repeated.
 
408
 
 
409
  It only makes sense to delete from the tail of history, not from the
 
410
  end.
 
411
 
 
412
  The revision, its inventory and texts remain floating in the store.
 
413
  We should perhaps add the revision to a list of removed-commits, so
 
414
  that it can be restored or at least accounted for when checking
 
415
  consistency.  This file would not be versioned, and probably should
 
416
  not propagate when branched.
 
417
 
 
418
  If we track merged revisions then we need to update this list too.
 
419
  If the list is stored in a weave it's easy (implicit): the version
 
420
  of the list can remain but it won't be referenced anymore.  It's
 
421
  probably best to just store this list in a weave in the first place
 
422
  and be done.
 
423
 
265
424
 
266
425
Large things
267
426
------------
316
475
  a temporary directory.
317
476
 
318
477
  If the commit does not actually complete, we would rather the
319
 
  content was not left behind in the stores.  
 
478
  content was not left behind in the stores.
320
479
 
321
480
* Web interface
322
481