1
.. -*- mode: indented-text; compile-command: "make -C doc" -*-
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
13
These are classified by approximate size: an hour or less, a day or
14
less, and several days or more.
20
* Fix tests so that import errors caused by modules don't produce false reports
21
that the tests themselves don't exist.
23
* Fix tests so that one test failure doesn't prevent other tests from running
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
28
* tests for running the commit editor, and fix problem of not passing in
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
35
* Merge should ignore the destination's working directory, otherwise
36
we get an error about the statcache when pulling from a remote
39
* Add of a file that was present in the base revision should put back
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
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.
50
* Should be able to copy files between branches to preserve their
51
file-id (and perhaps eventually parentage.)
53
* -r option should take a revision-id as well as a revno.
55
* ``bzr info`` should count only people with distinct email addresses as
56
different committers. (Or perhaps only distinct userids?)
58
* On Windows, command-line arguments should be `glob-expanded`__,
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.
63
* ``bzr ignore`` command that just adds a line to the ``.bzrignore`` file
64
and makes it versioned. Fix this to break symlinks.
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
71
__ http://mail.python.org/pipermail/python-list/2001-April/037847.html
73
* Separate read and write version checks?
75
* ``bzr status DIR`` should give status on all files under that
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)
82
* ``bzr inventory -r REV`` and perhaps unify this with ``bzr ls``,
83
giving options to display ids, types, etc.
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.
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.
94
* Maybe also store directories in the statcache so that we can quickly
95
identify that they still exist.
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.
101
* Perhaps split command infrastructure from the actual command
104
* Cleaner support for negative boolean options like --no-recurse.
106
* Statcache should possibly map all file paths to / separators
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.
114
* Patches should probably use only forward slashes, even on Windows,
115
otherwise Unix patch can't apply them. (?)
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
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.
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.
130
* Guard against repeatedly merging any particular patch.
132
* More options for diff:
134
- diff two revisions of the same tree
136
- diff two different branches, optionally at different revisions
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)
142
- diff everything under a particular directory, in any of the above
145
- diff two files inside the same tree, even if they have different
148
- and, of course, tests for all this
150
* Reproducible performance benchmark to measure whether performance is
151
getting better or worse.
153
* ``bzr log -m foo`` should perhaps error if nothing matches?
155
* ``bzr diff -r 30 -r 40 foo.c`` or ``bzr diff -r30..40 foo.c``
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.
161
* bzr diff shouldn't diff binary files
163
* setup.py install when run from a bzr tree should freeze the tree
164
revision-id into the installed bzr.
166
* bzr script should trap ImportError and perhaps give a better error
169
* revert after a merge should possibly remove all the BASE/THIS/OTHER
170
files to get you back to where you were.
172
* files that are added and then deleted are still reported as added
174
* stores should raise KeyError, not IndexError
176
* merging from a remote branch seems to sometimes raise errors not
179
* should be possible to give a related branch when pulling from a
180
remote branch to make things faster
182
* sometimes gives "conflicting add" even when the contents are in fact
185
* BZRDIR should be in branch.py not __init__.py.
190
* merge should add all revision and inventory XML to the local store.
192
* check should give a warning for revisions that are named in the
193
chain but not actually present in the store.
195
* remove anything outside of the branch implementation that directly
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.
202
* Fix up Inventory objects to represent root object as an entry.
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
208
* Extract changes from one revision to the next to a text form
209
suitable for transmission over email.
213
- ``missing`` command
215
- Selected-file commit
217
- Impossible selected-file commit: adding things in non-versioned
218
directories, crossing renames, etc.
220
* Write a reproducible benchmark, perhaps importing various kernel versions.
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
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.
232
Given this we might be able to import patches at 1/second or better.
234
* revfile compression.
236
* Split inventory into per-directory files?
238
* Fix ignore file parsing:
240
- fnmatch is not the same as unix patterns
242
- perhaps add extended globs from rsh/rsync
244
- perhaps a pattern that matches only directories or non-directories
246
* Consider using Python logging library as well as/instead of
249
* Commands should give some progress indication by default.
251
- But quieten this with ``--silent``.
253
* Change to using gettext message localization.
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.
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
262
developers, so I'm not really keen.
264
* Commands to dump out all command help into a manpage or HTML file or
267
* Handle symlinks in the working directory; at the very least it
268
should be possible for them to be present and ignored/unknown
269
without causing assertion failures.
271
Eventually symlinks should be versioned.
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.
279
* More test framework:
281
- Class that describes the state of a working tree so we can just
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.
288
* --format=xml for log, status and other commands.
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
295
* Better handling of possible collisions on case-losing filesystems;
296
make sure a single file does not get added twice under different
299
* Clean up XML inventory:
301
- Use nesting rather than parent_id pointers.
303
- Hold the ElementTree in memory in the Inventory object and work
304
directly on that, rather than converting into Python objects every
305
time it is read in. Probably still expose it through some kind of
306
object interface though, but perhaps that should just be a proxy
309
- Less special cases for the root directory.
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.
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.
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.
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).
326
* Paranoid mode where we never trust SHA-1 matches.
328
* --dry-run mode for commit? (Or maybe just run with
329
check-command=false?)
331
* Generally, be a bit more verbose unless --silent is specified.
333
* Function that finds all changes to files under a given directory;
334
perhaps log should use this if a directory is given.
336
* XML attributes might have trouble with filenames containing \n and
337
\r. Do we really want to support this? I think perhaps not.
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
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.
347
This will be done when we track file texts by referring to the
348
version that created them.
350
* Check locking is correct during merge-related operations.
352
* Perhaps attempts to get locks should timeout after some period of
353
time, or at least display a progress message.
355
* Don't pass around command classes but rather pass objects. This'd
356
make it cleaner to construct objects wrapping external commands.
358
* Track all merged-in revisions in a versioned add-only metafile.
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.
365
It only makes sense to delete from the tail of history.
367
This has been implemented, but it does not remove the texts from
374
* Generate annotations from current file relative to previous
377
- Is it necessary to store any kind of annotation where data was
380
* Update revfile_ format and make it active:
382
- Texts should be identified by something keyed on the revision, not
383
an individual text-id. This is much more useful for annotate I
384
think; we want to map back to the revision that last changed it.
386
- Access revfile revisions through the Tree/Store classes.
388
- Check them from check commands.
392
.. _revfile: revfile.html
394
* Hooks for pre-commit, post-commit, etc.
396
Consider the security implications; probably should not enable hooks
397
for remotely-fetched branches by default.
399
* Pre-commit check. If this hook is defined, it needs to be handled
400
specially: create a temporary directory containing the tree as it
401
will be after the commit. This means excluding any ignored/unknown
402
files, and respecting selective commits. Run the pre-commit check
403
(e.g. compile and run test suite) in there.
405
Possibly this should be done by splitting the commit function into
406
several parts (under a single interface). It is already rather
407
large. Decomposition:
409
- find tree modifications and prepare in-memory inventory
411
- export that inventory to a temporary directory
413
- run the test in that temporary directory
415
- if that succeeded, continue to actually finish the commit
417
What should be done with the text of modified files while this is
418
underway? I don't think we want to count on holding them in memory
419
and we can't trust the working files to stay in one place so I
420
suppose we need to move them into the text store, or otherwise into
421
a temporary directory.
423
If the commit does not actually complete, we would rather the
424
content was not left behind in the stores.
428
* GUI (maybe in Python GTK+?)
430
* C library interface
432
* Expansion of $Id$ keywords within working files. Perhaps do this in
433
exports first as a simpler case because then we don't need to deal
434
with removing the tags on the way back in.
added
removed
TODO
