~bzr-pqm/bzr/bzr.dev

932 by Martin Pool
- more diff TODOs
1
.. -*- mode: indented-text; compile-command: "make -C doc" -*-
321 by Martin Pool
doc: revfile storage and related things
2
3
4
*******************
5
Things to do in bzr
6
*******************
7
287 by Martin Pool
- todo: plugins
8
293 by Martin Pool
- todos
9
See also various low-level TODOs in the source code.  Try looking in
284 by Martin Pool
- more TODO items
10
the list archive or on gmane.org for previous discussion of these
293 by Martin Pool
- todos
11
issues.
12
13
These are classified by approximate size: an hour or less, a day or
14
less, and several days or more.
15
282 by Martin Pool
- move all TODO items into ./TODO
16
17
Small things
18
------------
19
974.1.86 by Aaron Bentley
Added false 'module does not exist' messages to TODO
20
* Fix tests so that import errors caused by modules don't produce false reports
21
  that the tests themselves don't exist.
22
974.1.92 by Aaron Bentley
TODO re tests
23
* Fix tests so that one test failure doesn't prevent other tests from running
24
1171 by Martin Pool
- typo fixes from kfish
25
* print a message at the end of running the tests telling them that the
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
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
975 by Martin Pool
- more checks for some operations in subdirectories
30
852 by Martin Pool
todo
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
932 by Martin Pool
- more diff TODOs
33
  aborts.
852 by Martin Pool
todo
34
850 by Martin Pool
- Merge merge updates from aaron
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
282 by Martin Pool
- move all TODO items into ./TODO
39
* Add of a file that was present in the base revision should put back
40
  the previous file-id.
41
914 by Martin Pool
- fix up breakage of 'bzr log -v' by root_id patch
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
282 by Martin Pool
- move all TODO items into ./TODO
46
* Handle diff of files which do not have a trailing newline; probably
47
  requires patching difflib to get it exactly right, or otherwise
48
  calling out to GNU diff.
49
902 by Martin Pool
todo
50
* Should be able to copy files between branches to preserve their
51
  file-id (and perhaps eventually parentage.)
52
289 by Martin Pool
todo
53
* -r option should take a revision-id as well as a revno.
54
322 by Martin Pool
- update todo list
55
* ``bzr info`` should count only people with distinct email addresses as
290 by Martin Pool
todo
56
  different committers.  (Or perhaps only distinct userids?)
57
322 by Martin Pool
- update todo list
58
* On Windows, command-line arguments should be `glob-expanded`__,
293 by Martin Pool
- todos
59
  because the shell doesn't do this.  However, there are probably some
60
  commands where this shouldn't be done, such as 'bzr ignore', because
61
  we want to accept globs.
62
329 by Martin Pool
- refactor command functions into command classes
63
* ``bzr ignore`` command that just adds a line to the ``.bzrignore`` file
64
  and makes it versioned.  Fix this to break symlinks.
295 by Martin Pool
todo
65
312 by Martin Pool
todo
66
* Any useful sanity checks in 'bzr ignore'?  Perhaps give a warning if
67
  they try to add a single file which is already versioned, or if they
68
  add a pattern which already exists, or if it looks like they gave an
69
  unquoted glob.
310 by Martin Pool
- new 'bzr ignored' command!
70
325 by Martin Pool
- more revfile design notes
71
__ http://mail.python.org/pipermail/python-list/2001-April/037847.html
72
327 by Martin Pool
todo
73
* Separate read and write version checks?
325 by Martin Pool
- more revfile design notes
74
405 by Martin Pool
todo
75
* ``bzr status DIR`` should give status on all files under that
76
  directory.
77
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
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)
484 by Martin Pool
todo
81
329 by Martin Pool
- refactor command functions into command classes
82
* ``bzr inventory -r REV`` and perhaps unify this with ``bzr ls``,
83
  giving options to display ids, types, etc.
84
414 by Martin Pool
todo
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
586 by Martin Pool
todo
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
487 by Martin Pool
todo
94
* Maybe also store directories in the statcache so that we can quickly
95
  identify that they still exist.
96
570 by Martin Pool
doc
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
593 by Martin Pool
todo
101
* Perhaps split command infrastructure from the actual command
102
  definitions.
103
104
* Cleaner support for negative boolean options like --no-recurse.
105
603 by Martin Pool
doc
106
* Statcache should possibly map all file paths to / separators
107
642 by Martin Pool
- notes on patches for Windows
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,
932 by Martin Pool
- more diff TODOs
115
  otherwise Unix patch can't apply them. (?)
642 by Martin Pool
- notes on patches for Windows
116
665 by Martin Pool
todo
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
932 by Martin Pool
- more diff TODOs
120
  inefficient.
665 by Martin Pool
todo
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.
691 by Martin Pool
todo
129
818 by Martin Pool
- Clear pending-merge list when committing.
130
* Guard against repeatedly merging any particular patch.
932 by Martin Pool
- more diff TODOs
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
967 by Martin Pool
todo
150
* Reproducible performance benchmark to measure whether performance is 
151
  getting better or worse.
