« back to all changes in this revision
Viewing changes to TODO
- browse files at revision 572
- compare with another revision
- download diff
- download tarball
- view history from revision 572
- Committer: Martin Pool
- Date: 2005-05-27 03:44:32 UTC
- Revision ID: mbp@sourcefrog.net-20050527034432-647e59832d01909f
- trim imports
- files added:
- .rsyncexclude
- contrib
- contrib/bash
- contrib/zsh
- elementtree
- patches
- urlgrabber
- files removed:
- bzrlib/tests.py
- 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
* Split BzrError into various more specific subclasses for different
75
errors people might want to catch.
76
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.)
80
81
http://www.gelato.unsw.edu.au/archives/git/0504/2194.html
82
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.
87
88
* Maybe also store directories in the statcache so that we can quickly
89
identify that they still exist.
90
91
* Diff should show timestamps; for files from the working directory we
92
can use the file itself; for files from a revision we should use the
93
commit time of the revision.
94
95
96
Medium things
97
-------------
98
99
* Merge revert patch.
100
101
* ``bzr mv`` that does either rename or move as in Unix.
102
103
* More efficient diff of only selected files. We should be able to
104
just get the id for the selected files, look up their location and
105
diff just those files. No need to traverse the entire inventories.
106
107
* ``bzr status DIR`` or ``bzr diff DIR`` should report on all changes
108
under that directory.
109
110
* Fix up Inventory objects to represent root object as an entry.
111
112
* Don't convert entire entry from ElementTree to an object when it is
113
read in, but rather wait until the program actually wants to know
114
about that node.
115
116
* Extract changes from one revision to the next to a text form
117
suitable for transmission over email.
118
119
* More test cases.
120
121
- Selected-file commit
122
123
- Impossible selected-file commit: adding things in non-versioned
124
directories, crossing renames, etc.
125
126
* Write a reproducible benchmark, perhaps importing various kernel versions.
127
128
* Directly import diffs! It seems a bit redundant to need to rescan
129
the directory to work out what files diff added/deleted/changed when
130
all the information is there in the diff in the first place.
131
Getting the exact behaviour for added/deleted subdirectories etc
132
might be hard.
133
134
At the very least we could run diffstat over the diff, or perhaps
135
read the status output from patch. Just knowing which files might
136
be modified would be enough to guide the add and commit.
137
138
Given this we might be able to import patches at 1/second or better.
139
140
* Get branch over http.
141
142
* Pull pure updates over http.
143
144
* revfile compression.
145
146
* Split inventory into per-directory files.
147
148
* Fix ignore file parsing:
149
150
- fnmatch is not the same as unix patterns
151
152
- perhaps add extended globs from rsh/rsync
153
154
- perhaps a pattern that matches only directories or non-directories
155
156
* Consider using Python logging library as well as/instead of
157
bzrlib.trace.
158
159
* Commands should give some progress indication by default.
160
161
- But quieten this with ``--silent``.
162
163
* Change to using gettext message localization.
164
165
* Make a clearer separation between internal and external bzrlib
166
interfaces. Make internal interfaces use protected names. Write at
167
least some documentation for those APIs, probably as docstrings.
168
169
Consider using ZopeInterface definitions for the external interface;
170
I think these are already used in PyBaz. They allow automatic
171
checking of the interface but may be unfamiliar to general Python
172
developers, so I'm not really keen.
173
174
* Commands to dump out all command help into a manpage or HTML file or
175
whatever.
176
177
* Handle symlinks in the working directory; at the very least it
178
should be possible for them to be present and ignored/unknown
179
without causing assertion failures.
180
181
Eventually symlinks should be versioned.
182
183
* Allow init in a subdirectory to create a nested repository, but only
184
if the subdirectory is not already versioned. Perhaps also require
185
a ``--nested`` to protect against confusion.
186
187
* Branch names?
188
189
* More test framework:
190
191
- Class that describes the state of a working tree so we can just
192
assert it's equal.
193
194
* There are too many methods on Branch() that really manipulate the
195
WorkingTree. They should be moved across.
196
197
Also there are some methods which are duplicated on Tree and
198
Inventory objects, and it should be made more clear which ones are
199
proxies and which ones behave differently, and how.
200
201
* Try using XSLT to add some formatting to REST-generated HTML. Or
202
maybe write a small Python program that specifies a header and foot
203
for the pages and calls into the docutils libraries.
204
205
* --format=xml for log, status and other commands.
206
207
* Attempting to explicitly add a file that's already added should give
208
a warning; however there should be no warning for directories (since
209
we scan for new children) or files encountered in a directory that's
210
being scanned.
211
212
* Better handling of possible collisions on case-losing filesystems;
213
make sure a single file does not get added twice under different
214
names.
215
216
* Clean up XML inventory:
217
218
- Use nesting rather than parent_id pointers.
219
220
- Hold the ElementTree in memory in the Inventory object and work
221
directly on that, rather than converting into Python objects every
222
time it is read in. Probably still exposoe it through some kind of
223
object interface though, but perhaps that should just be a proxy
224
for the elements.
225
226
- Less special cases for the root directory.
227
228
* Perhaps inventories should remember the revision in which each file
229
was last changed, as well as its current state? This is a bit
230
redundant but might often be interested to know.
231
232
* stat cache should perhaps only stat files as necessary, rather than
233
doing them all up-front. On the other hand, that disallows the
234
opimization of stating them in inode order.
235
236
* It'd be nice to pipeline multiple HTTP requests. Often we can
237
predict what will be wanted in future: all revisions, or all texts
238
in a particular revision, etc.
239
240
urlgrabber's docs say they are working on batched downloads; we
241
could perhaps ride on that or just create a background thread (ew).
242
243
* Paranoid mode where we never trust SHA-1 matches.
244
245
* Don't commit if there are no changes unless forced.
246
247
* --dry-run mode for commit? (Or maybe just run with
248
check-command=false?)
249
250
* Generally, be a bit more verbose unless --silent is specified.
251
252
* Function that finds all changes to files under a given directory;
253
perhaps log should use this if a directory is given.
254
255
* XML attributes might have trouble with filenames containing \n and
256
\r. Do we really want to support this? I think perhaps not.
257
258
259
Large things
260
------------
261
262
* Generate annotations from current file relative to previous
263
annotations.
264
265
- Is it necessary to store any kind of annotation where data was
266
deleted?
267
268
* Update revfile_ format and make it active:
269
270
- Texts should be identified by something keyed on the revision, not
271
an individual text-id. This is much more useful for annotate I
272
think; we want to map back to the revision that last changed it.
273
274
- Access revfile revisions through the Tree/Store classes.
275
276
- Check them from check commands.
277
278
- Store annotations.
279
280
.. _revfile: revfile.html
281
282
* Hooks for pre-commit, post-commit, etc.
283
284
Consider the security implications; probably should not enable hooks
285
for remotely-fetched branches by default.
286
287
* Pre-commit check. If this hook is defined, it needs to be handled
288
specially: create a temporary directory containing the tree as it
289
will be after the commit. This means excluding any ignored/unknown
290
files, and respecting selective commits. Run the pre-commit check
291
(e.g. compile and run test suite) in there.
292
293
Possibly this should be done by splitting the commit function into
294
several parts (under a single interface). It is already rather
295
large. Decomposition:
296
297
- find tree modifications and prepare in-memory inventory
298
299
- export that inventory to a temporary directory
300
301
- run the test in that temporary directory
302
303
- if that succeeded, continue to actually finish the commit
304
305
What should be done with the text of modified files while this is
306
underway? I don't think we want to count on holding them in memory
307
and we can't trust the working files to stay in one place so I
308
suppose we need to move them into the text store, or otherwise into
309
a temporary directory.
310
311
If the commit does not actually complete, we would rather the
312
content was not left behind in the stores.
313
314
* Web interface
315
316
* GUI (maybe in Python GTK+?)
317
318
* C library interface
319
320
* Expansion of $Id$ keywords within working files. Perhaps do this in
321
exports first as a simpler case because then we don't need to deal
322
with removing the tags on the way back in.
323
324
* ``bzr find``
Loggerhead is a web-based interface for Breezy
Version: 2.0.1