~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Martin Pool
  • Date: 2005-06-06 05:55:19 UTC
  • Revision ID: mbp@sourcefrog.net-20050606055519-2fa201b47cefec08
- fix permissions on exported tar/zip files

Show diffs side-by-side

added added

removed removed

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