← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Martin Pool
  • Date: 2005-06-28 03:02:31 UTC
  • Revision ID: mbp@sourcefrog.net-20050628030231-d311e4ebcd467ef4
Merge John's import-speedup branch:

                                                                                         
  777 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 22:20:32 -0500
      revision-id: john@arbash-meinel.com-20050627032031-e82a50db3863b18e
      bzr selftest was not using the correct bzr

  776 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 22:20:22 -0500
      revision-id: john@arbash-meinel.com-20050627032021-c9f21fde989ddaee
      Add was using an old mutter

  775 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 22:02:33 -0500
      revision-id: john@arbash-meinel.com-20050627030233-9165cfe98fc63298
      Cleaned up to be less different

  774 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 21:54:53 -0500
      revision-id: john@arbash-meinel.com-20050627025452-4260d0e744edef43
      Allow BZR_PLUGIN_PATH='' to negate plugin loading.

  773 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 21:49:34 -0500
      revision-id: john@arbash-meinel.com-20050627024933-b7158f67b7b9eae5
      Finished the previous cleanup (allowing load_plugins to be called twice)

  772 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 21:45:08 -0500
      revision-id: john@arbash-meinel.com-20050627024508-723b1df510d196fc
      Work on making the tests pass. versioning.py is calling run_cmd directly, but plugins have been loaded.

  771 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 21:32:29 -0500
      revision-id: john@arbash-meinel.com-20050627023228-79972744d7c53e15
      Got it down a little bit more by removing import of tree and inventory.

  770 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 21:26:05 -0500
      revision-id: john@arbash-meinel.com-20050627022604-350b9773ef622f95
      Reducing the number of import from bzrlib/__init__.py and bzrlib/branch.py

  769 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 20:32:25 -0500
      revision-id: john@arbash-meinel.com-20050627013225-32dd044f10d23948
      Updated revision.py and xml.py to include SubElement.

  768 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 20:03:56 -0500
      revision-id: john@arbash-meinel.com-20050627010356-ee66919e1c377faf
      Minor typo

  767 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 20:03:13 -0500
      revision-id: john@arbash-meinel.com-20050627010312-40d024007eb85051
      Caching the import

  766 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 19:51:47 -0500
      revision-id: john@arbash-meinel.com-20050627005147-5281c99e48ed1834
      Created wrapper functions for lazy import of ElementTree

  765 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 19:46:37 -0500
      revision-id: john@arbash-meinel.com-20050627004636-bf432902004a94c5
      Removed all of the test imports of cElementTree

  764 John Arbash Meinel <john@arbash-meinel.com>       Sun 2005-06-26 19:43:59 -0500
      revision-id: john@arbash-meinel.com-20050627004358-d137fbe9570dd71b
      Trying to make bzr startup faster.

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
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
 
* 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
27
* -r option should take a revision-id as well as a revno.
40
28
 
41
 
* ``bzr info`` could show space used by working tree, versioned files,
42
 
  unknown and ignored files. 
43
 
 
44
29
* ``bzr info`` should count only people with distinct email addresses as
45
30
  different committers.  (Or perhaps only distinct userids?)
46
31
 
59
44
 
60
45
__ http://mail.python.org/pipermail/python-list/2001-April/037847.html
61
46
 
62
 
* Read and write locks on branch while it's open.
63
 
 
64
47
* Separate read and write version checks?
65
48
 
66
 
* ``bzr status FILE...``
 
49
* ``bzr status DIR`` should give status on all files under that
 
50
  directory.
67
51
 
68
 
* Check all commands have decent help.
 
52
* ``bzr log DIR`` should give changes to any files within DIR.
69
53
 
70
54
* ``bzr inventory -r REV`` and perhaps unify this with ``bzr ls``,
71
55
  giving options to display ids, types, etc.
72
56
 
73
 
* Atomic file class that renames into place when it's closed.
74
 
 
75
 
* Don't abort if ``~/.bzr.log`` can't be used.
76
 
 
77
57
* Split BzrError into various more specific subclasses for different
78
58
  errors people might want to catch.
79
59
 
83
63
 
84
64
  http://www.gelato.unsw.edu.au/archives/git/0504/2194.html
85
65
  
86
 
* testbzr should by default test the bzr binary in the same directory
87
 
  as the testbzr script, or take a path to it as a first parameter.
88
 
 
89
 
  Should show the version from bzr and the path name.
 
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
  
 
115
 
90
116
 
91
117
Medium things
92
118
-------------
93
119
 
94
 
* Display command grammar in help messages rather than hardcoding it.
95
 
 
96
 
* Change command functions into Command() objects, like in hct, and
97
 
  then the grammar can be described directly in there.  Since all
98
 
  option definitions are global we can define them just once and
99
 
  reference them from each command.
100
 
 
101
 
* Selective commit of only some files.
102
 
 
103
 
* Faster diff/status.  
104
 
 
105
 
  Status should be handled differently because it needs to report on
106
 
  deleted and unknown files.  diff only needs to deal with versioned
107
 
  files.
108
 
 
109
 
* Merge Aaron's merge code.
110
 
 
111
120
* Merge revert patch.
112
121
 
113
 
* Turn on stat cache code, and add optimization about avoiding
114
 
  dangerous cache entries.
115
 
 
116
122
* ``bzr mv`` that does either rename or move as in Unix.
117
123
 
118
 
* More efficient diff of only selected files.
 
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.
119
130
 
120
131
* Fix up Inventory objects to represent root object as an entry.
121
132
 
122
 
* Don't convert entire entry from 
 
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.
123
136
 
124
137
* Extract changes from one revision to the next to a text form
125
138
  suitable for transmission over email.
126
139
 
127
140
* More test cases.
128
141
 
 
142
  - Selected-file commit
 
143
 
 
144
  - Impossible selected-file commit: adding things in non-versioned
 
145
    directories, crossing renames, etc.
 
146
 
129
147
* Write a reproducible benchmark, perhaps importing various kernel versions.
130
148
 
131
 
* Change test.sh from Bourne shell into something in pure Python so
132
 
  that it can be more portable.
133
 
 
134
149
* Directly import diffs!  It seems a bit redundant to need to rescan
135
150
  the directory to work out what files diff added/deleted/changed when
136
151
  all the information is there in the diff in the first place.
225
240
 
226
241
  - Hold the ElementTree in memory in the Inventory object and work
227
242
    directly on that, rather than converting into Python objects every
228
 
    time it is read in.  Probably still expose it through some kind of
 
243
    time it is read in.  Probably still exposoe it through some kind of
229
244
    object interface though, but perhaps that should just be a proxy
230
245
    for the elements.
231
246
 
235
250
  was last changed, as well as its current state?  This is a bit
236
251
  redundant but might often be interested to know.
237
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.
 
302
 
238
303
 
239
304
Large things
240
305
------------
270
335
  files, and respecting selective commits.  Run the pre-commit check
271
336
  (e.g. compile and run test suite) in there.
272
337
 
 
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
 
273
359
* Web interface
274
360
 
275
361
* GUI (maybe in Python GTK+?)