~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Martin Pool
  • Date: 2005-05-10 07:06:05 UTC
  • Revision ID: mbp@sourcefrog.net-20050510070605-0a2453ae5db6fc3c
- new command 'bzr added'

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