665 by Martin Pool
todo
152
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
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
1092.1.27 by Robert Collins
two bugfixes to smart_add - do not add paths from nested trees to the parent tree, and do not mutate the user supplied file list
185
* BZRDIR should be in branch.py not __init__.py.
414 by Martin Pool
todo
186
282 by Martin Pool
- move all TODO items into ./TODO
187
Medium things
188
-------------
189
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
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.
282 by Martin Pool
- move all TODO items into ./TODO
197
478 by Martin Pool
- put back support for running diff or status on
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.
282 by Martin Pool
- move all TODO items into ./TODO
201
202
* Fix up Inventory objects to represent root object as an entry.
203
552 by Martin Pool
- update todo list
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.
282 by Martin Pool
- move all TODO items into ./TODO
207
208
* Extract changes from one revision to the next to a text form
209
  suitable for transmission over email.
210
211
* More test cases.
212
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
213
  - ``missing`` command
214
491 by Martin Pool
- Selective commit!
215
  - Selected-file commit
216
217
  - Impossible selected-file commit: adding things in non-versioned
218
    directories, crossing renames, etc.
219
282 by Martin Pool
- move all TODO items into ./TODO
220
* Write a reproducible benchmark, perhaps importing various kernel versions.
221
222
* Directly import diffs!  It seems a bit redundant to need to rescan
223
  the directory to work out what files diff added/deleted/changed when
224
  all the information is there in the diff in the first place.
225
  Getting the exact behaviour for added/deleted subdirectories etc
226
  might be hard.
227
228
  At the very least we could run diffstat over the diff, or perhaps
229
  read the status output from patch.  Just knowing which files might
230
  be modified would be enough to guide the add and commit.
932 by Martin Pool
- more diff TODOs
231
282 by Martin Pool
- move all TODO items into ./TODO
232
  Given this we might be able to import patches at 1/second or better.
233
234
* revfile compression.
235
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
236
* Split inventory into per-directory files?
282 by Martin Pool
- move all TODO items into ./TODO
237
284 by Martin Pool
- more TODO items
238
* Fix ignore file parsing:
239
240
  - fnmatch is not the same as unix patterns
241
242
  - perhaps add extended globs from rsh/rsync
243
244
  - perhaps a pattern that matches only directories or non-directories
245
312 by Martin Pool
todo
246
* Consider using Python logging library as well as/instead of
247
  bzrlib.trace.
248
334 by Martin Pool
doc
249
* Commands should give some progress indication by default.
250
251
  - But quieten this with ``--silent``.
252
312 by Martin Pool
todo
253
* Change to using gettext message localization.
282 by Martin Pool
- move all TODO items into ./TODO
254
315 by Martin Pool
todo
255
* Make a clearer separation between internal and external bzrlib
256
  interfaces.  Make internal interfaces use protected names.  Write at
257
  least some documentation for those APIs, probably as docstrings.
258
259
  Consider using ZopeInterface definitions for the external interface;
260
  I think these are already used in PyBaz.  They allow automatic
261
  checking of the interface but may be unfamiliar to general Python
321 by Martin Pool
doc: revfile storage and related things
262
  developers, so I'm not really keen.
315 by Martin Pool
todo
263
264
* Commands to dump out all command help into a manpage or HTML file or
265
  whatever.
266
326 by Martin Pool
todo
267
* Handle symlinks in the working directory; at the very least it
268
  should be possible for them to be present and ignored/unknown
932 by Martin Pool
- more diff TODOs
269
  without causing assertion failures.
326 by Martin Pool
todo
270
271
  Eventually symlinks should be versioned.
272
329 by Martin Pool
- refactor command functions into command classes
273
* Allow init in a subdirectory to create a nested repository, but only
274
  if the subdirectory is not already versioned.   Perhaps also require
275
  a ``--nested`` to protect against confusion.
276
932 by Martin Pool
- more diff TODOs
277
* Branch names?
329 by Martin Pool
- refactor command functions into command classes
278
339 by Martin Pool
many more diffs
279
* More test framework:
280
281
  - Class that describes the state of a working tree so we can just
282
    assert it's equal.
283
361 by Martin Pool
todo
284
* Try using XSLT to add some formatting to REST-generated HTML.  Or
285
  maybe write a small Python program that specifies a header and foot
286
  for the pages and calls into the docutils libraries.
287
366 by Martin Pool
todo
288
* --format=xml for log, status and other commands.
329 by Martin Pool
- refactor command functions into command classes
289
370 by Martin Pool
todo
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.
329 by Martin Pool
- refactor command functions into command classes
294
377 by Martin Pool
- todo notes on inventory
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
1185.34.1 by Jelmer Vernooij
Fix a couple of typo's
305
    time it is read in.  Probably still expose it through some kind of
377 by Martin Pool
- todo notes on inventory
306
    object interface though, but perhaps that should just be a proxy
