~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Martin Pool
  • Date: 2005-05-05 06:38:18 UTC
  • Revision ID: mbp@sourcefrog.net-20050505063818-3eb3260343878325
- do upload CHANGELOG to web server, even though it's autogenerated

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