« back to all changes in this revision
Viewing changes to TODO
- browse files at revision 488
- compare with another revision
- download diff
- download tarball
- view history from revision 488
- Committer: Martin Pool
- Date: 2005-05-12 02:14:35 UTC
- Revision ID: mbp@sourcefrog.net-20050512021435-87fa19f051842647
- new helper function kind_marker()
- files added:
- .rsyncexclude
- contrib
- contrib/bash
- contrib/zsh
- urlgrabber
- files removed:
- doc/faq.txt
- files modified:
- .bzrignore
added
removed
TODO
1
.. -*- mode: indented-text; compile-command: "make -C doc" -*-
2
3
4
*******************
5
Things to do in bzr
6
*******************
7
8
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
11
issues.
12
13
These are classified by approximate size: an hour or less, a day or
14
less, and several days or more.
15
16
17
Small things
18
------------
19
20
* Add of a file that was present in the base revision should put back
21
the previous file-id.
22
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.
26
27
* Import ElementTree update patch.
28
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.
35
36
* Smart rewrap text in help messages to fit in $COLUMNS (or equivalent
37
on Windows)
38
39
* -r option should take a revision-id as well as a revno.
40
41
* ``bzr info`` could show space used by working tree, versioned files,
42
unknown and ignored files.
43
44
* ``bzr info`` should count only people with distinct email addresses as
45
different committers. (Or perhaps only distinct userids?)
46
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.
51
52
* ``bzr ignore`` command that just adds a line to the ``.bzrignore`` file
53
and makes it versioned. Fix this to break symlinks.
54
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
58
unquoted glob.
59
60
__ http://mail.python.org/pipermail/python-list/2001-April/037847.html
61
62
* Separate read and write version checks?
63
64
* ``bzr status DIR`` should give status on all files under that
65
directory.
66
67
* ``bzr log DIR`` should give changes to any files within DIR.
68
69
* Check all commands have decent help.
70
71
* ``bzr inventory -r REV`` and perhaps unify this with ``bzr ls``,
72
giving options to display ids, types, etc.
73
74
* Atomic file class that renames into place when it's closed.
75
76
* Don't abort if ``~/.bzr.log`` can't be used.
77
78
* Split BzrError into various more specific subclasses for different
79
errors people might want to catch.
80
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.)
84
85
http://www.gelato.unsw.edu.au/archives/git/0504/2194.html
86
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.
89
90
Should show the version from bzr and the path name.
91
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.
96
97
* Maybe also store directories in the statcache so that we can quickly
98
identify that they still exist.
99
100
101
Medium things
102
-------------
103
104
* Change command functions into Command() objects, like in hct, and
105
then the grammar can be described directly in there. Since all
106
option definitions are global we can define them just once and
107
reference them from each command.
108
109
* Selective commit of only some files.
110
111
* Merge Aaron's merge code.
112
113
* Merge revert patch.
114
115
* ``bzr mv`` that does either rename or move as in Unix.
116
117
* More efficient diff of only selected files. We should be able to
118
just get the id for the selected files, look up their location and
119
diff just those files. No need to traverse the entire inventories.
120
121
* ``bzr status DIR`` or ``bzr diff DIR`` should report on all changes
122
under that directory.
123
124
* Fix up Inventory objects to represent root object as an entry.
125
126
* Don't convert entire entry from
127
128
* Extract changes from one revision to the next to a text form
129
suitable for transmission over email.
130
131
* More test cases.
132
133
* Write a reproducible benchmark, perhaps importing various kernel versions.
134
135
* Change test.sh from Bourne shell into something in pure Python so
136
that it can be more portable.
137
138
* Directly import diffs! It seems a bit redundant to need to rescan
139
the directory to work out what files diff added/deleted/changed when
140
all the information is there in the diff in the first place.
141
Getting the exact behaviour for added/deleted subdirectories etc
142
might be hard.
143
144
At the very least we could run diffstat over the diff, or perhaps
145
read the status output from patch. Just knowing which files might
146
be modified would be enough to guide the add and commit.
147
148
Given this we might be able to import patches at 1/second or better.
149
150
* Get branch over http.
151
152
* Pull pure updates over http.
153
154
* revfile compression.
155
156
* Split inventory into per-directory files.
157
158
* Fix ignore file parsing:
159
160
- fnmatch is not the same as unix patterns
161
162
- perhaps add extended globs from rsh/rsync
163
164
- perhaps a pattern that matches only directories or non-directories
165
166
* Consider using Python logging library as well as/instead of
167
bzrlib.trace.
168
169
* Commands should give some progress indication by default.
170
171
- But quieten this with ``--silent``.
172
173
* Change to using gettext message localization.
174
175
* Make a clearer separation between internal and external bzrlib
176
interfaces. Make internal interfaces use protected names. Write at
177
least some documentation for those APIs, probably as docstrings.
178
179
Consider using ZopeInterface definitions for the external interface;
180
I think these are already used in PyBaz. They allow automatic
181
checking of the interface but may be unfamiliar to general Python
182
developers, so I'm not really keen.
183
184
* Commands to dump out all command help into a manpage or HTML file or
185
whatever.
186
187
* Handle symlinks in the working directory; at the very least it
188
should be possible for them to be present and ignored/unknown
189
without causing assertion failures.
190
191
Eventually symlinks should be versioned.
192
193
* Allow init in a subdirectory to create a nested repository, but only
194
if the subdirectory is not already versioned. Perhaps also require
195
a ``--nested`` to protect against confusion.
196
197
* Branch names?
198
199
* More test framework:
200
201
- Class that describes the state of a working tree so we can just
202
assert it's equal.
203
204
* There are too many methods on Branch() that really manipulate the
205
WorkingTree. They should be moved across.
206
207
Also there are some methods which are duplicated on Tree and
208
Inventory objects, and it should be made more clear which ones are
209
proxies and which ones behave differently, and how.
210
211
* Try using XSLT to add some formatting to REST-generated HTML. Or
212
maybe write a small Python program that specifies a header and foot
213
for the pages and calls into the docutils libraries.
214
215
* --format=xml for log, status and other commands.
216
217
* Attempting to explicitly add a file that's already added should give
218
a warning; however there should be no warning for directories (since
219
we scan for new children) or files encountered in a directory that's
220
being scanned.
221
222
* Better handling of possible collisions on case-losing filesystems;
223
make sure a single file does not get added twice under different
224
names.
225
226
* Clean up XML inventory:
227
228
- Use nesting rather than parent_id pointers.
229
230
- Hold the ElementTree in memory in the Inventory object and work
231
directly on that, rather than converting into Python objects every
232
time it is read in. Probably still exposoe it through some kind of
233
object interface though, but perhaps that should just be a proxy
234
for the elements.
235
236
- Less special cases for the root directory.
237
238
* Perhaps inventories should remember the revision in which each file
239
was last changed, as well as its current state? This is a bit
240
redundant but might often be interested to know.
241
242
* stat cache should perhaps only stat files as necessary, rather than
243
doing them all up-front. On the other hand, that disallows the
244
opimization of stating them in inode order.
245
246
* It'd be nice to pipeline multiple HTTP requests. Often we can
247
predict what will be wanted in future: all revisions, or all texts
248
in a particular revision, etc.
249
250
urlgrabber's docs say they are working on batched downloads; we
251
could perhaps ride on that or just create a background thread (ew).
252
253
* Should be a signature at the top of the cache file.
254
255
* Paranoid mode where we never trust SHA-1 matches.
256
257
258
Large things
259
------------
260
261
* Generate annotations from current file relative to previous
262
annotations.
263
264
- Is it necessary to store any kind of annotation where data was
265
deleted?
266
267
* Update revfile_ format and make it active:
268
269
- Texts should be identified by something keyed on the revision, not
270
an individual text-id. This is much more useful for annotate I
271
think; we want to map back to the revision that last changed it.
272
273
- Access revfile revisions through the Tree/Store classes.
274
275
- Check them from check commands.
276
277
- Store annotations.
278
279
.. _revfile: revfile.html
280
281
* Hooks for pre-commit, post-commit, etc.
282
283
Consider the security implications; probably should not enable hooks
284
for remotely-fetched branches by default.
285
286
* Pre-commit check. If this hook is defined, it needs to be handled
287
specially: create a temporary directory containing the tree as it
288
will be after the commit. This means excluding any ignored/unknown
289
files, and respecting selective commits. Run the pre-commit check
290
(e.g. compile and run test suite) in there.
291
292
* Web interface
293
294
* GUI (maybe in Python GTK+?)
295
296
* C library interface
297
298
* Expansion of $Id$ keywords within working files. Perhaps do this in
299
exports first as a simpler case because then we don't need to deal
300
with removing the tags on the way back in.
301
302
* ``bzr find``
Loggerhead is a web-based interface for Breezy
Version: 2.0.1