~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Martin Pool
  • Date: 2005-05-05 06:38:18 UTC
  • Revision ID: mbp@sourcefrog.net-20050505063818-3eb3260343878325
- do upload CHANGELOG to web server, even though it's autogenerated

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
 
* 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
20
* Add of a file that was present in the base revision should put back
29
21
  the previous file-id.
30
22
 
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
23
* Handle diff of files which do not have a trailing newline; probably
36
24
  requires patching difflib to get it exactly right, or otherwise
37
25
  calling out to GNU diff.
38
26
 
39
 
* Should be able to copy files between branches to preserve their
40
 
  file-id (and perhaps eventually parentage.)
 
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)
41
40
 
42
41
* -r option should take a revision-id as well as a revno.
43
42
 
44
 
* allow ``bzr st -r 300`` to show a summary of changes since then.
 
43
* ``bzr info`` could show space used by working tree, versioned files,
 
44
  unknown and ignored files. 
45
45
 
46
46
* ``bzr info`` should count only people with distinct email addresses as
47
47
  different committers.  (Or perhaps only distinct userids?)
54
54
* ``bzr ignore`` command that just adds a line to the ``.bzrignore`` file
55
55
  and makes it versioned.  Fix this to break symlinks.
56
56
 
 
57
* ``bzr help commands`` should give a one-line summary of each command.
 
58
 
57
59
* Any useful sanity checks in 'bzr ignore'?  Perhaps give a warning if
58
60
  they try to add a single file which is already versioned, or if they
59
61
  add a pattern which already exists, or if it looks like they gave an
61
63
 
62
64
__ http://mail.python.org/pipermail/python-list/2001-April/037847.html
63
65
 
 
66
* Read and write locks on branch while it's open.
 
67
 
64
68
* Separate read and write version checks?
65
69
 
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
* ``bzr status FILE...``
 
71
 
 
72
* Check all commands have decent help.
 
73
 
 
74
* Autogenerate argument/option help.
70
75
 
71
76
* ``bzr inventory -r REV`` and perhaps unify this with ``bzr ls``,
72
77
  giving options to display ids, types, etc.
73
78
 
 
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
 
74
83
* Split BzrError into various more specific subclasses for different
75
84
  errors people might want to catch.
76
85
 
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
 
* quotefn doubles all backslashes on Windows; this is probably not the
107
 
  best thing to do.  What would be a better way to safely represent
108
 
  filenames?  Perhaps we could doublequote things containing spaces,
109
 
  on the principle that filenames containing quotes are unlikely?
110
 
  Nice for humans; less good for machine parsing.
111
 
 
112
 
* Patches should probably use only forward slashes, even on Windows,
113
 
  otherwise Unix patch can't apply them. (?)
114
 
 
115
 
* Branch.update_revisions() inefficiently fetches revisions from the
116
 
  remote server twice; once to find out what text and inventory they
117
 
  need and then again to actually get the thing.  This is a bit
118
 
  inefficient.
119
 
 
120
 
  One complicating factor here is that we don't really want to have
121
 
  revisions present in the revision-store until all their constituent
122
 
  parts are also stored.
123
 
 
124
 
  The basic problem is that RemoteBranch.get_revision() and similar
125
 
  methods return object, but what we really want is the raw XML, which
126
 
  can be popped into our own store.  That needs to be refactored.
127
 
 
128
 
* ``bzr status FOO`` where foo is ignored should say so.
129
 
 
130
 
* ``bzr mkdir A...`` should just create and add A.
131
 
 
132
 
* Guard against repeatedly merging any particular patch.
133
 
 
134
 
* More options for diff:
135
 
 
136
 
  - diff two revisions of the same tree
137
 
 
138
 
  - diff two different branches, optionally at different revisions
139
 
 
140
 
  - diff a particular file in another tree against the corresponding
141
 
    version in this tree (which should be the default if the second
142
 
    parameter is a tree root)
143
 
 
144
 
  - diff everything under a particular directory, in any of the above