307
    for the elements.
308
932 by Martin Pool
- more diff TODOs
309
  - Less special cases for the root directory.
377 by Martin Pool
- todo notes on inventory
310
388 by Martin Pool
doc
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
442 by Martin Pool
todo
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
1185.34.1 by Jelmer Vernooij
Fix a couple of typo's
317
  optimization of stating them in inode order.
442 by Martin Pool
todo
318
451 by Martin Pool
todo
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
932 by Martin Pool
- more diff TODOs
321
  in a particular revision, etc.
451 by Martin Pool
todo
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
459 by Martin Pool
- diff now uses stat-cache -- much faster
326
* Paranoid mode where we never trust SHA-1 matches.
327
522 by Martin Pool
todo
328
* --dry-run mode for commit?  (Or maybe just run with
329
  check-command=false?)
502 by Martin Pool
todo
330
331
* Generally, be a bit more verbose unless --silent is specified.
332
522 by Martin Pool
todo
333
* Function that finds all changes to files under a given directory;
334
  perhaps log should use this if a directory is given.
335
548 by Martin Pool
- Write statcache using \u style encoding to avoid
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
579 by Martin Pool
todo
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
604 by Martin Pool
doc
343
* Function to list a directory, saying in which revision each file was
1185.34.1 by Jelmer Vernooij
Fix a couple of typo's
344
  last modified.  Useful for web and GUI interfaces, and slow to
604 by Martin Pool
doc
345
  compute one file at a time.
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
346
  
347
  This will be done when we track file texts by referring to the
348
  version that created them. 
609 by Martin Pool
- cleanup test code
349
627 by Martin Pool
todo
350
* Check locking is correct during merge-related operations.
351
629 by Martin Pool
todo
352
* Perhaps attempts to get locks should timeout after some period of
353
  time, or at least display a progress message.
354
738 by Martin Pool
- default plugin dir is ~/.bzr.conf/plugins
355
* Don't pass around command classes but rather pass objects.  This'd
356
  make it cleaner to construct objects wrapping external commands.
357
818 by Martin Pool
- Clear pending-merge list when committing.
358
* Track all merged-in revisions in a versioned add-only metafile.
359
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
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
315 by Martin Pool
todo
380
282 by Martin Pool
- move all TODO items into ./TODO
381
Large things
382
------------
383
321 by Martin Pool
doc: revfile storage and related things
384
* Generate annotations from current file relative to previous
385
  annotations.
386
387
  - Is it necessary to store any kind of annotation where data was
388
    deleted?
389
325 by Martin Pool
- more revfile design notes
390
* Update revfile_ format and make it active:
321 by Martin Pool
doc: revfile storage and related things
391
392
  - Texts should be identified by something keyed on the revision, not
393
    an individual text-id.  This is much more useful for annotate I
394
    think; we want to map back to the revision that last changed it.
395
396
  - Access revfile revisions through the Tree/Store classes.
397
398
  - Check them from check commands.
399
400
  - Store annotations.
401
325 by Martin Pool
- more revfile design notes
402
.. _revfile: revfile.html
403
294 by Martin Pool
todo
404
* Hooks for pre-commit, post-commit, etc.
405
406
  Consider the security implications; probably should not enable hooks
407
  for remotely-fetched branches by default.
408
409
* Pre-commit check.  If this hook is defined, it needs to be handled
410
  specially: create a temporary directory containing the tree as it
411
  will be after the commit.  This means excluding any ignored/unknown
412
  files, and respecting selective commits.  Run the pre-commit check
413
  (e.g. compile and run test suite) in there.
414
519 by Martin Pool
- todo: discussion of pre-commit tests
415
  Possibly this should be done by splitting the commit function into
416
  several parts (under a single interface).  It is already rather
417
  large.  Decomposition:
418
419
   - find tree modifications and prepare in-memory inventory
420
421
   - export that inventory to a temporary directory
422
423
   - run the test in that temporary directory
424
425
   - if that succeeded, continue to actually finish the commit
426
427
  What should be done with the text of modified files while this is
428
  underway?  I don't think we want to count on holding them in memory
429
  and we can't trust the working files to stay in one place so I
430
  suppose we need to move them into the text store, or otherwise into
431
  a temporary directory.
432
433
  If the commit does not actually complete, we would rather the
932 by Martin Pool
- more diff TODOs
434
  content was not left behind in the stores.
519 by Martin Pool
- todo: discussion of pre-commit tests
435
282 by Martin Pool
- move all TODO items into ./TODO
436
* Web interface
437
438
* GUI (maybe in Python GTK+?)
439
284 by Martin Pool
- more TODO items
440
* C library interface
321 by Martin Pool
doc: revfile storage and related things
441
442
* Expansion of $Id$ keywords within working files.  Perhaps do this in
443
  exports first as a simpler case because then we don't need to deal
444
  with removing the tags on the way back in.
445
329 by Martin Pool
- refactor command functions into command classes
446
* ``bzr find``