~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Robert Collins
  • Date: 2005-12-24 02:20:45 UTC
  • mto: (1185.50.57 bzr-jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1550.
  • Revision ID: robertc@robertcollins.net-20051224022045-14efc8dfa0e1a4e9
Start tests for api usage.

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
 
20
39
* Add of a file that was present in the base revision should put back
21
40
  the previous file-id.
22
41
 
 
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
 
23
46
* Handle diff of files which do not have a trailing newline; probably
24
47
  requires patching difflib to get it exactly right, or otherwise
25
48
  calling out to GNU diff.
26
49
 
27
 
* Import ElementTree update patch.
28
 
 
29
 
* Syntax should be ``bzr export -r REV``.
30
 
 
31
 
* Plugins that provide commands.  By just installing a file into some
32
 
  directory (e.g. ``/usr/share/bzr/plugins``) it should be possible to
33
 
  create new top-level commands (``bzr frob``).  Extensions can be
34
 
  written in either Python (in which case they use the bzrlib API) or
35
 
  in a separate process (in sh, C, whatever).   It should be possible
36
 
  to get help for plugin commands.
37
 
 
38
 
* Smart rewrap text in help messages to fit in $COLUMNS (or equivalent
39
 
  on Windows)
 
50
* Should be able to copy files between branches to preserve their
 
51
  file-id (and perhaps eventually parentage.)
40
52
 
41
53
* -r option should take a revision-id as well as a revno.
42
54
 
43
 
* ``bzr info`` could show space used by working tree, versioned files,
44
 
  unknown and ignored files. 
45
 
 
46
55
* ``bzr info`` should count only people with distinct email addresses as
47
56
  different committers.  (Or perhaps only distinct userids?)
48
57
 
54
63
* ``bzr ignore`` command that just adds a line to the ``.bzrignore`` file
55
64
  and makes it versioned.  Fix this to break symlinks.
56
65
 
57
 
* ``bzr help commands`` should give a one-line summary of each command.
58
 
 
59
66
* Any useful sanity checks in 'bzr ignore'?  Perhaps give a warning if
60
67
  they try to add a single file which is already versioned, or if they
61
68
  add a pattern which already exists, or if it looks like they gave an
63
70
 
64
71
__ http://mail.python.org/pipermail/python-list/2001-April/037847.html
65
72
 
66
 
* Read and write locks on branch while it's open.
67
 
 
68
73
* Separate read and write version checks?
69
74
 
70
 
* ``bzr status FILE...``
71
 
 
72
 
* Check all commands have decent help.
73
 
 
74
 
* Autogenerate argument/option help.
 
75
* ``bzr status DIR`` should give status on all files under that
 
76
  directory.
 
77
 
 
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)
75
81
 
76
82
* ``bzr inventory -r REV`` and perhaps unify this with ``bzr ls``,
77
83
  giving options to display ids, types, etc.
78
84
 
79
 
* Atomic file class that renames into place when it's closed.
80
 
 
81
 
* Don't abort if ``~/.bzr.log`` can't be used.
82
 
 
83
 
* Split BzrError into various more specific subclasses for different
84
 
  errors people might want to catch.
 
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
 
 
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
* 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.
85
186
 
86
187
Medium things
87
188
-------------
88
189
 
89
 
* Display command grammar in help messages rather than hardcoding it.
90
 
 
91
 
* Change command functions into Command() objects, like in hct, and
92
 
  then the grammar can be described directly in there.  Since all
93
 
  option definitions are global we can define them just once and
94
 
  reference them from each command.
95
 
 
96
 
* Selective commit of only some files.
97
 
 
98
 
* Faster diff/status.  
99
 
 
100
 
  Status should be handled differently because it needs to report on
101
 
  deleted and unknown files.  diff only needs to deal with versioned
102
 
  files.
103
 
 
104
 
* Merge Aaron's merge code.
105
 
 
106
 
* Merge revert patch.
107
 
 
108
 
* Turn on stat cache code, and add optimization about avoiding
109
 
  dangerous cache entries.
110
 
 
111
 