145
 
    ways
146
 
 
147
 
  - diff two files inside the same tree, even if they have different
148
 
    ids
149
 
 
150
 
  - and, of course, tests for all this
151
 
 
152
 
* stat-cache update is too slow for some reason - why is Python making
153
 
  a lot of futex calls?
154
 
 
155
 
 
156
 
 
157
86
Medium things
158
87
-------------
159
88
 
 
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
 
160
106
* Merge revert patch.
161
107
 
 
108
* Turn on stat cache code, and add optimization about avoiding
 
109
  dangerous cache entries.
 
110
 
162
111
* ``bzr mv`` that does either rename or move as in Unix.
163
112
 
164
 
* More efficient diff of only selected files.  We should be able to
165
 
  just get the id for the selected files, look up their location and
166
 
  diff just those files.  No need to traverse the entire inventories.
167
 
 
168
 
* ``bzr status DIR`` or ``bzr diff DIR`` should report on all changes
169
 
  under that directory.
 
113
* More efficient diff of only selected files.
170
114
 
171
115
* Fix up Inventory objects to represent root object as an entry.
172
116
 
173
 
* Don't convert entire entry from ElementTree to an object when it is
174
 
  read in, but rather wait until the program actually wants to know
175
 
  about that node.
 
117
* Don't convert entire entry from 
176
118
 
177
119
* Extract changes from one revision to the next to a text form
178
120
  suitable for transmission over email.
179
121
 
180
122
* More test cases.
181
123
 
182
 
  - Selected-file commit
183
 
 
184
 
  - Impossible selected-file commit: adding things in non-versioned
185
 
    directories, crossing renames, etc.
186
 
 
187
124
* Write a reproducible benchmark, perhaps importing various kernel versions.
188
125
 
 
126
* Change test.sh from Bourne shell into something in pure Python so
 
127
  that it can be more portable.
 
128
 
189
129
* Directly import diffs!  It seems a bit redundant to need to rescan
190
130
  the directory to work out what files diff added/deleted/changed when
191
131
  all the information is there in the diff in the first place.
195
135
  At the very least we could run diffstat over the diff, or perhaps
196
136
  read the status output from patch.  Just knowing which files might
197
137
  be modified would be enough to guide the add and commit.
198
 
 
 
138
  
199
139
  Given this we might be able to import patches at 1/second or better.
200
140
 
201
141
* Get branch over http.
237
177
 
238
178
* Handle symlinks in the working directory; at the very least it
239
179
  should be possible for them to be present and ignored/unknown
240
 
  without causing assertion failures.
 
180
  without causing assertion failures. 
241
181
 
242
182
  Eventually symlinks should be versioned.
243
183
 
245
185
  if the subdirectory is not already versioned.   Perhaps also require
246
186
  a ``--nested`` to protect against confusion.
247
187
 
248
 
* Branch names?
 
188
* Branch names? 
249
189
 
250
190
* More test framework:
251
191
 
253
193
    assert it's equal.
254
194
 
255
195
* There are too many methods on Branch() that really manipulate the
256
 
  WorkingTree.  They should be moved across.
 
196
  WorkingTree.  They should be moved across.  
257
197
 
258
198
  Also there are some methods which are duplicated on Tree and
259
199
  Inventory objects, and it should be made more clear which ones are
263
203
  maybe write a small Python program that specifies a header and foot
264
204
  for the pages and calls into the docutils libraries.
265
205
 
266
 
* --format=xml for log, status and other commands.
267
 
 
268
 
* Attempting to explicitly add a file that's already added should give
269
 
  a warning; however there should be no warning for directories (since
270
 
  we scan for new children) or files encountered in a directory that's
271
 
  being scanned.
272
 
 
273
 
* Better handling of possible collisions on case-losing filesystems;
274
 
  make sure a single file does not get added twice under different
275
 
  names.
276
 
 
277
 
* Clean up XML inventory:
278
 
 
279
 
  - Use nesting rather than parent_id pointers.
