~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Martin Pool
  • Date: 2005-05-11 06:20:05 UTC
  • Revision ID: mbp@sourcefrog.net-20050511062005-297af3451635dae0
- Don't lose first line of command help!

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
 
 
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
* Check all commands have decent help.
85
68
 
86
69
* ``bzr inventory -r REV`` and perhaps unify this with ``bzr ls``,
87
70
  giving options to display ids, types, etc.
88
71
 
 
72
* Atomic file class that renames into place when it's closed.
 
73
 
 
74
* Don't abort if ``~/.bzr.log`` can't be used.
 
75
 
89
76
* Split BzrError into various more specific subclasses for different
90
77
  errors people might want to catch.
91
78
 
94
81
  temporary directory and then tar that up.)
95
82
 
96
83
  http://www.gelato.unsw.edu.au/archives/git/0504/2194.html
 
84
  
 
85
* testbzr should by default test the bzr binary in the same directory
 
86
  as the testbzr script, or take a path to it as a first parameter.
 
87
 
 
88
  Should show the version from bzr and the path name.
97
89
 
98
90
* RemoteBranch could maintain a cache either in memory or on disk.  We
99
91
  know more than an external cache might about which files are
100
92
  immutable and which can vary.  On the other hand, it's much simpler
101
93
  to just use an external proxy cache.
102
94
 
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
95
 
175
96
Medium things
176
97
-------------
177
98
 
 
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
* Selective commit of only some files.
 
105
 
 
106
* Faster diff/status.  
 
107
 
 
108
  Status should be handled differently because it needs to report on
 
109
  deleted and unknown files.  diff only needs to deal with versioned
 
110
  files.
 
111
 
 
112
* Merge Aaron's merge code.
 
113
 
178
114
* Merge revert patch.
179
115
 
180
116
* ``bzr mv`` that does either rename or move as in Unix.
181
117
 
182
 
* More efficient diff of only selected files.  We should be able to
183
 
  just get the id for the selected files, look up their location and
184
 
  diff just those files.  No need to traverse the entire inventories.
185
 
 
186
 
* ``bzr status DIR`` or ``bzr diff DIR`` should report on all changes
187
 
  under that directory.
 
118
* More efficient diff of only selected files.
188
119
 
189
120
* Fix up Inventory objects to represent root object as an entry.
190
121
 
191
 
* Don't convert entire entry from ElementTree to an object when it is
192
 
  read in, but rather wait until the program actually wants to know
193
 
  about that node.
 
122
* Don't convert entire entry from 
194
123
 
195
124
* Extract changes from one revision to the next to a text form
196
125
  suitable for transmission over email.
197
126
 
198
127
* More test cases.
199
128
 
200
 
  - Selected-file commit
201
 
 
202
 
  - Impossible selected-file commit: adding things in non-versioned
203
 
    directories, crossing renames, etc.
204
 
 
205
129
* Write a reproducible benchmark, perhaps importing various kernel versions.
206
130
 
 
131
* Change test.sh from Bourne shell into something in pure Python so
 
132
  that it can be more portable.
 
133
 
207
134
* Directly import diffs!  It seems a bit redundant to need to rescan
208
135
  the directory to work out what files diff added/deleted/changed when
209
136
  all the information is there in the diff in the first place.
213
140
  At the very least we could run diffstat over the diff, or perhaps
214
141
  read the status output from patch.  Just knowing which files might
215
142
  be modified would be enough to guide the add and commit.
216
 
 
 
143
  
217
144
  Given this we might be able to import patches at 1/second or better.
218
145
 
219
146
* Get branch over http.
255
182
 
256
183
* Handle symlinks in the working directory; at the very least it
257
184
  should be possible for them to be present and ignored/unknown
258
 
  without causing assertion failures.
 
185
  without causing assertion failures. 
259
186
 
260
187
  Eventually symlinks should be versioned.
261
188
 
263
190
  if the subdirectory is not already versioned.   Perhaps also require
264
191
  a ``--nested`` to protect against confusion.
265
192
 
266
 
* Branch names?
 
193
* Branch names? 
267
194
 
268
195
* More test framework:
269
196
 
271
198
    assert it's equal.
272
199
 
273
200
* There are too many methods on Branch() that really manipulate the
274
 
  WorkingTree.  They should be moved across.
 
201
  WorkingTree.  They should be moved across.  
275
202
 
276
203
  Also there are some methods which are duplicated on Tree and
277
204
  Inventory objects, and it should be made more clear which ones are
302
229
    object interface though, but perhaps that should just be a proxy
303
230
    for the elements.
304
231
 
305
 
  - Less special cases for the root directory.
 
232
  - Less special cases for the root directory. 
306
233
 
