~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Martin Pool
  • Date: 2007-04-04 01:22:11 UTC
  • mfrom: (2393.1.1 bzr.docs)
  • mto: This revision was merged to the branch mainline in revision 2397.
  • Revision ID: mbp@sourcefrog.net-20070404012211-sq269me6bai9m6xk
merge trunk and doc fix from elliot

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.. -*- mode: indented-text; compile-command: "make -C doc" -*-
2
 
 
3
 
 
4
 
*******************
5
 
Things to do in bzr
6
 
*******************
7
 
 
8
 
 
9
 
See also various low-level TODOs in the source code.  Try looking in
10
 
the list archive or on gmane.org for previous discussion of these
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
 
 
16
 
 
17
 
Small things
18
 
------------
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
 
 
28
 
* Add of a file that was present in the base revision should put back
29
 
  the previous file-id.
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
 
 
35
 
* Handle diff of files which do not have a trailing newline; probably
36
 
  requires patching difflib to get it exactly right, or otherwise
37
 
  calling out to GNU diff.
38
 
 
39
 
* Should be able to copy files between branches to preserve their
40
 
  file-id (and perhaps eventually parentage.)
41
 
 
42
 
* -r option should take a revision-id as well as a revno.
43
 
 
44
 
* allow ``bzr st -r 300`` to show a summary of changes since then.
45
 
 
46
 
* ``bzr info`` should count only people with distinct email addresses as
47
 
  different committers.  (Or perhaps only distinct userids?)
48
 
 
49
 
* On Windows, command-line arguments should be `glob-expanded`__,
50
 
  because the shell doesn't do this.  However, there are probably some
51
 
  commands where this shouldn't be done, such as 'bzr ignore', because
52
 
  we want to accept globs.
53
 
 
54
 
* ``bzr ignore`` command that just adds a line to the ``.bzrignore`` file
55
 
  and makes it versioned.  Fix this to break symlinks.
56
 
 
57
 
* Any useful sanity checks in 'bzr ignore'?  Perhaps give a warning if
58
 
  they try to add a single file which is already versioned, or if they
59
 
  add a pattern which already exists, or if it looks like they gave an
60
 
  unquoted glob.
61
 
 
62
 
__ http://mail.python.org/pipermail/python-list/2001-April/037847.html
63
 
 
64
 
* Separate read and write version checks?
65
 
 
66
 
* ``bzr status DIR`` should give status on all files under that
67
 
  directory.
68
 
 
69
 
* ``bzr log DIR`` should give changes to any files within DIR.
70
 
 
71
 
* ``bzr inventory -r REV`` and perhaps unify this with ``bzr ls``,
72
 
  giving options to display ids, types, etc.
73
 
 
74
 
* Split BzrError into various more specific subclasses for different
75
 
  errors people might want to catch.
76
 
 
77
 
* If the export destination ends in '.tar', '.tar.gz', etc then create
78
 
  a tarball instead of a directory.  (Need to actually make a
79
 
  temporary directory and then tar that up.)
80
 
 
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
1
* quotefn doubles all backslashes on Windows; this is probably not the
107
2
  best thing to do.  What would be a better way to safely represent
108
3
  filenames?  Perhaps we could doublequote things containing spaces,
109
4
  on the principle that filenames containing quotes are unlikely?
110
5
  Nice for humans; less good for machine parsing.
111
6
 
112
 
* Patches should probably use only forward slashes, even on Windows,
113
 
  otherwise Unix patch can't apply them. (?)
114
 
 
115
7
* Branch.update_revisions() inefficiently fetches revisions from the
116
8
  remote server twice; once to find out what text and inventory they
117
9
  need and then again to actually get the thing.  This is a bit
125
17
  methods return object, but what we really want is the raw XML, which
126
18
  can be popped into our own store.  That needs to be refactored.
127
19
 
128
 
* ``bzr status FOO`` where foo is ignored should say so.
129
 
 
130
 
* ``bzr mkdir A...`` should just create and add A.
131
 
 
132
20
* Guard against repeatedly merging any particular patch.
133
21
 
