← 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-05-09 01:23:17 UTC
  • Revision ID: mbp@sourcefrog.net-20050509012317-a503ae2eed842146
- doc: please run tests after installation

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
26
26
 
27
27
* Import ElementTree update patch.
28
28
 
 
29
* Syntax should be ``bzr export -r REV``.
 
30
 
29
31
* Plugins that provide commands.  By just installing a file into some
30
32
  directory (e.g. ``/usr/share/bzr/plugins``) it should be possible to
31
33
  create new top-level commands (``bzr frob``).  Extensions can be
52
54
* ``bzr ignore`` command that just adds a line to the ``.bzrignore`` file
53
55
  and makes it versioned.  Fix this to break symlinks.
54
56
 
 
57
* ``bzr help commands`` should give a one-line summary of each command.
 
58
 
55
59
* Any useful sanity checks in 'bzr ignore'?  Perhaps give a warning if
56
60
  they try to add a single file which is already versioned, or if they
57
61
  add a pattern which already exists, or if it looks like they gave an
59
63
 
60
64
__ http://mail.python.org/pipermail/python-list/2001-April/037847.html
61
65
 
 
66
* Read and write locks on branch while it's open.
 
67
 
62
68
* Separate read and write version checks?
63
69
 
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.
 
70
* ``bzr status FILE...``
68
71
 
69
72
* Check all commands have decent help.
70
73
 
 
74
* Autogenerate argument/option help.
 
75
 
71
76
* ``bzr inventory -r REV`` and perhaps unify this with ``bzr ls``,
72
77
  giving options to display ids, types, etc.
73
78
 
 
79
* Atomic file class that renames into place when it's closed.
 
80
 
 
81
* Don't abort if ``~/.bzr.log`` can't be used.
 
82
 
74
83
* Split BzrError into various more specific subclasses for different
75
84
  errors people might want to catch.
76
85
 
80
89
 
81
90
  http://www.gelato.unsw.edu.au/archives/git/0504/2194.html
82
91
  
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
 
 
 
92
* testbzr should by default test the bzr binary in the same directory
 
93
  as the testbzr script, or take a path to it as a first parameter.
 
94
 
 
95
  Should show the version from bzr and the path name.
104
96
 
105
97
Medium things
106
98
-------------
107
99
 
 
100
* Display command grammar in help messages rather than hardcoding it.
 
101
 
 
102
* Change command functions into Command() objects, like in hct, and
 
103
  then the grammar can be described directly in there.  Since all
 
104
  option definitions are global we can define them just once and
 
105
  reference them from each command.
 
106
 
 
107
* Selective commit of only some files.
 
108
 
 
109
* Faster diff/status.  
 
110
 
 
111
  Status should be handled differently because it needs to report on
 
112
  deleted and unknown files.  diff only needs to deal with versioned
 
113
  files.
 
114
 
 
115
* Merge Aaron's merge code.
 
116
 
108
117
* Merge revert patch.
109
118
 
 
119
* Turn on stat cache code, and add optimization about avoiding
 
120
  dangerous cache entries.
 
121
 
110
122
* ``bzr mv`` that does either rename or move as in Unix.
111
123
 
112
 
* More efficient diff of only selected files.  We should be able to
113
 
  just get the id for the selected files, look up their location and
114
 
  diff just those files.  No need to traverse the entire inventories.
115
 
 
116
 
* ``bzr status DIR`` or ``bzr diff DIR`` should report on all changes
117
 
  under that directory.
 
124
* More efficient diff of only selected files.
118
125
 
119
126
* Fix up Inventory objects to represent root object as an entry.
120
127
 
121
 
* Don't convert entire entry from ElementTree to an object when it is
122
 
  read in, but rather wait until the program actually wants to know
123
 
  about that node.
 
128
* Don't convert entire entry from 
124
129
 
125
130
* Extract changes from one revision to the next to a text form
126
131
  suitable for transmission over email.
127
132
 
128
133
* More test cases.
129
134
 
130
 
  - Selected-file commit
131
 
 
132
 
  - Impossible selected-file commit: adding things in non-versioned
133
 
    directories, crossing renames, etc.
134
 
 
135
135
* Write a reproducible benchmark, perhaps importing various kernel versions.
136
136
 
 
137
* Change test.sh from Bourne shell into something in pure Python so
 
138
  that it can be more portable.
 
139
 
137
140
* Directly import diffs!  It seems a bit redundant to need to rescan
138
141
  the directory to work out what files diff added/deleted/changed when
139
142
  all the information is there in the diff in the first place.
228
231
 
229
232
  - Hold the ElementTree in memory in the Inventory object and work
230
233
    directly on that, rather than converting into Python objects every
231
 
    time it is read in.  Probably still exposoe it through some kind of
 
234
    time it is read in.  Probably still expose it through some kind of
232
235
    object interface though, but perhaps that should just be a proxy
233
236
    for the elements.
234
237
 
238
241
  was last changed, as well as its current state?  This is a bit
239
242
  redundant but might often be interested to know.
240
243
 
241
 
* stat cache should perhaps only stat files as necessary, rather than
242
 
  doing them all up-front.  On the other hand, that disallows the
243
 
  opimization of stating them in inode order.
244
 
 
245
 
* It'd be nice to pipeline multiple HTTP requests.  Often we can
246
 
  predict what will be wanted in future: all revisions, or all texts
247
 
  in a particular revision, etc.  
248
 
 
249
 
  urlgrabber's docs say they are working on batched downloads; we
250
 
  could perhaps ride on that or just create a background thread (ew).
251
 
 
252
 
* Paranoid mode where we never trust SHA-1 matches.
253
 
 
254
 
* Don't commit if there are no changes unless forced.
255
 
 
256
 
* --dry-run mode for commit?  (Or maybe just run with
257
 
  check-command=false?)
258
 
 
259
 
* Generally, be a bit more verbose unless --silent is specified.
260
 
 
261
 
* Function that finds all changes to files under a given directory;
262
 
  perhaps log should use this if a directory is given.
263
 
 
264
 
* XML attributes might have trouble with filenames containing \n and
265
 
  \r.  Do we really want to support this?  I think perhaps not.
266
 
 
267
 
* Remember execute bits, so that exports will work OK.
268
 
 
269
 
* Unify smart_add and plain Branch.add(); perhaps smart_add should
270
 
  just build a list of files to add and pass that to the regular add
271
 
  function.
272
 
 
273
244
 
274
245
Large things
275
246
------------
305
276
  files, and respecting selective commits.  Run the pre-commit check
306
277
  (e.g. compile and run test suite) in there.
307
278
 
308
 
  Possibly this should be done by splitting the commit function into
309
 
  several parts (under a single interface).  It is already rather
310
 
  large.  Decomposition:
311
 
 
312
 
   - find tree modifications and prepare in-memory inventory
313
 
 
314
 
   - export that inventory to a temporary directory
315
 
 
316
 
   - run the test in that temporary directory
317
 
 
318
 
   - if that succeeded, continue to actually finish the commit
319
 
 
320
 
  What should be done with the text of modified files while this is
321
 
  underway?  I don't think we want to count on holding them in memory
322
 
  and we can't trust the working files to stay in one place so I
323
 
  suppose we need to move them into the text store, or otherwise into
324
 
  a temporary directory.
325
 
 
326
 
  If the commit does not actually complete, we would rather the
327
 
  content was not left behind in the stores.  
328
 
 
329
279
* Web interface
330
280
 
331
281
* GUI (maybe in Python GTK+?)