307
234
* Perhaps inventories should remember the revision in which each file
308
235
  was last changed, as well as its current state?  This is a bit
314
241
 
315
242
* It'd be nice to pipeline multiple HTTP requests.  Often we can
316
243
  predict what will be wanted in future: all revisions, or all texts
317
 
  in a particular revision, etc.
 
244
  in a particular revision, etc.  
318
245
 
319
246
  urlgrabber's docs say they are working on batched downloads; we
320
247
  could perhaps ride on that or just create a background thread (ew).
321
248
 
 
249
* Should be a signature at the top of the cache file.
 
250
 
322
251
* Paranoid mode where we never trust SHA-1 matches.
323
252
 
324
 
* Don't commit if there are no changes unless forced.
325
 
 
326
 
* --dry-run mode for commit?  (Or maybe just run with
327
 
  check-command=false?)
328
 
 
329
 
* Generally, be a bit more verbose unless --silent is specified.
330
 
 
331
 
* Function that finds all changes to files under a given directory;
332
 
  perhaps log should use this if a directory is given.
333
 
 
334
 
* XML attributes might have trouble with filenames containing \n and
335
 
  \r.  Do we really want to support this?  I think perhaps not.
336
 
 
337
 
* Remember execute bits, so that exports will work OK.
338
 
 
339
 
* Unify smart_add and plain Branch.add(); perhaps smart_add should
340
 
  just build a list of files to add and pass that to the regular add
341
 
  function.
342
 
 
343
 
* Function to list a directory, saying in which revision each file was
344
 
  last modified.  Useful for web and gui interfaces, and slow to
345
 
  compute one file at a time.
346
 
 
347
 
* unittest is standard, but the results are kind of ugly; would be
348
 
  nice to make it cleaner.
349
 
 
350
 
* Check locking is correct during merge-related operations.
351
 
 
352
 
* Perhaps attempts to get locks should timeout after some period of
353
 
  time, or at least display a progress message.
354
 
 
355
 
* Split out upgrade functionality from check command into a separate
356
 
  ``bzr upgrade``.
357
 
 
358
 
* Don't pass around command classes but rather pass objects.  This'd
359
 
  make it cleaner to construct objects wrapping external commands.
360
 
 
361
 
* Track all merged-in revisions in a versioned add-only metafile.
362
 
 
363
 
* ``pull --clobber`` should discard any local changes not present
364
 
  remotely.  Not generally what you want, but possibly useful when
365
 
  you're just mirroring another branch and want to keep tracking it
366
 
  even when they e.g. uncommit or make similar non-forward movements.
367
 
  Also for push I suppose.  Clobber may not be the best name, maybe
368
 
  ``--destroy``?
369
 
 
370
 
* ``uncommit`` command that removes a revision from the end of the
371
 
  revision-history; just doing this is enough to remove the commit,
372
 
  and a new commit will automatically be made against the
373
 
  predecessor.  This can be repeated.
374
 
 
375
 
  It only makes sense to delete from the tail of history, not from the
376
 
  end.
377
 
 
378
 
  The revision, its inventory and texts remain floating in the store.
379
 
  We should perhaps add the revision to a list of removed-commits, so
380
 
  that it can be restored or at least accounted for when checking
381
 
  consistency.  This file would not be versioned, and probably should
382
 
  not propagate when branched.
383
 
 
384
 
  If we track merged revisions then we need to update this list too.
385
 
  If the list is stored in a weave it's easy (implicit): the version
386
 
  of the list can remain but it won't be referenced anymore.  It's
387
 
  probably best to just store this list in a weave in the first place
388
 
  and be done.
389
 
 
390
253
 
391
254
Large things
392
255
------------
422
285
  files, and respecting selective commits.  Run the pre-commit check
423
286
  (e.g. compile and run test suite) in there.
424
287
 
425
 
  Possibly this should be done by splitting the commit function into
426
 
  several parts (under a single interface).  It is already rather
427
 
  large.  Decomposition:
428
 
 
429
 
   - find tree modifications and prepare in-memory inventory
430
 
 
431
 
   - export that inventory to a temporary directory
432
 
 
433
 
   - run the test in that temporary directory
434
 
 
435
 
   - if that succeeded, continue to actually finish the commit
436
 
 
437
 
  What should be done with the text of modified files while this is
438
 
  underway?  I don't think we want to count on holding them in memory
439
 
  and we can't trust the working files to stay in one place so I
440
 
  suppose we need to move them into the text store, or otherwise into
441
 
  a temporary directory.
442
 
 
443
 
  If the commit does not actually complete, we would rather the
444
 
  content was not left behind in the stores.
445
 
 
446
288
* Web interface
447
289
 
448
290
* GUI (maybe in Python GTK+?)