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
* Add of a file that was present in the base revision should put back
23
* Handle diff of files which do not have a trailing newline; probably
24
requires patching difflib to get it exactly right, or otherwise
25
calling out to GNU diff.
27
* Import ElementTree update patch.
29
* Plugins that provide commands. By just installing a file into some
30
directory (e.g. ``/usr/share/bzr/plugins``) it should be possible to
31
create new top-level commands (``bzr frob``). Extensions can be
32
written in either Python (in which case they use the bzrlib API) or
33
in a separate process (in sh, C, whatever). It should be possible
34
to get help for plugin commands.
36
* Smart rewrap text in help messages to fit in $COLUMNS (or equivalent
39
* -r option should take a revision-id as well as a revno.
41
* ``bzr info`` could show space used by working tree, versioned files,
42
unknown and ignored files.
44
* ``bzr info`` should count only people with distinct email addresses as
45
different committers. (Or perhaps only distinct userids?)
47
* On Windows, command-line arguments should be `glob-expanded`__,
48
because the shell doesn't do this. However, there are probably some
49
commands where this shouldn't be done, such as 'bzr ignore', because
50
we want to accept globs.
52
* ``bzr ignore`` command that just adds a line to the ``.bzrignore`` file
53
and makes it versioned. Fix this to break symlinks.
55
* Any useful sanity checks in 'bzr ignore'? Perhaps give a warning if
56
they try to add a single file which is already versioned, or if they
57
add a pattern which already exists, or if it looks like they gave an
60
__ http://mail.python.org/pipermail/python-list/2001-April/037847.html
62
* Separate read and write version checks?
64
* ``bzr status DIR`` should give status on all files under that
67
* ``bzr log DIR`` should give changes to any files within DIR.
69
* Check all commands have decent help.
71
* ``bzr inventory -r REV`` and perhaps unify this with ``bzr ls``,
72
giving options to display ids, types, etc.
74
* Atomic file class that renames into place when it's closed.
76
* Don't abort if ``~/.bzr.log`` can't be used.
78
* Split BzrError into various more specific subclasses for different
79
errors people might want to catch.
81
* If the export destination ends in '.tar', '.tar.gz', etc then create
82
a tarball instead of a directory. (Need to actually make a
83
temporary directory and then tar that up.)
85
http://www.gelato.unsw.edu.au/archives/git/0504/2194.html
87
* testbzr should by default test the bzr binary in the same directory
88
as the testbzr script, or take a path to it as a first parameter.
90
Should show the version from bzr and the path name.
92
* RemoteBranch could maintain a cache either in memory or on disk. We
93
know more than an external cache might about which files are
94
immutable and which can vary. On the other hand, it's much simpler
95
to just use an external proxy cache.
101
* Change command functions into Command() objects, like in hct, and
102
then the grammar can be described directly in there. Since all
103
option definitions are global we can define them just once and
104
reference them from each command.
106
* Selective commit of only some files.
108
* Merge Aaron's merge code.
110
* Merge revert patch.
112
* ``bzr mv`` that does either rename or move as in Unix.
114
* More efficient diff of only selected files. We should be able to
115
just get the id for the selected files, look up their location and
116
diff just those files. No need to traverse the entire inventories.
118
* ``bzr status DIR`` or ``bzr diff DIR`` should report on all changes
119
under that directory.
121
* Fix up Inventory objects to represent root object as an entry.
123
* Don't convert entire entry from
125
* Extract changes from one revision to the next to a text form
126
suitable for transmission over email.
130
* Write a reproducible benchmark, perhaps importing various kernel versions.
132
* Change test.sh from Bourne shell into something in pure Python so
133
that it can be more portable.
135
* Directly import diffs! It seems a bit redundant to need to rescan
136
the directory to work out what files diff added/deleted/changed when
137
all the information is there in the diff in the first place.
138
Getting the exact behaviour for added/deleted subdirectories etc
141
At the very least we could run diffstat over the diff, or perhaps
142
read the status output from patch. Just knowing which files might
143
be modified would be enough to guide the add and commit.
145
Given this we might be able to import patches at 1/second or better.
147
* Get branch over http.
149
* Pull pure updates over http.
151
* revfile compression.
153
* Split inventory into per-directory files.
155
* Fix ignore file parsing:
157
- fnmatch is not the same as unix patterns
159
- perhaps add extended globs from rsh/rsync
161
- perhaps a pattern that matches only directories or non-directories
163
* Consider using Python logging library as well as/instead of
166
* Commands should give some progress indication by default.
168
- But quieten this with ``--silent``.
170
* Change to using gettext message localization.
172
* Make a clearer separation between internal and external bzrlib
173
interfaces. Make internal interfaces use protected names. Write at
174
least some documentation for those APIs, probably as docstrings.
176
Consider using ZopeInterface definitions for the external interface;
177
I think these are already used in PyBaz. They allow automatic
178
checking of the interface but may be unfamiliar to general Python
179
developers, so I'm not really keen.
181
* Commands to dump out all command help into a manpage or HTML file or
184
* Handle symlinks in the working directory; at the very least it
185
should be possible for them to be present and ignored/unknown
186
without causing assertion failures.
188
Eventually symlinks should be versioned.
190
* Allow init in a subdirectory to create a nested repository, but only
191
if the subdirectory is not already versioned. Perhaps also require
192
a ``--nested`` to protect against confusion.
196
* More test framework:
198
- Class that describes the state of a working tree so we can just
201
* There are too many methods on Branch() that really manipulate the
202
WorkingTree. They should be moved across.
204
Also there are some methods which are duplicated on Tree and
205
Inventory objects, and it should be made more clear which ones are
206
proxies and which ones behave differently, and how.
208
* Try using XSLT to add some formatting to REST-generated HTML. Or
209
maybe write a small Python program that specifies a header and foot
210
for the pages and calls into the docutils libraries.
212
* --format=xml for log, status and other commands.
214
* Attempting to explicitly add a file that's already added should give
215
a warning; however there should be no warning for directories (since
216
we scan for new children) or files encountered in a directory that's
219
* Better handling of possible collisions on case-losing filesystems;
220
make sure a single file does not get added twice under different
223
* Clean up XML inventory:
225
- Use nesting rather than parent_id pointers.
227
- Hold the ElementTree in memory in the Inventory object and work
228
directly on that, rather than converting into Python objects every
229
time it is read in. Probably still exposoe it through some kind of
230
object interface though, but perhaps that should just be a proxy
233
- Less special cases for the root directory.
235
* Perhaps inventories should remember the revision in which each file
236
was last changed, as well as its current state? This is a bit
237
redundant but might often be interested to know.
239
* stat cache should perhaps only stat files as necessary, rather than
240
doing them all up-front. On the other hand, that disallows the
241
opimization of stating them in inode order.
243
* It'd be nice to pipeline multiple HTTP requests. Often we can
244
predict what will be wanted in future: all revisions, or all texts
245
in a particular revision, etc.
247
urlgrabber's docs say they are working on batched downloads; we
248
could perhaps ride on that or just create a background thread (ew).
250
* Should be a signature at the top of the cache file.
252
* Paranoid mode where we never trust SHA-1 matches.
258
* Generate annotations from current file relative to previous
261
- Is it necessary to store any kind of annotation where data was
264
* Update revfile_ format and make it active:
266
- Texts should be identified by something keyed on the revision, not
267
an individual text-id. This is much more useful for annotate I
268
think; we want to map back to the revision that last changed it.
270
- Access revfile revisions through the Tree/Store classes.
272
- Check them from check commands.
276
.. _revfile: revfile.html
278
* Hooks for pre-commit, post-commit, etc.
280
Consider the security implications; probably should not enable hooks
281
for remotely-fetched branches by default.
283
* Pre-commit check. If this hook is defined, it needs to be handled
284
specially: create a temporary directory containing the tree as it
285
will be after the commit. This means excluding any ignored/unknown
286
files, and respecting selective commits. Run the pre-commit check
287
(e.g. compile and run test suite) in there.
291
* GUI (maybe in Python GTK+?)
293
* C library interface
295
* Expansion of $Id$ keywords within working files. Perhaps do this in
296
exports first as a simpler case because then we don't need to deal
297
with removing the tags on the way back in.
added
removed
TODO
