~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Martin Pool
  • Date: 2005-05-17 06:56:16 UTC
  • Revision ID: mbp@sourcefrog.net-20050517065616-6f23381d6184a8aa
- add space for un-merged patches

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
* 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)
52
38
 
53
39
* -r option should take a revision-id as well as a revno.
54
40
 
 
41
* ``bzr info`` could show space used by working tree, versioned files,
 
42
  unknown and ignored files. 
 
43
 
55
44
* ``bzr info`` should count only people with distinct email addresses as
56
45
  different committers.  (Or perhaps only distinct userids?)
57
46
 
75
64
* ``bzr status DIR`` should give status on all files under that
76
65
  directory.
77
66
 
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)
 
67
* ``bzr log DIR`` should give changes to any files within DIR.
 
68
 
 
69
* Check all commands have decent help.
81
70
 
82
71
* ``bzr inventory -r REV`` and perhaps unify this with ``bzr ls``,
83
72
  giving options to display ids, types, etc.
84
73
 
 
74
* Atomic file class that renames into place when it's closed.
 
75
 
 
76
* Don't abort if ``~/.bzr.log`` can't be used.
 
77
 
 
78
* Split BzrError into various more specific subclasses for different
 
79
  errors people might want to catch.
 
80
 
 
81
* If the export destination ends in '.tar', '.tar.gz', etc then create
 
82
  a tarball instead of a directory.  (Need to actually make a
 
83
  temporary directory and then tar that up.)
 
84
 
 
85
  http://www.gelato.unsw.edu.au/archives/git/0504/2194.html
 
86
  
85
87
* RemoteBranch could maintain a cache either in memory or on disk.  We
86
88
  know more than an external cache might about which files are
87
89
  immutable and which can vary.  On the other hand, it's much simpler
88
90
  to just use an external proxy cache.
89
91
 
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
92
* Maybe also store directories in the statcache so that we can quickly
95
93
  identify that they still exist.
96
94
 
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.
186
95
 
187
96
Medium things
188
97
-------------
189
98
 
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.
 
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
* Merge Aaron's merge code.
 
105
 
 
106
* Merge revert patch.
 
107
 
 
108
* ``bzr mv`` that does either rename or move as in Unix.
197
109
 
198
110
* More efficient diff of only selected files.  We should be able to
199
111
  just get the id for the selected files, look up their location and
200
112
  diff just those files.  No need to traverse the entire inventories.
201
113
 
 
114
* ``bzr status DIR`` or ``bzr diff DIR`` should report on all changes
 
115
  under that directory.
 
116
 
202
117
* Fix up Inventory objects to represent root object as an entry.
203
118
 
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.
 
119
* Don't convert entire entry from 
207
120
 
208
121
* Extract changes from one revision to the next to a text form
209
122
  suitable for transmission over email.
210
123
 
211
124
* More test cases.
212
125
 
213
 
  - ``missing`` command
214
 
 
215
126
  - Selected-file commit
216
127
 
217
128
  - Impossible selected-file commit: adding things in non-versioned
219
130
 
220
131
* Write a reproducible benchmark, perhaps importing various kernel versions.
221
132
 
 
133
* Change test.sh from Bourne shell into something in pure Python so
 
134
  that it can be more portable.
 
135
 
222
136
* Directly import diffs!  It seems a bit redundant to need to rescan
223
137
  the directory to work out what files diff added/deleted/changed when
224
138
  all the information is there in the diff in the first place.
228
142
  At the very least we could run diffstat over the diff, or perhaps
229
143
  read the status output from patch.  Just knowing which files might
230
144
  be modified would be enough to guide the add and commit.
231
 
 
 
145
  
232
146
  Given this we might be able to import patches at 1/second or better.
233
147
 
 
148
* Get branch over http.
 
149
 
 
150
* Pull pure updates over http.
 
151
 
234
152
* revfile compression.
235
153
 
236
 
* Split inventory into per-directory files?
 
