~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Martin Pool
  • Date: 2005-05-03 07:48:54 UTC
  • Revision ID: mbp@sourcefrog.net-20050503074854-adb6f9d6382e27a9
- sketchy experiments in bash and zsh completion

Show diffs side-by-side

added added

removed removed

Lines of Context:
24
24
  requires patching difflib to get it exactly right, or otherwise
25
25
  calling out to GNU diff.
26
26
 
 
27
* Import ElementTree update patch.
 
28
 
 
29
* Syntax should be ``bzr export -r REV``.
 
30
 
 
31
* Plugins that provide commands.  By just installing a file into some
 
32
  directory (e.g. ``/usr/share/bzr/plugins``) it should be possible to
 
33
  create new top-level commands (``bzr frob``).  Extensions can be
 
34
  written in either Python (in which case they use the bzrlib API) or
 
35
  in a separate process (in sh, C, whatever).   It should be possible
 
36
  to get help for plugin commands.
 
37
 
 
38
* Smart rewrap text in help messages to fit in $COLUMNS (or equivalent
 
39
  on Windows)
 
40
 
27
41
* -r option should take a revision-id as well as a revno.
28
42
 
 
43
* ``bzr info`` could show space used by working tree, versioned files,
 
44
  unknown and ignored files. 
 
45
 
29
46
* ``bzr info`` should count only people with distinct email addresses as
30
47
  different committers.  (Or perhaps only distinct userids?)
31
48
 
37
54
* ``bzr ignore`` command that just adds a line to the ``.bzrignore`` file
38
55
  and makes it versioned.  Fix this to break symlinks.
39
56
 
 
57
* ``bzr help commands`` should give a one-line summary of each command.
 
58
 
40
59
* Any useful sanity checks in 'bzr ignore'?  Perhaps give a warning if
41
60
  they try to add a single file which is already versioned, or if they
42
61
  add a pattern which already exists, or if it looks like they gave an
44
63
 
45
64
__ http://mail.python.org/pipermail/python-list/2001-April/037847.html
46
65
 
 
66
* Read and write locks on branch while it's open.
 
67
 
47
68
* Separate read and write version checks?
48
69
 
49
 
* ``bzr status DIR`` should give status on all files under that
50
 
  directory.
51
 
 
52
 
* ``bzr log DIR`` should give changes to any files within DIR.
 
70
* ``bzr status FILE...``
 
71
 
 
72
* Check all commands have decent help.
 
73
 
 
74
* Autogenerate argument/option help.
53
75
 
54
76
* ``bzr inventory -r REV`` and perhaps unify this with ``bzr ls``,
55
77
  giving options to display ids, types, etc.
56
78
 
57
 
* Split BzrError into various more specific subclasses for different
58
 
  errors people might want to catch.
59
 
 
60
 
* If the export destination ends in '.tar', '.tar.gz', etc then create
61
 
  a tarball instead of a directory.  (Need to actually make a
62
 
  temporary directory and then tar that up.)
63
 
 
64
 
  http://www.gelato.unsw.edu.au/archives/git/0504/2194.html
65
 
  
66
 
* RemoteBranch could maintain a cache either in memory or on disk.  We
67
 
  know more than an external cache might about which files are
68
 
  immutable and which can vary.  On the other hand, it's much simpler
69
 
  to just use an external proxy cache.
70
 
 
71
 
  Perhaps ~/.bzr/http-cache.  Baz has a fairly simple cache under
72
 
  ~/.arch-cache, containing revision information encoded almost as a
73
 
  bunch of archives.  Perhaps we could simply store full paths.
74
 
 
75
 
* Maybe also store directories in the statcache so that we can quickly
76
 
  identify that they still exist.
77
 
 
78
 
* Diff should show timestamps; for files from the working directory we
79
 
  can use the file itself; for files from a revision we should use the
80
 
  commit time of the revision.
81
 
 
82
 
* Perhaps split command infrastructure from the actual command
83
 
  definitions.
84
 
 
85
 
* Cleaner support for negative boolean options like --no-recurse.
86
 
 
87
 
* Statcache should possibly map all file paths to / separators
88
 
 
89
 
* quotefn doubles all backslashes on Windows; this is probably not the
90
 
  best thing to do.  What would be a better way to safely represent
91
 
  filenames?  Perhaps we could doublequote things containing spaces,
92
 
  on the principle that filenames containing quotes are unlikely?
93
 
  Nice for humans; less good for machine parsing.
