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
* Split BzrError into various more specific subclasses for different
75
errors people might want to catch.
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.)
81
http://www.gelato.unsw.edu.au/archives/git/0504/2194.html
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.
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.
92
* Maybe also store directories in the statcache so that we can quickly
93
identify that they still exist.
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.
99
* Perhaps split command infrastructure from the actual command
102
* Cleaner support for negative boolean options like --no-recurse.
104
* Statcache should possibly map all file paths to / separators
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.
112
* Patches should probably use only forward slashes, even on Windows,
113
otherwise Unix patch can't apply them. (?)
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
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.
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.
133
* Merge revert patch.
135
* ``bzr mv`` that does either rename or move as in Unix.
137
* More efficient diff of only selected files. We should be able to
138
just get the id for the selected files, look up their location and
139
diff just those files. No need to traverse the entire inventories.
141
* ``bzr status DIR`` or ``bzr diff DIR`` should report on all changes
142
under that directory.
144
* Fix up Inventory objects to represent root object as an entry.
146
* Don't convert entire entry from ElementTree to an object when it is
147
read in, but rather wait until the program actually wants to know
150
* Extract changes from one revision to the next to a text form
151
suitable for transmission over email.
155
- Selected-file commit
157
- Impossible selected-file commit: adding things in non-versioned
158
directories, crossing renames, etc.
160
* Write a reproducible benchmark, perhaps importing various kernel versions.
162
* Directly import diffs! It seems a bit redundant to need to rescan
163
the directory to work out what files diff added/deleted/changed when
164
all the information is there in the diff in the first place.
165
Getting the exact behaviour for added/deleted subdirectories etc
168
At the very least we could run diffstat over the diff, or perhaps
169
read the status output from patch. Just knowing which files might
170
be modified would be enough to guide the add and commit.
172
Given this we might be able to import patches at 1/second or better.
174
* Get branch over http.
176
* Pull pure updates over http.
178
* revfile compression.
180
* Split inventory into per-directory files.
182
* Fix ignore file parsing:
184
- fnmatch is not the same as unix patterns
186
- perhaps add extended globs from rsh/rsync
188
- perhaps a pattern that matches only directories or non-directories
190
* Consider using Python logging library as well as/instead of
193
* Commands should give some progress indication by default.
195
- But quieten this with ``--silent``.
197
* Change to using gettext message localization.
199
* Make a clearer separation between internal and external bzrlib
200
interfaces. Make internal interfaces use protected names. Write at
201
least some documentation for those APIs, probably as docstrings.
203
Consider using ZopeInterface definitions for the external interface;
204
I think these are already used in PyBaz. They allow automatic
205
checking of the interface but may be unfamiliar to general Python
206
developers, so I'm not really keen.
208
* Commands to dump out all command help into a manpage or HTML file or
211
* Handle symlinks in the working directory; at the very least it
212
should be possible for them to be present and ignored/unknown
213
without causing assertion failures.
215
Eventually symlinks should be versioned.
217
* Allow init in a subdirectory to create a nested repository, but only
218
if the subdirectory is not already versioned. Perhaps also require
219
a ``--nested`` to protect against confusion.
223
* More test framework:
225
- Class that describes the state of a working tree so we can just
228
* There are too many methods on Branch() that really manipulate the
229
WorkingTree. They should be moved across.
231
Also there are some methods which are duplicated on Tree and
232
Inventory objects, and it should be made more clear which ones are
233
proxies and which ones behave differently, and how.
235
* Try using XSLT to add some formatting to REST-generated HTML. Or
236
maybe write a small Python program that specifies a header and foot
237
for the pages and calls into the docutils libraries.
239
* --format=xml for log, status and other commands.
241
* Attempting to explicitly add a file that's already added should give
242
a warning; however there should be no warning for directories (since
243
we scan for new children) or files encountered in a directory that's
246
* Better handling of possible collisions on case-losing filesystems;
247
make sure a single file does not get added twice under different
250
* Clean up XML inventory:
252
- Use nesting rather than parent_id pointers.
254
- Hold the ElementTree in memory in the Inventory object and work
255
directly on that, rather than converting into Python objects every
256
time it is read in. Probably still exposoe it through some kind of
257
object interface though, but perhaps that should just be a proxy
260
- Less special cases for the root directory.
262
* Perhaps inventories should remember the revision in which each file
263
was last changed, as well as its current state? This is a bit
264
redundant but might often be interested to know.
266
* stat cache should perhaps only stat files as necessary, rather than
267
doing them all up-front. On the other hand, that disallows the
268
opimization of stating them in inode order.
270
* It'd be nice to pipeline multiple HTTP requests. Often we can
271
predict what will be wanted in future: all revisions, or all texts
272
in a particular revision, etc.
274
urlgrabber's docs say they are working on batched downloads; we
275
could perhaps ride on that or just create a background thread (ew).
277
* Paranoid mode where we never trust SHA-1 matches.
279
* Don't commit if there are no changes unless forced.
281
* --dry-run mode for commit? (Or maybe just run with
282
check-command=false?)
284
* Generally, be a bit more verbose unless --silent is specified.
286
* Function that finds all changes to files under a given directory;
287
perhaps log should use this if a directory is given.
289
* XML attributes might have trouble with filenames containing \n and
290
\r. Do we really want to support this? I think perhaps not.
292
* Remember execute bits, so that exports will work OK.
294
* Unify smart_add and plain Branch.add(); perhaps smart_add should
295
just build a list of files to add and pass that to the regular add
298
* Function to list a directory, saying in which revision each file was
299
last modified. Useful for web and gui interfaces, and slow to
300
compute one file at a time.
302
* unittest is standard, but the results are kind of ugly; would be
303
nice to make it cleaner.
305
* Check locking is correct during merge-related operations.
307
* Perhaps attempts to get locks should timeout after some period of
308
time, or at least display a progress message.
314
* Generate annotations from current file relative to previous
317
- Is it necessary to store any kind of annotation where data was
320
* Update revfile_ format and make it active:
322
- Texts should be identified by something keyed on the revision, not
323
an individual text-id. This is much more useful for annotate I
324
think; we want to map back to the revision that last changed it.
326
- Access revfile revisions through the Tree/Store classes.
328
- Check them from check commands.
332
.. _revfile: revfile.html
334
* Hooks for pre-commit, post-commit, etc.
336
Consider the security implications; probably should not enable hooks
337
for remotely-fetched branches by default.
339
* Pre-commit check. If this hook is defined, it needs to be handled
340
specially: create a temporary directory containing the tree as it
341
will be after the commit. This means excluding any ignored/unknown
342
files, and respecting selective commits. Run the pre-commit check
343
(e.g. compile and run test suite) in there.
345
Possibly this should be done by splitting the commit function into
346
several parts (under a single interface). It is already rather
347
large. Decomposition:
349
- find tree modifications and prepare in-memory inventory
351
- export that inventory to a temporary directory
353
- run the test in that temporary directory
355
- if that succeeded, continue to actually finish the commit
357
What should be done with the text of modified files while this is
358
underway? I don't think we want to count on holding them in memory
359
and we can't trust the working files to stay in one place so I
360
suppose we need to move them into the text store, or otherwise into
361
a temporary directory.
363
If the commit does not actually complete, we would rather the
364
content was not left behind in the stores.
368
* GUI (maybe in Python GTK+?)
370
* C library interface
372
* Expansion of $Id$ keywords within working files. Perhaps do this in
373
exports first as a simpler case because then we don't need to deal
374
with removing the tags on the way back in.
added
removed
TODO