154
* Split inventory into per-directory files.
237
155
 
238
156
* Fix ignore file parsing:
239
157
 
266
184
 
267
185
* Handle symlinks in the working directory; at the very least it
268
186
  should be possible for them to be present and ignored/unknown
269
 
  without causing assertion failures.
 
187
  without causing assertion failures. 
270
188
 
271
189
  Eventually symlinks should be versioned.
272
190
 
274
192
  if the subdirectory is not already versioned.   Perhaps also require
275
193
  a ``--nested`` to protect against confusion.
276
194
 
277
 
* Branch names?
 
195
* Branch names? 
278
196
 
279
197
* More test framework:
280
198
 
281
199
  - Class that describes the state of a working tree so we can just
282
200
    assert it's equal.
283
201
 
 
202
* There are too many methods on Branch() that really manipulate the
 
203
  WorkingTree.  They should be moved across.  
 
204
 
 
205
  Also there are some methods which are duplicated on Tree and
 
206
  Inventory objects, and it should be made more clear which ones are
 
207
  proxies and which ones behave differently, and how.
 
208
 
284
209
* Try using XSLT to add some formatting to REST-generated HTML.  Or
285
210
  maybe write a small Python program that specifies a header and foot
286
211
  for the pages and calls into the docutils libraries.
302
227
 
303
228
  - Hold the ElementTree in memory in the Inventory object and work
304
229
    directly on that, rather than converting into Python objects every
305
 
    time it is read in.  Probably still expose it through some kind of
 
230
    time it is read in.  Probably still exposoe it through some kind of
306
231
    object interface though, but perhaps that should just be a proxy
307
232
    for the elements.
308
233
 
309
 
  - Less special cases for the root directory.
 
234
  - Less special cases for the root directory. 
310
235
 
311
236
* Perhaps inventories should remember the revision in which each file
312
237
  was last changed, as well as its current state?  This is a bit
314
239
 
315
240
* stat cache should perhaps only stat files as necessary, rather than
316
241
  doing them all up-front.  On the other hand, that disallows the
317
 
  optimization of stating them in inode order.
 
242
  opimization of stating them in inode order.
318
243
 
319
244
* It'd be nice to pipeline multiple HTTP requests.  Often we can
320
245
  predict what will be wanted in future: all revisions, or all texts
321
 
  in a particular revision, etc.
 
246
  in a particular revision, etc.  
322
247
 
323
248
  urlgrabber's docs say they are working on batched downloads; we
324
249
  could perhaps ride on that or just create a background thread (ew).
325
250
 
 
251
* Should be a signature at the top of the cache file.
 
252
 
326
253
* Paranoid mode where we never trust SHA-1 matches.
327
254
 
328
 
* --dry-run mode for commit?  (Or maybe just run with
329
 
  check-command=false?)
 
255
* Don't commit if there are no changes unless forced.
 
256
 
 
257
* --dry-run mode for commit?  
330
258
 
331
259
* Generally, be a bit more verbose unless --silent is specified.
332
260
 
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, not from the
366
 
  end.
367
 
 
368
 
  The revision, its inventory and texts remain floating in the store.
369
 
  We should perhaps add the revision to a list of removed-commits, so
370
 
  that it can be restored or at least accounted for when checking
371
 
  consistency.  This file would not be versioned, and probably should
372
 
  not propagate when branched.
373
 
 
374
 
  If we track merged revisions then we need to update this list too.
375
 
  If the list is stored in a weave it's easy (implicit): the version
376
 
  of the list can remain but it won't be referenced anymore.  It's
377
 
  probably best to just store this list in a weave in the first place
378
 
  and be done.
379
 
 
380
261
 
381
262
Large things
382
263
------------
431
312
  a temporary directory.
432
313
 
433
314
  If the commit does not actually complete, we would rather the
434
 
  content was not left behind in the stores.
 
315
  content was not left behind in the stores.  
435
316
 
436
317
* Web interface
437
318