* ``bzr mv`` that does either rename or move as in Unix.
112
 
 
113
 
* More efficient diff of only selected files.
 
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.
 
197
 
 
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.
114
201
 
115
202
* Fix up Inventory objects to represent root object as an entry.
116
203
 
117
 
* Don't convert entire entry from 
 
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.
118
207
 
119
208
* Extract changes from one revision to the next to a text form
120
209
  suitable for transmission over email.
121
210
 
122
211
* More test cases.
123
212
 
 
213
  - ``missing`` command
 
214
 
 
215
  - Selected-file commit
 
216
 
 
217
  - Impossible selected-file commit: adding things in non-versioned
 
218
    directories, crossing renames, etc.
 
219
 
124
220
* Write a reproducible benchmark, perhaps importing various kernel versions.
125
221
 
126
 
* Change test.sh from Bourne shell into something in pure Python so
127
 
  that it can be more portable.
128
 
 
129
222
* Directly import diffs!  It seems a bit redundant to need to rescan
130
223
  the directory to work out what files diff added/deleted/changed when
131
224
  all the information is there in the diff in the first place.
135
228
  At the very least we could run diffstat over the diff, or perhaps
136
229
  read the status output from patch.  Just knowing which files might
137
230
  be modified would be enough to guide the add and commit.
138
 
  
 
231
 
139
232
  Given this we might be able to import patches at 1/second or better.
140
233
 
141
 
* Get branch over http.
142
 
 
143
 
* Pull pure updates over http.
144
 
 
145
234
* revfile compression.
146
235
 
147
 
* Split inventory into per-directory files.
 
236
* Split inventory into per-directory files?
148
237
 
149
238
* Fix ignore file parsing:
150
239
 
177
266
 
178
267
* Handle symlinks in the working directory; at the very least it
179
268
  should be possible for them to be present and ignored/unknown
180
 
  without causing assertion failures. 
 
269
  without causing assertion failures.
181
270
 
182
271
  Eventually symlinks should be versioned.
183
272
 
185
274
  if the subdirectory is not already versioned.   Perhaps also require
186
275
  a ``--nested`` to protect against confusion.
187
276
 
188
 
* Branch names? 
 
277
* Branch names?
189
278
 
190
279
* More test framework:
191
280
 
192
281
  - Class that describes the state of a working tree so we can just
193
282
    assert it's equal.
194
283
 
195
 
* There are too many methods on Branch() that really manipulate the
196
 
  WorkingTree.  They should be moved across.  
197
 
 
198
 
  Also there are some methods which are duplicated on Tree and
199
 
  Inventory objects, and it should be made more clear which ones are
200
 
  proxies and which ones behave differently, and how.
201
 
 
202
284
* Try using XSLT to add some formatting to REST-generated HTML.  Or
203
285
  maybe write a small Python program that specifies a header and foot
204
286
  for the pages and calls into the docutils libraries.
224
306
    object interface though, but perhaps that should just be a proxy
225
307
    for the elements.
226
308
 
227
 
  - Less special cases for the root directory. 
 
309
  - Less special cases for the root directory.
228
310
 
229
311
* Perhaps inventories should remember the revision in which each file
230
312
  was last changed, as well as its current state?  This is a bit
231
313
  redundant but might often be interested to know.
232
314
 
 
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
 
317
  optimization of stating them in inode order.
 
318
 
 
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
 
321
  in a particular revision, etc.
 
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
 
 
326
* Paranoid mode where we never trust SHA-1 matches.
 
327
 
 
328
* --dry-run mode for commit?  (Or maybe just run with
 
329
  check-command=false?)
 
330
 
 
331
* Generally, be a bit more verbose unless --silent is specified.
 
332
 
 
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
 
233
380
 
234
381
Large things
235
382
------------
265
412
  files, and respecting selective commits.  Run the pre-commit check
266
413
  (e.g. compile and run test suite) in there.
267
414
 
 
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
 
434
  content was not left behind in the stores.
 
435
 
268
436
* Web interface
269
437
 
270
438
* GUI (maybe in Python GTK+?)