134
22
* More options for diff:
149
37
 
150
38
  - and, of course, tests for all this
151
39
 
152
 
* stat-cache update is too slow for some reason - why is Python making
153
 
  a lot of futex calls?
154
 
  
155
 
* ``bzr add`` with no arguments should probably be the same as ``bzr add .``
156
 
 
157
 
 
 
40
* Reproducible performance benchmark to measure whether performance is 
 
41
  getting better or worse.
 
42
 
 
43
* ``bzr log -m foo`` should perhaps error if nothing matches?
 
44
 
 
45
* ``bzr diff -r 30 -r 40 foo.c`` or ``bzr diff -r30..40 foo.c``
 
46
 
 
47
  If diffing between two branches then we probably want two -r
 
48
  options, since the revisions don't form a range that can be
 
49
  evaluated on either one.
 
50
 
 
51
* bzr diff shouldn't diff binary files
 
52
 
 
53
* setup.py install when run from a bzr tree should freeze the tree
 
54
  revision-id into the installed bzr.
 
55
 
 
56
* bzr script should trap ImportError and perhaps give a better error
 
57
  message?
 
58
 
 
59
* revert after a merge should possibly remove all the BASE/THIS/OTHER
 
60
  files to get you back to where you were.
 
61
 
 
62
* files that are added and then deleted are still reported as added
 
63
 
 
64
* stores should raise KeyError, not IndexError
 
65
 
 
66
* merging from a remote branch seems to sometimes raise errors not
 
67
  present locally
 
68
 
 
69
* should be possible to give a related branch when pulling from a
 
70
  remote branch to make things faster
 
71
 
 
72
* sometimes gives "conflicting add" even when the contents are in fact
 
73
  the same???
 
74
 
 
75
* BZRDIR should be in branch.py not __init__.py.
 
76
 
 
77
* bzrlib.delta.compare_trees() shouldn't need to sort all of the result
 
78
  lists, since they are being added in alphabetical order. Write tests
 
79
  to guarantee this, and remove the sort() calls.
158
80
 
159
81
Medium things
160
82
-------------
161
83
 
162
 
* Merge revert patch.
163
 
 
164
 
* ``bzr mv`` that does either rename or move as in Unix.
 
84
* merge should add all revision and inventory XML to the local store.
 
85
 
 
86
* check should give a warning for revisions that are named in the
 
87
  chain but not actually present in the store.
 
88
 
 
89
* remove anything outside of the branch implementation that directly
 
90
  accesses the stores.
165
91
 
166
92
* More efficient diff of only selected files.  We should be able to
167
93
  just get the id for the selected files, look up their location and
168
94
  diff just those files.  No need to traverse the entire inventories.
169
95
 
170
 
* ``bzr status DIR`` or ``bzr diff DIR`` should report on all changes
171
 
  under that directory.
172
 
 
173
96
* Fix up Inventory objects to represent root object as an entry.
174
97
 
175
98
* Don't convert entire entry from ElementTree to an object when it is
181
104
 
182
105
* More test cases.
183
106
 
 
107
  - ``missing`` command
 
108
 
184
109
  - Selected-file commit
185
110
 
186
111
  - Impossible selected-file commit: adding things in non-versioned
200
125
 
201
126
  Given this we might be able to import patches at 1/second or better.
202
127
 
203
 
* Get branch over http.
204
 
 
205
 
* Pull pure updates over http.
206
 
 
207
128
* revfile compression.
208
129
 
209
 
* Split inventory into per-directory files.
 
130
* Split inventory into per-directory files?
210
131
 
211
132
* Fix ignore file parsing:
212
133
 
254
175
  - Class that describes the state of a working tree so we can just
255
176
    assert it's equal.
256
177
 
257
 
* There are too many methods on Branch() that really manipulate the
258
 
  WorkingTree.  They should be moved across.
259
 
 
260
 
  Also there are some methods which are duplicated on Tree and
261
 
  Inventory objects, and it should be made more clear which ones are
262
 
  proxies and which ones behave differently, and how.
