~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Martin Pool
  • Date: 2005-07-22 23:32:00 UTC
  • Revision ID: mbp@sourcefrog.net-20050722233200-ccdeca985093a9fb
- now needs python 2.4
- update instructions for running selftest

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
* Merging add of a new file clashing with an existing file doesn't
 
21
  work; add gets an error that it's already versioned and the merge
 
22
  aborts.
 
23
 
 
24
* Merge should ignore the destination's working directory, otherwise
 
25
  we get an error about the statcache when pulling from a remote
 
26
  branch.
 
27
 
20
28
* Add of a file that was present in the base revision should put back
21
29
  the previous file-id.
22
30
 
 
31
* Not sure I'm happy with needing to pass a root id to EmptyTree;
 
32
  comparing anything against an EmptyTree with no root should have the
 
33
  same effect(?)
 
34
 
23
35
* Handle diff of files which do not have a trailing newline; probably
24
36
  requires patching difflib to get it exactly right, or otherwise
25
37
  calling out to GNU diff.
26
38
 
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)
 
39
* Should be able to copy files between branches to preserve their
 
40
  file-id (and perhaps eventually parentage.)
38
41
 
39
42
* -r option should take a revision-id as well as a revno.
40
43
 
41
 
* ``bzr info`` could show space used by working tree, versioned files,
42
 
  unknown and ignored files. 
 
44
* allow ``bzr st -r 300`` to show a summary of changes since then.
43
45
 
44
46
* ``bzr info`` should count only people with distinct email addresses as
45
47
  different committers.  (Or perhaps only distinct userids?)
64
66
* ``bzr status DIR`` should give status on all files under that
65
67
  directory.
66
68
 
67
 
* Check all commands have decent help.
 
69
* ``bzr log DIR`` should give changes to any files within DIR.
68
70
 
69
71
* ``bzr inventory -r REV`` and perhaps unify this with ``bzr ls``,
70
72
  giving options to display ids, types, etc.
71
73
 
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
 
 
76
74
* Split BzrError into various more specific subclasses for different
77
75
  errors people might want to catch.
78
76
 
81
79
  temporary directory and then tar that up.)
82
80
 
83
81
  http://www.gelato.unsw.edu.au/archives/git/0504/2194.html
 
82
 
 
83
* RemoteBranch could maintain a cache either in memory or on disk.  We
 
84
  know more than an external cache might about which files are
 
85
  immutable and which can vary.  On the other hand, it's much simpler
 
86
  to just use an external proxy cache.
 
87
 
 
88
  Perhaps ~/.bzr/http-cache.  Baz has a fairly simple cache under
 
89
  ~/.arch-cache, containing revision information encoded almost as a
 
90
  bunch of archives.  Perhaps we could simply store full paths.
 
91
 
 
92
* Maybe also store directories in the statcache so that we can quickly
 
93
  identify that they still exist.
 
94
 
 
95
* Diff should show timestamps; for files from the working directory we
 
96
  can use the file itself; for files from a revision we should use the
 
97
  commit time of the revision.
 
98
 
 
99
* Perhaps split command infrastructure from the actual command
 
100
  definitions.
 
101
 
 
102
* Cleaner support for negative boolean options like --no-recurse.
 
103
 
 
104
* Statcache should possibly map all file paths to / separators
 
105
 
 
106
* quotefn doubles all backslashes on Windows; this is probably not the
 
107
  best thing to do.  What would be a better way to safely represent
 
108
  filenames?  Perhaps we could doublequote things containing spaces,
 
109
  on the principle that filenames containing quotes are unlikely?
 
110
  Nice for humans; less good for machine parsing.
 
111
 
 
112
* Patches should probably use only forward slashes, even on Windows,
 
113
  otherwise Unix patch can't apply them. (?)
 
114
 
 
115
* Branch.update_revisions() inefficiently fetches revisions from the
 
116
  remote server twice; once to find out what text and inventory they
 
117
  need and then again to actually get the thing.  This is a bit
 
118
  inefficient.
 
119
 
 
120
  One complicating factor here is that we don't really want to have
 
121
  revisions present in the revision-store until all their constituent
 
122
  parts are also stored.
 
123
 
 
124
  The basic problem is that RemoteBranch.get_revision() and similar
 
125
  methods return object, but what we really want is the raw XML, which
 
126
  can be popped into our own store.  That needs to be refactored.
 