280
 
 
281
 
  - Hold the ElementTree in memory in the Inventory object and work
282
 
    directly on that, rather than converting into Python objects every
283
 
    time it is read in.  Probably still exposoe it through some kind of
284
 
    object interface though, but perhaps that should just be a proxy
285
 
    for the elements.
286
 
 
287
 
  - Less special cases for the root directory.
288
 
 
289
 
* Perhaps inventories should remember the revision in which each file
290
 
  was last changed, as well as its current state?  This is a bit
291
 
  redundant but might often be interested to know.
292
 
 
293
 
* stat cache should perhaps only stat files as necessary, rather than
294
 
  doing them all up-front.  On the other hand, that disallows the
295
 
  opimization of stating them in inode order.
296
 
 
297
 
* It'd be nice to pipeline multiple HTTP requests.  Often we can
298
 
  predict what will be wanted in future: all revisions, or all texts
299
 
  in a particular revision, etc.
300
 
 
301
 
  urlgrabber's docs say they are working on batched downloads; we
302
 
  could perhaps ride on that or just create a background thread (ew).
303
 
 
304
 
* Paranoid mode where we never trust SHA-1 matches.
305
 
 
306
 
* Don't commit if there are no changes unless forced.
307
 
 
308
 
* --dry-run mode for commit?  (Or maybe just run with
309
 
  check-command=false?)
310
 
 
311
 
* Generally, be a bit more verbose unless --silent is specified.
312
 
 
313
 
* Function that finds all changes to files under a given directory;
314
 
  perhaps log should use this if a directory is given.
315
 
 
316
 
* XML attributes might have trouble with filenames containing \n and
317
 
  \r.  Do we really want to support this?  I think perhaps not.
318
 
 
319
 
* Remember execute bits, so that exports will work OK.
320
 
 
321
 
* Unify smart_add and plain Branch.add(); perhaps smart_add should
322
 
  just build a list of files to add and pass that to the regular add
323
 
  function.
324
 
 
325
 
* Function to list a directory, saying in which revision each file was
326
 
  last modified.  Useful for web and gui interfaces, and slow to
327
 
  compute one file at a time.
328
 
 
329
 
* unittest is standard, but the results are kind of ugly; would be
330
 
  nice to make it cleaner.
331
 
 
332
 
* Check locking is correct during merge-related operations.
333
 
 
334
 
* Perhaps attempts to get locks should timeout after some period of
335
 
  time, or at least display a progress message.
336
 
 
337
 
* Split out upgrade functionality from check command into a separate
338
 
  ``bzr upgrade``.
339
 
 
340
 
* Don't pass around command classes but rather pass objects.  This'd
341
 
  make it cleaner to construct objects wrapping external commands.
342
 
 
343
 
* Track all merged-in revisions in a versioned add-only metafile.
 
206
 
344
207
 
345
208
 
346
209
Large things
377
240
  files, and respecting selective commits.  Run the pre-commit check
378
241
  (e.g. compile and run test suite) in there.
379
242
 
380
 
  Possibly this should be done by splitting the commit function into
381
 
  several parts (under a single interface).  It is already rather
382
 
  large.  Decomposition:
383
 
 
384
 
   - find tree modifications and prepare in-memory inventory
385
 
 
386
 
   - export that inventory to a temporary directory
387
 
 
388
 
   - run the test in that temporary directory
389
 
 
390
 
   - if that succeeded, continue to actually finish the commit
391
 
 
392
 
  What should be done with the text of modified files while this is
393
 
  underway?  I don't think we want to count on holding them in memory
394
 
  and we can't trust the working files to stay in one place so I
395
 
  suppose we need to move them into the text store, or otherwise into
396
 
  a temporary directory.
397
 
 
398
 
  If the commit does not actually complete, we would rather the
399
 
  content was not left behind in the stores.
400
 
 
401
243
* Web interface
402
244
 
403
245
* GUI (maybe in Python GTK+?)