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
* is_within_any is very very dodgy
22
* Merging add of a new file clashing with an existing file doesn't
23
work; add gets an error that it's already versioned and the merge
26
* Merge should ignore the destination's working directory, otherwise
27
we get an error about the statcache when pulling from a remote
30
* Add of a file that was present in the base revision should put back
33
* Not sure I'm happy with needing to pass a root id to EmptyTree;
34
comparing anything against an EmptyTree with no root should have the
37
* Handle diff of files which do not have a trailing newline; probably
38
requires patching difflib to get it exactly right, or otherwise
39
calling out to GNU diff.
41
* Should be able to copy files between branches to preserve their
42
file-id (and perhaps eventually parentage.)
44
* -r option should take a revision-id as well as a revno.
46
* allow ``bzr st -r 300`` to show a summary of changes since then.
48
* ``bzr info`` should count only people with distinct email addresses as
49
different committers. (Or perhaps only distinct userids?)
51
* On Windows, command-line arguments should be `glob-expanded`__,
52
because the shell doesn't do this. However, there are probably some
53
commands where this shouldn't be done, such as 'bzr ignore', because
54
we want to accept globs.
56
* ``bzr ignore`` command that just adds a line to the ``.bzrignore`` file
57
and makes it versioned. Fix this to break symlinks.
59
* Any useful sanity checks in 'bzr ignore'? Perhaps give a warning if
60
they try to add a single file which is already versioned, or if they
61
add a pattern which already exists, or if it looks like they gave an
64
__ http://mail.python.org/pipermail/python-list/2001-April/037847.html
66
* Separate read and write version checks?
68
* ``bzr status DIR`` should give status on all files under that
71
* ``bzr log DIR`` should give changes to any files within DIR.
73
* ``bzr inventory -r REV`` and perhaps unify this with ``bzr ls``,
74
giving options to display ids, types, etc.
76
* Split BzrError into various more specific subclasses for different
77
errors people might want to catch.
79
* If the export destination ends in '.tar', '.tar.gz', etc then create
80
a tarball instead of a directory. (Need to actually make a
81
temporary directory and then tar that up.)
83
http://www.gelato.unsw.edu.au/archives/git/0504/2194.html
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
* ``bzr status FOO`` where foo is ignored should say so.
132
* ``bzr mkdir A...`` should just create and add A.
134
* Guard against repeatedly merging any particular patch.
136
* More options for diff:
138
- diff two revisions of the same tree
140
- diff two different branches, optionally at different revisions
142
- diff a particular file in another tree against the corresponding
143
version in this tree (which should be the default if the second
144
parameter is a tree root)
146
- diff everything under a particular directory, in any of the above
149
- diff two files inside the same tree, even if they have different
152
- and, of course, tests for all this
154
* ``bzr add`` with no arguments should probably be the same as ``bzr add .``
156
* Reproducible performance benchmark to measure whether performance is
157
getting better or worse.
163
* Merge revert patch.
165
* ``bzr mv`` that does either rename or move as in Unix.
167
* More efficient diff of only selected files. We should be able to
168
just get the id for the selected files, look up their location and
169
diff just those files. No need to traverse the entire inventories.
171
* ``bzr status DIR`` or ``bzr diff DIR`` should report on all changes
172
under that directory.
174
* Fix up Inventory objects to represent root object as an entry.
176
* Don't convert entire entry from ElementTree to an object when it is
177
read in, but rather wait until the program actually wants to know
180
* Extract changes from one revision to the next to a text form
181
suitable for transmission over email.
185
- Selected-file commit
187
- Impossible selected-file commit: adding things in non-versioned
188
directories, crossing renames, etc.
190
* Write a reproducible benchmark, perhaps importing various kernel versions.
192
* Directly import diffs! It seems a bit redundant to need to rescan
193
the directory to work out what files diff added/deleted/changed when
194
all the information is there in the diff in the first place.
195
Getting the exact behaviour for added/deleted subdirectories etc
198
At the very least we could run diffstat over the diff, or perhaps
199
read the status output from patch. Just knowing which files might
200
be modified would be enough to guide the add and commit.
202
Given this we might be able to import patches at 1/second or better.
204
* Get branch over http.
206
* Pull pure updates over http.
208
* revfile compression.
210
* Split inventory into per-directory files.
212
* Fix ignore file parsing:
214
- fnmatch is not the same as unix patterns
216
- perhaps add extended globs from rsh/rsync
218
- perhaps a pattern that matches only directories or non-directories
220
* Consider using Python logging library as well as/instead of
223
* Commands should give some progress indication by default.
225
- But quieten this with ``--silent``.
227
* Change to using gettext message localization.
229
* Make a clearer separation between internal and external bzrlib
230
interfaces. Make internal interfaces use protected names. Write at
231
least some documentation for those APIs, probably as docstrings.
233
Consider using ZopeInterface definitions for the external interface;
234
I think these are already used in PyBaz. They allow automatic
235
checking of the interface but may be unfamiliar to general Python
236
developers, so I'm not really keen.
238
* Commands to dump out all command help into a manpage or HTML file or
241
* Handle symlinks in the working directory; at the very least it
242
should be possible for them to be present and ignored/unknown
243
without causing assertion failures.
245
Eventually symlinks should be versioned.
247
* Allow init in a subdirectory to create a nested repository, but only
248
if the subdirectory is not already versioned. Perhaps also require
249
a ``--nested`` to protect against confusion.
253
* More test framework:
255
- Class that describes the state of a working tree so we can just
258
* There are too many methods on Branch() that really manipulate the
259
WorkingTree. They should be moved across.
261
Also there are some methods which are duplicated on Tree and
262
Inventory objects, and it should be made more clear which ones are
263
proxies and which ones behave differently, and how.
265
* Try using XSLT to add some formatting to REST-generated HTML. Or
266
maybe write a small Python program that specifies a header and foot
267
for the pages and calls into the docutils libraries.
269
* --format=xml for log, status and other commands.
271
* Attempting to explicitly add a file that's already added should give
272
a warning; however there should be no warning for directories (since
273
we scan for new children) or files encountered in a directory that's
276
* Better handling of possible collisions on case-losing filesystems;
277
make sure a single file does not get added twice under different
280
* Clean up XML inventory:
282
- Use nesting rather than parent_id pointers.
284
- Hold the ElementTree in memory in the Inventory object and work
285
directly on that, rather than converting into Python objects every
286
time it is read in. Probably still exposoe it through some kind of
287
object interface though, but perhaps that should just be a proxy
290
- Less special cases for the root directory.
292
* Perhaps inventories should remember the revision in which each file
293
was last changed, as well as its current state? This is a bit
294
redundant but might often be interested to know.
296
* stat cache should perhaps only stat files as necessary, rather than
297
doing them all up-front. On the other hand, that disallows the
298
opimization of stating them in inode order.
300
* It'd be nice to pipeline multiple HTTP requests. Often we can
301
predict what will be wanted in future: all revisions, or all texts
302
in a particular revision, etc.
304
urlgrabber's docs say they are working on batched downloads; we
305
could perhaps ride on that or just create a background thread (ew).
307
* Paranoid mode where we never trust SHA-1 matches.
309
* Don't commit if there are no changes unless forced.
311
* --dry-run mode for commit? (Or maybe just run with
312
check-command=false?)
314
* Generally, be a bit more verbose unless --silent is specified.
316
* Function that finds all changes to files under a given directory;
317
perhaps log should use this if a directory is given.
319
* XML attributes might have trouble with filenames containing \n and
320
\r. Do we really want to support this? I think perhaps not.
322
* Remember execute bits, so that exports will work OK.
324
* Unify smart_add and plain Branch.add(); perhaps smart_add should
325
just build a list of files to add and pass that to the regular add
328
* Function to list a directory, saying in which revision each file was
329
last modified. Useful for web and gui interfaces, and slow to
330
compute one file at a time.
332
* unittest is standard, but the results are kind of ugly; would be
333
nice to make it cleaner.
335
* Check locking is correct during merge-related operations.
337
* Perhaps attempts to get locks should timeout after some period of
338
time, or at least display a progress message.
340
* Split out upgrade functionality from check command into a separate
343
* Don't pass around command classes but rather pass objects. This'd
344
make it cleaner to construct objects wrapping external commands.
346
* Track all merged-in revisions in a versioned add-only metafile.
352
* Generate annotations from current file relative to previous
355
- Is it necessary to store any kind of annotation where data was
358
* Update revfile_ format and make it active:
360
- Texts should be identified by something keyed on the revision, not
361
an individual text-id. This is much more useful for annotate I
362
think; we want to map back to the revision that last changed it.
364
- Access revfile revisions through the Tree/Store classes.
366
- Check them from check commands.
370
.. _revfile: revfile.html
372
* Hooks for pre-commit, post-commit, etc.
374
Consider the security implications; probably should not enable hooks
375
for remotely-fetched branches by default.
377
* Pre-commit check. If this hook is defined, it needs to be handled
378
specially: create a temporary directory containing the tree as it
379
will be after the commit. This means excluding any ignored/unknown
380
files, and respecting selective commits. Run the pre-commit check
381
(e.g. compile and run test suite) in there.
383
Possibly this should be done by splitting the commit function into
384
several parts (under a single interface). It is already rather
385
large. Decomposition:
387
- find tree modifications and prepare in-memory inventory
389
- export that inventory to a temporary directory
391
- run the test in that temporary directory
393
- if that succeeded, continue to actually finish the commit
395
What should be done with the text of modified files while this is
396
underway? I don't think we want to count on holding them in memory
397
and we can't trust the working files to stay in one place so I
398
suppose we need to move them into the text store, or otherwise into
399
a temporary directory.
401
If the commit does not actually complete, we would rather the
402
content was not left behind in the stores.
406
* GUI (maybe in Python GTK+?)
408
* C library interface
410
* Expansion of $Id$ keywords within working files. Perhaps do this in
411
exports first as a simpler case because then we don't need to deal
412
with removing the tags on the way back in.
added
removed
TODO