127
 
 
128
* ``bzr status FOO`` where foo is ignored should say so.
 
129
 
 
130
* ``bzr mkdir A...`` should just create and add A.
 
131
 
 
132
* Guard against repeatedly merging any particular patch.
 
133
 
 
134
* More options for diff:
 
135
 
 
136
  - diff two revisions of the same tree
 
137
 
 
138
  - diff two different branches, optionally at different revisions
 
139
 
 
140
  - diff a particular file in another tree against the corresponding
 
141
    version in this tree (which should be the default if the second
 
142
    parameter is a tree root)
 
143
 
 
144
  - diff everything under a particular directory, in any of the above
 
145
    ways
 
146
 
 
147
  - diff two files inside the same tree, even if they have different
 
148
    ids
 
149
 
 
150
  - and, of course, tests for all this
 
151
 
 
152
* stat-cache update is too slow for some reason - why is Python making
 
153
  a lot of futex calls?
84
154
  
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.
 
155
* ``bzr add`` with no arguments should probably be the same as ``bzr add .``
 
156
 
 
157
 
89
158
 
90
159
Medium things
91
160
-------------
92
161
 
93
 
* Display command grammar in help messages rather than hardcoding it.
94
 
 
95
 
* Change command functions into Command() objects, like in hct, and
96
 
  then the grammar can be described directly in there.  Since all
97
 
  option definitions are global we can define them just once and
98
 
  reference them from each command.
99
 
 
100
 
* Selective commit of only some files.
101
 
 
102
 
* Faster diff/status.  
103
 
 
104
 
  Status should be handled differently because it needs to report on
105
 
  deleted and unknown files.  diff only needs to deal with versioned
106
 
  files.
107
 
 
108
 
* Merge Aaron's merge code.
109
 
 
110
162
* Merge revert patch.
111
163
 
112
 
* Turn on stat cache code, and add optimization about avoiding
113
 
  dangerous cache entries.
114
 
 
115
164
* ``bzr mv`` that does either rename or move as in Unix.
116
165
 
117
 
* More efficient diff of only selected files.
 
166
* More efficient diff of only selected files.  We should be able to
 
167
  just get the id for the selected files, look up their location and
 
168
  diff just those files.  No need to traverse the entire inventories.
 
169
 
 
170
* ``bzr status DIR`` or ``bzr diff DIR`` should report on all changes
 
171
  under that directory.
118
172
 
119
173
* Fix up Inventory objects to represent root object as an entry.
120
174
 
121
 
* Don't convert entire entry from 
 
175
* Don't convert entire entry from ElementTree to an object when it is
 
176
  read in, but rather wait until the program actually wants to know
 
177
  about that node.
122
178
 
123
179
* Extract changes from one revision to the next to a text form
124
180
  suitable for transmission over email.
125
181
 
126
182
* More test cases.
127
183
 
 
184
  - Selected-file commit
 
185
 
 
186
  - Impossible selected-file commit: adding things in non-versioned
 
187
    directories, crossing renames, etc.
 
188
 
128
189
* Write a reproducible benchmark, perhaps importing various kernel versions.
129
190
 
130
 
* Change test.sh from Bourne shell into something in pure Python so
131
 
  that it can be more portable.
132
 
 
133
191
* Directly import diffs!  It seems a bit redundant to need to rescan
134
192
  the directory to work out what files diff added/deleted/changed when
135
193
  all the information is there in the diff in the first place.
139
197
  At the very least we could run diffstat over the diff, or perhaps
140
198
  read the status output from patch.  Just knowing which files might
141
199
  be modified would be enough to guide the add and commit.
142
 
  
 
200
 
143
201
  Given this we might be able to import patches at 1/second or better.
144
202
 
145
203
* Get branch over http.
181
239
 
182
240
* Handle symlinks in the working directory; at the very least it
183
241
  should be possible for them to be present and ignored/unknown
184
 
  without causing assertion failures. 
 
242
  without causing assertion failures.
185
243
 
186
244
  Eventually symlinks should be versioned.
187
245
 
189
247
  if the subdirectory is not already versioned.   Perhaps also require
190
248
  a ``--nested`` to protect against confusion.
191
249
 
192
 
* Branch names? 
 
250
* Branch names?
193
251
 
194
252
* More test framework:
195
253
 
197
255
    assert it's equal.
