~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Andrew Bennetts
  • Date: 2010-10-13 00:26:41 UTC
  • mto: This revision was merged to the branch mainline in revision 5498.
  • Revision ID: andrew.bennetts@canonical.com-20101013002641-9tlh9k89mlj1666m
Keep docs-plain working.

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