94
 
 
95
 
* Patches should probably use only forward slashes, even on Windows,
96
 
  otherwise Unix patch can't apply them. (?) 
97
 
 
98
 
* Branch.update_revisions() inefficiently fetches revisions from the
99
 
  remote server twice; once to find out what text and inventory they
100
 
  need and then again to actually get the thing.  This is a bit
101
 
  inefficient. 
102
 
 
103
 
  One complicating factor here is that we don't really want to have
104
 
  revisions present in the revision-store until all their constituent
105
 
  parts are also stored.
106
 
 
107
 
  The basic problem is that RemoteBranch.get_revision() and similar
108
 
  methods return object, but what we really want is the raw XML, which
109
 
  can be popped into our own store.  That needs to be refactored.
110
 
 
111
 
* ``bzr status FOO`` where foo is ignored should say so.
112
 
 
113
 
* ``bzr mkdir A...`` should just create and add A.
114
 
  
 
79
* Atomic file class that renames into place when it's closed.
115
80
 
116
81
 
117
82
Medium things
118
83
-------------
119
84
 
 
85
* Display command grammar in help messages rather than hardcoding it.
 
86
 
 
87
* Change command functions into Command() objects, like in hct, and
 
88
  then the grammar can be described directly in there.  Since all
 
89
  option definitions are global we can define them just once and
 
90
  reference them from each command.
 
91
 
 
92
* Selective commit of only some files.
 
93
 
 
94
* Faster diff/status.  
 
95
 
 
96
  Status should be handled differently because it needs to report on
 
97
  deleted and unknown files.  diff only needs to deal with versioned
 
98
  files.
 
99
 
 
100
* Merge Aaron's merge code.
 
101
 
120
102
* Merge revert patch.
121
103
 
 
104
* Turn on stat cache code, and add optimization about avoiding
 
105
  dangerous cache entries.
 
106
 
122
107
* ``bzr mv`` that does either rename or move as in Unix.
123
108
 
124
 
* More efficient diff of only selected files.  We should be able to
125
 
  just get the id for the selected files, look up their location and
126
 
  diff just those files.  No need to traverse the entire inventories.
127
 
 
128
 
* ``bzr status DIR`` or ``bzr diff DIR`` should report on all changes
129
 
  under that directory.
 
109
* More efficient diff of only selected files.
130
110
 
131
111
* Fix up Inventory objects to represent root object as an entry.
132
112
 
133
 
* Don't convert entire entry from ElementTree to an object when it is
134
 
  read in, but rather wait until the program actually wants to know
135
 
  about that node.
 
113
* Don't convert entire entry from 
136
114
 
137
115
* Extract changes from one revision to the next to a text form
138
116
  suitable for transmission over email.
139
117
 
140
118
* More test cases.
141
119
 
142
 
  - Selected-file commit
143
 
 
144
 
  - Impossible selected-file commit: adding things in non-versioned
145
 
    directories, crossing renames, etc.
146
 
 
147
120
* Write a reproducible benchmark, perhaps importing various kernel versions.
148
121
 
 
122
* Change test.sh from Bourne shell into something in pure Python so
 
123
  that it can be more portable.
 
124
 
149
125
* Directly import diffs!  It seems a bit redundant to need to rescan
150
126
  the directory to work out what files diff added/deleted/changed when
151
127
  all the information is there in the diff in the first place.
177
153
* Consider using Python logging library as well as/instead of
178
154
  bzrlib.trace.
179
155
 
180
 
* Commands should give some progress indication by default.
181
 
 
182
 
  - But quieten this with ``--silent``.
183
 
 
184
156
* Change to using gettext message localization.
185
157
 
186
158
* Make a clearer separation between internal and external bzrlib
207
179
 
208
180
* Branch names? 
209
181
 
210
 
* More test framework:
211
 
 
212
 
  - Class that describes the state of a working tree so we can just
213
 
    assert it's equal.
214
 
 
215
 
* There are too many methods on Branch() that really manipulate the
216
 
  WorkingTree.  They should be moved across.  
217
 
 
218
 
  Also there are some methods which are duplicated on Tree and
219
 
  Inventory objects, and it should be made more clear which ones are
220
 
  proxies and which ones behave differently, and how.
221
 
 
222
 
* Try using XSLT to add some formatting to REST-generated HTML.  Or
223
 
  maybe write a small Python program that specifies a header and foot
224
 
  for the pages and calls into the docutils libraries.
