~bzr-pqm/bzr/bzr.dev

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