~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Martin Pool
  • Date: 2005-05-06 03:20:15 UTC
  • Revision ID: mbp@sourcefrog.net-20050506032014-decf4918803147d2
- split out notes on storing annotations in revfiles

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
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
 
* quotefn doubles all backslashes on Windows; this is probably not the
107
 
  best thing to do.  What would be a better way to safely represent
108
 
  filenames?  Perhaps we could doublequote things containing spaces,
109
 
  on the principle that filenames containing quotes are unlikely?
110
 
  Nice for humans; less good for machine parsing.
111
 
 
112
 
* Patches should probably use only forward slashes, even on Windows,
113
 
  otherwise Unix patch can't apply them. (?) 
114
 
 
115
 
 
116
86
Medium things
117
87
-------------
118
88
 
 
89
* Display command grammar in help messages rather than hardcoding it.
 
90
 
 
91
* Change command functions into Command() objects, like in hct, and
 
92
  then the grammar can be described directly in there.  Since all
 
93
  option definitions are global we can define them just once and
 
94
  reference them from each command.
 
95
 
 
96
* Selective commit of only some files.
 
97
 
 
98
* Faster diff/status.  
 
99
 
 
100
  Status should be handled differently because it needs to report on
 
101
  deleted and unknown files.  diff only needs to deal with versioned
 
102
  files.
 
103
 
 
104
* Merge Aaron's merge code.
 
105
 
119
106
* Merge revert patch.
120
107
 
 
108
* Turn on stat cache code, and add optimization about avoiding
 
109
  dangerous cache entries.
 
110
 
121
111
* ``bzr mv`` that does either rename or move as in Unix.
122
112
 
123
 
* More efficient diff of only selected files.  We should be able to
124
 
  just get the id for the selected files, look up their location and
125
 
  diff just those files.  No need to traverse the entire inventories.
126
 
 
127
 
* ``bzr status DIR`` or ``bzr diff DIR`` should report on all changes
128
 
  under that directory.
 
113
* More efficient diff of only selected files.
129
114
 
130
115
* Fix up Inventory objects to represent root object as an entry.
131
116
 
132
 
* Don't convert entire entry from ElementTree to an object when it is
133
 
  read in, but rather wait until the program actually wants to know
134
 
  about that node.
 
117
* Don't convert entire entry from 
135
118
 
136
119
* Extract changes from one revision to the next to a text form
137
120
  suitable for transmission over email.
138
121
 
139
122
* More test cases.
140
123
 
141
 
  - Selected-file commit
142
 
 
143
 
  - Impossible selected-file commit: adding things in non-versioned
144
 
    directories, crossing renames, etc.
145
 
 
146
124
* Write a reproducible benchmark, perhaps importing various kernel versions.
147
125
 
 
126
* Change test.sh from Bourne shell into something in pure Python so
 
127
  that it can be more portable.
 
128
 
148
129
* Directly import diffs!  It seems a bit redundant to need to rescan
149
130
  the directory to work out what files diff added/deleted/changed when
150
131
  all the information is there in the diff in the first place.
239
220
 
240
221
  - Hold the ElementTree in memory in the Inventory object and work
241
222
    directly on that, rather than converting into Python objects every
242
 
    time it is read in.  Probably still exposoe it through some kind of
 
223
    time it is read in.  Probably still expose it through some kind of
243
224
    object interface though, but perhaps that should just be a proxy
244
225
    for the elements.
245
226
 
249
230
  was last changed, as well as its current state?  This is a bit
250
231
  redundant but might often be interested to know.
251
232
 
252
 
* stat cache should perhaps only stat files as necessary, rather than
253
 
  doing them all up-front.  On the other hand, that disallows the
254
 
  opimization of stating them in inode order.
255
 
 
256
 
* It'd be nice to pipeline multiple HTTP requests.  Often we can
257
 
  predict what will be wanted in future: all revisions, or all texts
258
 
  in a particular revision, etc.  
259
 
 
260
 
  urlgrabber's docs say they are working on batched downloads; we
261
 
  could perhaps ride on that or just create a background thread (ew).
262
 
 
263
 
* Paranoid mode where we never trust SHA-1 matches.
264
 
 
265
 
* Don't commit if there are no changes unless forced.
266
 
 
267
 
* --dry-run mode for commit?  (Or maybe just run with
268
 
  check-command=false?)
269
 
 
270
 
* Generally, be a bit more verbose unless --silent is specified.
271
 
 
272
 
* Function that finds all changes to files under a given directory;
273
 
  perhaps log should use this if a directory is given.
274
 
 
275
 
* XML attributes might have trouble with filenames containing \n and
276
 
  \r.  Do we really want to support this?  I think perhaps not.
277
 
 
278
 
* Remember execute bits, so that exports will work OK.
279
 
 
280
 
* Unify smart_add and plain Branch.add(); perhaps smart_add should
281
 
  just build a list of files to add and pass that to the regular add
282
 
  function.
283
 
 
284
 
* Function to list a directory, saying in which revision each file was
285
 
  last modified.  Useful for web and gui interfaces, and slow to
286
 
  compute one file at a time.
287
 
 
288
 
* unittest is standard, but the results are kind of ugly; would be
289
 
  nice to make it cleaner.
290
 
 
291
 
* Check locking is correct during merge-related operations.
292
 
 
293
 
* Perhaps attempts to get locks should timeout after some period of
294
 
  time, or at least display a progress message.
295
 
 
296
233
 
297
234
Large things
298
235
------------
328
265
  files, and respecting selective commits.  Run the pre-commit check
329
266
  (e.g. compile and run test suite) in there.
330
267
 
331
 
  Possibly this should be done by splitting the commit function into
332
 
  several parts (under a single interface).  It is already rather
333
 
  large.  Decomposition:
334
 
 
335
 
   - find tree modifications and prepare in-memory inventory
336
 
 
337
 
   - export that inventory to a temporary directory
338
 
 
339
 
   - run the test in that temporary directory
340
 
 
341
 
   - if that succeeded, continue to actually finish the commit
342
 
 
343
 
  What should be done with the text of modified files while this is
344
 
  underway?  I don't think we want to count on holding them in memory
345
 
  and we can't trust the working files to stay in one place so I
346
 
  suppose we need to move them into the text store, or otherwise into
347
 
  a temporary directory.
348
 
 
349
 
  If the commit does not actually complete, we would rather the
350
 
  content was not left behind in the stores.  
351
 
 
352
268
* Web interface
353
269
 
354
270
* GUI (maybe in Python GTK+?)