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