~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Martin Pool
  • Date: 2005-05-26 15:13:20 UTC
  • Revision ID: mbp@sourcefrog.net-20050526151319-4821dee258bbaf30
- bug fix for printing logs containing unicode

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 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
 
 
41
20
* Add of a file that was present in the base revision should put back
42
21
  the previous file-id.
43
22
 
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
 
 
48
23
* Handle diff of files which do not have a trailing newline; probably
49
24
  requires patching difflib to get it exactly right, or otherwise
50
25
  calling out to GNU diff.
51
26
 
52
 
* Should be able to copy files between branches to preserve their
53
 
  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)
54
38
 
55
39
* -r option should take a revision-id as well as a revno.
56
40
 
57
 
* allow ``bzr st -r 300`` to show a summary of changes since then.
 
41
* ``bzr info`` could show space used by working tree, versioned files,
 
42
  unknown and ignored files. 
58
43
 
59
44
* ``bzr info`` should count only people with distinct email addresses as
60
45
  different committers.  (Or perhaps only distinct userids?)
79
64
* ``bzr status DIR`` should give status on all files under that
80
65
  directory.
81
66
 
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)
 
67
* ``bzr log DIR`` should give changes to any files within DIR.
 
68
 
 
69
* Check all commands have decent help.
85
70
 
86
71
* ``bzr inventory -r REV`` and perhaps unify this with ``bzr ls``,
87
72
  giving options to display ids, types, etc.
94
79
  temporary directory and then tar that up.)
95
80
 
96
81
  http://www.gelato.unsw.edu.au/archives/git/0504/2194.html
97
 
 
 
82
  
98
83
* RemoteBranch could maintain a cache either in memory or on disk.  We
99
84
  know more than an external cache might about which files are
100
85
  immutable and which can vary.  On the other hand, it's much simpler
101
86
  to just use an external proxy cache.
102
87
 
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
88
* Maybe also store directories in the statcache so that we can quickly
108
89
  identify that they still exist.
109
90
 
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
91
 
209
92
Medium things
210
93
-------------
211
94
 
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.
 
95
* Merge revert patch.
 
96
 
 
97
* ``bzr mv`` that does either rename or move as in Unix.
221
98
 
222
99
* More efficient diff of only selected files.  We should be able to
223
100
  just get the id for the selected files, look up their location and
237
114
 
238
115
* More test cases.
239
116
 
240
 
  - ``missing`` command
241
 
 
242
117
  - Selected-file commit
243
118
 
244
119
  - Impossible selected-file commit: adding things in non-versioned
255
130
  At the very least we could run diffstat over the diff, or perhaps
256
131
  read the status output from patch.  Just knowing which files might
257
132
  be modified would be enough to guide the add and commit.
258
 
 
 
133
  
259
134
  Given this we might be able to import patches at 1/second or better.
260
135
 
 
136
* Get branch over http.
 
137
 
 
138
* Pull pure updates over http.
 
139
 
261
140
* revfile compression.
262
141
 
263
 
* Split inventory into per-directory files?
 
142
* Split inventory into per-directory files.
264
143
 
265
144
* Fix ignore file parsing:
266
145
 
293
172
 
294
173
* Handle symlinks in the working directory; at the very least it
295
174
  should be possible for them to be present and ignored/unknown
296
 
  without causing assertion failures.
 
175
  without causing assertion failures. 
297
176
 
298
177
  Eventually symlinks should be versioned.
299
178
 
301
180
  if the subdirectory is not already versioned.   Perhaps also require
302
181
  a ``--nested`` to protect against confusion.
303
182
 
304
 
* Branch names?
 
183
* Branch names? 
305
184
 
306
185
* More test framework:
307
186
 
309
188
    assert it's equal.
310
189
 
311
190
* There are too many methods on Branch() that really manipulate the
312
 
  WorkingTree.  They should be moved across.
 
191
  WorkingTree.  They should be moved across.  
313
192
 
314
193
  Also there are some methods which are duplicated on Tree and
315
194
  Inventory objects, and it should be made more clear which ones are
340
219
    object interface though, but perhaps that should just be a proxy
341
220
    for the elements.
342
221
 
343
 
  - Less special cases for the root directory.
 
222
  - Less special cases for the root directory. 
344
223
 
345
224
* Perhaps inventories should remember the revision in which each file
346
225
  was last changed, as well as its current state?  This is a bit
352
231
 
353
232
* It'd be nice to pipeline multiple HTTP requests.  Often we can
354
233
  predict what will be wanted in future: all revisions, or all texts
355
 
  in a particular revision, etc.
 
234
  in a particular revision, etc.  
356
235
 
357
236
  urlgrabber's docs say they are working on batched downloads; we
358
237
  could perhaps ride on that or just create a background thread (ew).
372
251
* XML attributes might have trouble with filenames containing \n and
373
252
  \r.  Do we really want to support this?  I think perhaps not.
374
253
 
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.
427
 
 
428
254
 
429
255
Large things
430
256
------------
479
305
  a temporary directory.
480
306
 
481
307
  If the commit does not actually complete, we would rather the
482
 
  content was not left behind in the stores.
 
308
  content was not left behind in the stores.  
483
309
 
484
310
* Web interface
485
311