198
256
 
199
257
* There are too many methods on Branch() that really manipulate the
200
 
  WorkingTree.  They should be moved across.  
 
258
  WorkingTree.  They should be moved across.
201
259
 
202
260
  Also there are some methods which are duplicated on Tree and
203
261
  Inventory objects, and it should be made more clear which ones are
224
282
 
225
283
  - Hold the ElementTree in memory in the Inventory object and work
226
284
    directly on that, rather than converting into Python objects every
227
 
    time it is read in.  Probably still expose it through some kind of
 
285
    time it is read in.  Probably still exposoe it through some kind of
228
286
    object interface though, but perhaps that should just be a proxy
229
287
    for the elements.
230
288
 
231
 
  - Less special cases for the root directory. 
 
289
  - Less special cases for the root directory.
232
290
 
233
291
* Perhaps inventories should remember the revision in which each file
234
292
  was last changed, as well as its current state?  This is a bit
235
293
  redundant but might often be interested to know.
236
294
 
 
295
* stat cache should perhaps only stat files as necessary, rather than
 
296
  doing them all up-front.  On the other hand, that disallows the
 
297
  opimization of stating them in inode order.
 
298
 
 
299
* It'd be nice to pipeline multiple HTTP requests.  Often we can
 
300
  predict what will be wanted in future: all revisions, or all texts
 
301
  in a particular revision, etc.
 
302
 
 
303
  urlgrabber's docs say they are working on batched downloads; we
 
304
  could perhaps ride on that or just create a background thread (ew).
 
305
 
 
306
* Paranoid mode where we never trust SHA-1 matches.
 
307
 
 
308
* Don't commit if there are no changes unless forced.
 
309
 
 
310
* --dry-run mode for commit?  (Or maybe just run with
 
311
  check-command=false?)
 
312
 
 
313
* Generally, be a bit more verbose unless --silent is specified.
 
314
 
 
315
* Function that finds all changes to files under a given directory;
 
316
  perhaps log should use this if a directory is given.
 
317
 
 
318
* XML attributes might have trouble with filenames containing \n and
 
319
  \r.  Do we really want to support this?  I think perhaps not.
 
320
 
 
321
* Remember execute bits, so that exports will work OK.
 
322
 
 
323
* Unify smart_add and plain Branch.add(); perhaps smart_add should
 
324
  just build a list of files to add and pass that to the regular add
 
325
  function.
 
326
 
 
327
* Function to list a directory, saying in which revision each file was
 
328
  last modified.  Useful for web and gui interfaces, and slow to
 
329
  compute one file at a time.
 
330
 
 
331
* unittest is standard, but the results are kind of ugly; would be
 
332
  nice to make it cleaner.
 
333
 
 
334
* Check locking is correct during merge-related operations.
 
335
 
 
336
* Perhaps attempts to get locks should timeout after some period of
 
337
  time, or at least display a progress message.
 
338
 
 
339
* Split out upgrade functionality from check command into a separate
 
340
  ``bzr upgrade``.
 
341
 
 
342
* Don't pass around command classes but rather pass objects.  This'd
 
343
  make it cleaner to construct objects wrapping external commands.
 
344
 
 
345
* Track all merged-in revisions in a versioned add-only metafile.
 
346
 
237
347
 
238
348
Large things
239
349
------------
269
379
  files, and respecting selective commits.  Run the pre-commit check
270
380
  (e.g. compile and run test suite) in there.
271
381
 
 
382
  Possibly this should be done by splitting the commit function into
 
383
  several parts (under a single interface).  It is already rather
 
384
  large.  Decomposition:
 
385
 
 
386
   - find tree modifications and prepare in-memory inventory
 
387
 
 
388
   - export that inventory to a temporary directory
 
389
 
 
390
   - run the test in that temporary directory
 
391
 
 
392
   - if that succeeded, continue to actually finish the commit
 
393
 
 
394
  What should be done with the text of modified files while this is
 
395
  underway?  I don't think we want to count on holding them in memory
 
396
  and we can't trust the working files to stay in one place so I
 
397
  suppose we need to move them into the text store, or otherwise into
 
398
  a temporary directory.
 
399
 
 
400
  If the commit does not actually complete, we would rather the
 
401
  content was not left behind in the stores.
 
402
 
272
403
* Web interface
273
404
 
274
405
* GUI (maybe in Python GTK+?)