263
 
 
264
178
* Try using XSLT to add some formatting to REST-generated HTML.  Or
265
179
  maybe write a small Python program that specifies a header and foot
266
180
  for the pages and calls into the docutils libraries.
282
196
 
283
197
  - Hold the ElementTree in memory in the Inventory object and work
284
198
    directly on that, rather than converting into Python objects every
285
 
    time it is read in.  Probably still exposoe it through some kind of
 
199
    time it is read in.  Probably still expose it through some kind of
286
200
    object interface though, but perhaps that should just be a proxy
287
201
    for the elements.
288
202
 
294
208
 
295
209
* stat cache should perhaps only stat files as necessary, rather than
296
210
  doing them all up-front.  On the other hand, that disallows the
297
 
  opimization of stating them in inode order.
 
211
  optimization of stating them in inode order.
298
212
 
299
213
* It'd be nice to pipeline multiple HTTP requests.  Often we can
300
214
  predict what will be wanted in future: all revisions, or all texts
305
219
 
306
220
* Paranoid mode where we never trust SHA-1 matches.
307
221
 
308
 
* Don't commit if there are no changes unless forced.
309
 
 
310
222
* --dry-run mode for commit?  (Or maybe just run with
311
223
  check-command=false?)
312
224
 
318
230
* XML attributes might have trouble with filenames containing \n and
319
231
  \r.  Do we really want to support this?  I think perhaps not.
320
232
 
321
 
* Remember execute bits, so that exports will work OK.
322
 
 
323
233
* Unify smart_add and plain Branch.add(); perhaps smart_add should
324
234
  just build a list of files to add and pass that to the regular add
325
235
  function.
326
236
 
327
237
* Function to list a directory, saying in which revision each file was
328
 
  last modified.  Useful for web and gui interfaces, and slow to
 
238
  last modified.  Useful for web and GUI interfaces, and slow to
329
239
  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.
 
240
  
 
241
  This will be done when we track file texts by referring to the
 
242
  version that created them. 
333
243
 
334
244
* Check locking is correct during merge-related operations.
335
245
 
336
246
* Perhaps attempts to get locks should timeout after some period of
337
247
  time, or at least display a progress message.
338
248
 
339
 
* Split out upgrade functionality from check command into a separate
340
 
  ``bzr upgrade``.
341
 
 
342
249
* Don't pass around command classes but rather pass objects.  This'd
343
250
  make it cleaner to construct objects wrapping external commands.
344
251
 
345
252
* Track all merged-in revisions in a versioned add-only metafile.
346
253
 
 
254
* ``uncommit`` command that removes a revision from the end of the
 
255
  revision-history; just doing this is enough to remove the commit,
 
256
  and a new commit will automatically be made against the
 
257
  predecessor.  This can be repeated.
 
258
 
 
259
  It only makes sense to delete from the tail of history.
 
260
 
 
261
  This has been implemented, but it does not remove the texts from
 
262
  the store.
 
263
 
 
264
* ``bzrlib.lazy_import.lazy_import`` could check to see if a given
 
265
  module has already been imported (look at ``sys.modules``). If it
 
266
  has, then just import it directly, rather than creating a lazy
 
267
  object.
 
268
 
347
269
 
348
270
Large things
349
271
------------
411
333
  with removing the tags on the way back in.
412
334
 
413
335
* ``bzr find``
 
336
 
 
337
Selftest
 
338
--------
 
339
 
 
340
* Write some benchmark tests
 
341
 
 
342
* we could display the ids of some tests selected by time to rune, or cputime,
 
343
  rusage. 
 
344
 
 
345
* We could run tests multiple times and report deviation/slowest/fastest.
 
346
 
 
347
* Gather lsprofile output for each test individually - log that somewhere.
 
348
 
 
349
* Should plugins be able to offer benchmark tests ?
 
350
 
 
351
CHANGESETS
 
352
----------
 
353
Ensure changeset command behaves properly w/revisions (e.g. 0)
 
354
Figure out whether testament-related bug is my problem
 
355
Get rid of the 'old' directory
 
356
Bundle signatures
 
357
What to do about ghost ancestors in remote branch that are present locally?