225
 
 
226
 
* --format=xml for log, status and other commands.
227
 
 
228
 
* Attempting to explicitly add a file that's already added should give
229
 
  a warning; however there should be no warning for directories (since
230
 
  we scan for new children) or files encountered in a directory that's
231
 
  being scanned.
232
 
 
233
 
* Better handling of possible collisions on case-losing filesystems;
234
 
  make sure a single file does not get added twice under different
235
 
  names.
236
 
 
237
 
* Clean up XML inventory:
238
 
 
239
 
  - Use nesting rather than parent_id pointers.
240
 
 
241
 
  - Hold the ElementTree in memory in the Inventory object and work
242
 
    directly on that, rather than converting into Python objects every
243
 
    time it is read in.  Probably still exposoe it through some kind of
244
 
    object interface though, but perhaps that should just be a proxy
245
 
    for the elements.
246
 
 
247
 
  - Less special cases for the root directory. 
248
 
 
249
 
* Perhaps inventories should remember the revision in which each file
250
 
  was last changed, as well as its current state?  This is a bit
251
 
  redundant but might often be interested to know.
252
 
 
253
 
* stat cache should perhaps only stat files as necessary, rather than
254
 
  doing them all up-front.  On the other hand, that disallows the
255
 
  opimization of stating them in inode order.
256
 
 
257
 
* It'd be nice to pipeline multiple HTTP requests.  Often we can
258
 
  predict what will be wanted in future: all revisions, or all texts
259
 
  in a particular revision, etc.  
260
 
 
261
 
  urlgrabber's docs say they are working on batched downloads; we
262
 
  could perhaps ride on that or just create a background thread (ew).
263
 
 
264
 
* Paranoid mode where we never trust SHA-1 matches.
265
 
 
266
 
* Don't commit if there are no changes unless forced.
267
 
 
268
 
* --dry-run mode for commit?  (Or maybe just run with
269
 
  check-command=false?)
270
 
 
271
 
* Generally, be a bit more verbose unless --silent is specified.
272
 
 
273
 
* Function that finds all changes to files under a given directory;
274
 
  perhaps log should use this if a directory is given.
275
 
 
276
 
* XML attributes might have trouble with filenames containing \n and
277
 
  \r.  Do we really want to support this?  I think perhaps not.
278
 
 
279
 
* Remember execute bits, so that exports will work OK.
280
 
 
281
 
* Unify smart_add and plain Branch.add(); perhaps smart_add should
282
 
  just build a list of files to add and pass that to the regular add
283
 
  function.
284
 
 
285
 
* Function to list a directory, saying in which revision each file was
286
 
  last modified.  Useful for web and gui interfaces, and slow to
287
 
  compute one file at a time.
288
 
 
289
 
* unittest is standard, but the results are kind of ugly; would be
290
 
  nice to make it cleaner.
291
 
 
292
 
* Check locking is correct during merge-related operations.
293
 
 
294
 
* Perhaps attempts to get locks should timeout after some period of
295
 
  time, or at least display a progress message.
296
 
 
297
 
* Split out upgrade functionality from check command into a separate
298
 
  ``bzr upgrade``.
299
 
 
300
 
* Don't pass around command classes but rather pass objects.  This'd
301
 
  make it cleaner to construct objects wrapping external commands.
 
182
 
302
183
 
303
184
 
304
185
Large things
335
216
  files, and respecting selective commits.  Run the pre-commit check
336
217
  (e.g. compile and run test suite) in there.
337
218
 
338
 
  Possibly this should be done by splitting the commit function into
339
 
  several parts (under a single interface).  It is already rather
340
 
  large.  Decomposition:
341
 
 
342
 
   - find tree modifications and prepare in-memory inventory
343
 
 
344
 
   - export that inventory to a temporary directory
345
 
 
346
 
   - run the test in that temporary directory
347
 
 
348
 
   - if that succeeded, continue to actually finish the commit
349
 
 
350
 
  What should be done with the text of modified files while this is
351
 
  underway?  I don't think we want to count on holding them in memory
352
 
  and we can't trust the working files to stay in one place so I
353
 
  suppose we need to move them into the text store, or otherwise into
354
 
  a temporary directory.
355
 
 
356
 
  If the commit does not actually complete, we would rather the
357
 
  content was not left behind in the stores.  
358
 
 
359
219
* Web interface
360
220
 
361
221
* GUI (maybe in Python GTK+?)