~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Martin Pool
  • Date: 2005-05-03 01:42:13 UTC
  • Revision ID: mbp@sourcefrog.net-20050503014213-eb676005cd01c3af
todo

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
49
51
  commands where this shouldn't be done, such as 'bzr ignore', because
50
52
  we want to accept globs.
51
53
 
52
 
* ``bzr ignore`` command that just adds a line to the ``.bzrignore`` file
53
 
  and makes it versioned.  Fix this to break symlinks.
 
54
* 'bzr ignore' command that just adds a line to the .bzrignore file
 
55
  and makes it versioned.
 
56
 
 
57
* 'bzr help commands' should give a one-line summary of each command.
54
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
59
63
 
60
64
__ http://mail.python.org/pipermail/python-list/2001-April/037847.html
61
65
 
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
 
* Split BzrError into various more specific subclasses for different
75
 
  errors people might want to catch.
76
 
 
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
 
* Branch.update_revisions() inefficiently fetches revisions from the
116
 
  remote server twice; once to find out what text and inventory they
117
 
  need and then again to actually get the thing.  This is a bit
118
 
  inefficient. 
119
 
 
120
 
  One complicating factor here is that we don't really want to have
121
 
  revisions present in the revision-store until all their constituent
122
 
  parts are also stored.
123
 
 
124
 
  The basic problem is that RemoteBranch.get_revision() and similar
125
 
  methods return object, but what we really want is the raw XML, which
126
 
  can be popped into our own store.  That needs to be refactored.
127
 
 
128
 
* ``bzr status FOO`` where foo is ignored should say so.
129
 
 
130
 
* ``bzr mkdir A...`` should just create and add A.
131
 
  
132
66
 
133
67
 
134
68
Medium things
135
69
-------------
136
70
 
 
71
* Display command grammar in help messages rather than hardcoding it.
 
72
 
 
73
* Change command functions into Command() objects, like in hct, and
 
74
  then the grammar can be described directly in there.  Since all
 
75
  option definitions are global we can define them just once and
 
76
  reference them from each command.
 
77
 
 
78
* Selective commit of only some files.
 
79
 
 
80
* Faster diff/status.  
 
81
 
 
82
  Status should be handled differently because it needs to report on
 
83
  deleted and unknown files.  diff only needs to deal with versioned
 
84
  files.
 
85
 
 
86
* Merge Aaron's merge code.
 
87
 
137
88
* Merge revert patch.
138
89
 
139
 
* ``bzr mv`` that does either rename or move as in Unix.
140
 
 
141
 
* More efficient diff of only selected files.  We should be able to
142
 
  just get the id for the selected files, look up their location and
143
 
  diff just those files.  No need to traverse the entire inventories.
144
 
 
145
 
* ``bzr status DIR`` or ``bzr diff DIR`` should report on all changes
146
 
  under that directory.
 
90
* Turn on stat cache code, and add optimization about avoiding
 
91
  dangerous cache entries.
 
92
 
 
93
* mv command?
 
94
 
 
95
* More efficient diff of only selected files.
147
96
 
148
97
* Fix up Inventory objects to represent root object as an entry.
149
98
 
150
 
* Don't convert entire entry from ElementTree to an object when it is
151
 
  read in, but rather wait until the program actually wants to know
152
 
  about that node.
 
99
* Don't convert entire entry from 
153
100
 
154
101
* Extract changes from one revision to the next to a text form
155
102
  suitable for transmission over email.
156
103
 
157
104
* More test cases.
158
105
 
159
 
  - Selected-file commit
160
 
 
161
 
  - Impossible selected-file commit: adding things in non-versioned
162
 
    directories, crossing renames, etc.
163
 
 
164
106
* Write a reproducible benchmark, perhaps importing various kernel versions.
165
107
 
 
108
* Change test.sh from Bourne shell into something in pure Python so
 
109
  that it can be more portable.
 
110
 
166
111
* Directly import diffs!  It seems a bit redundant to need to rescan
167
112
  the directory to work out what files diff added/deleted/changed when
168
113
  all the information is there in the diff in the first place.
194
139
* Consider using Python logging library as well as/instead of
195
140
  bzrlib.trace.
196
141
 
197
 
* Commands should give some progress indication by default.
198
 
 
199
 
  - But quieten this with ``--silent``.
200
 
 
201
142
* Change to using gettext message localization.
202
143
 
203
144
* Make a clearer separation between internal and external bzrlib
218
159
 
219
160
  Eventually symlinks should be versioned.
220
161
 
221
 
* Allow init in a subdirectory to create a nested repository, but only
222
 
  if the subdirectory is not already versioned.   Perhaps also require
223
 
  a ``--nested`` to protect against confusion.
224
 
 
225
 
* Branch names? 
226
 
 
227
 
* More test framework:
228
 
 
229
 
  - Class that describes the state of a working tree so we can just
230
 
    assert it's equal.
231
 
 
232
 
* There are too many methods on Branch() that really manipulate the
233
 
  WorkingTree.  They should be moved across.  
234
 
 
235
 
  Also there are some methods which are duplicated on Tree and
236
 
  Inventory objects, and it should be made more clear which ones are
237
 
  proxies and which ones behave differently, and how.
238
 
 
239
 
* Try using XSLT to add some formatting to REST-generated HTML.  Or
240
 
  maybe write a small Python program that specifies a header and foot
241
 
  for the pages and calls into the docutils libraries.
242
 
 
243
 
* --format=xml for log, status and other commands.
244
 
 
245
 
* Attempting to explicitly add a file that's already added should give
246
 
  a warning; however there should be no warning for directories (since
247
 
  we scan for new children) or files encountered in a directory that's
248
 
  being scanned.
249
 
 
250
 
* Better handling of possible collisions on case-losing filesystems;
251
 
  make sure a single file does not get added twice under different
252
 
  names.
253
 
 
254
 
* Clean up XML inventory:
255
 
 
256
 
  - Use nesting rather than parent_id pointers.
257
 
 
258
 
  - Hold the ElementTree in memory in the Inventory object and work
259
 
    directly on that, rather than converting into Python objects every
260
 
    time it is read in.  Probably still exposoe it through some kind of
261
 
    object interface though, but perhaps that should just be a proxy
262
 
    for the elements.
263
 
 
264
 
  - Less special cases for the root directory. 
265
 
 
266
 
* Perhaps inventories should remember the revision in which each file
267
 
  was last changed, as well as its current state?  This is a bit
268
 
  redundant but might often be interested to know.
269
 
 
270
 
* stat cache should perhaps only stat files as necessary, rather than
271
 
  doing them all up-front.  On the other hand, that disallows the
272
 
  opimization of stating them in inode order.
273
 
 
274
 
* It'd be nice to pipeline multiple HTTP requests.  Often we can
275
 
  predict what will be wanted in future: all revisions, or all texts
276
 
  in a particular revision, etc.  
277
 
 
278
 
  urlgrabber's docs say they are working on batched downloads; we
279
 
  could perhaps ride on that or just create a background thread (ew).
280
 
 
281
 
* Paranoid mode where we never trust SHA-1 matches.
282
 
 
283
 
* Don't commit if there are no changes unless forced.
284
 
 
285
 
* --dry-run mode for commit?  (Or maybe just run with
286
 
  check-command=false?)
287
 
 
288
 
* Generally, be a bit more verbose unless --silent is specified.
289
 
 
290
 
* Function that finds all changes to files under a given directory;
291
 
  perhaps log should use this if a directory is given.
292
 
 
293
 
* XML attributes might have trouble with filenames containing \n and
294
 
  \r.  Do we really want to support this?  I think perhaps not.
295
 
 
296
 
* Remember execute bits, so that exports will work OK.
297
 
 
298
 
* Unify smart_add and plain Branch.add(); perhaps smart_add should
299
 
  just build a list of files to add and pass that to the regular add
300
 
  function.
301
 
 
302
 
* Function to list a directory, saying in which revision each file was
303
 
  last modified.  Useful for web and gui interfaces, and slow to
304
 
  compute one file at a time.
305
 
 
306
 
* unittest is standard, but the results are kind of ugly; would be
307
 
  nice to make it cleaner.
308
 
 
309
 
* Check locking is correct during merge-related operations.
310
 
 
311
 
* Perhaps attempts to get locks should timeout after some period of
312
 
  time, or at least display a progress message.
313
 
 
314
 
* Split out upgrade functionality from check command into a separate
315
 
  ``bzr upgrade``.
316
 
 
317
162
 
318
163
Large things
319
164
------------
349
194
  files, and respecting selective commits.  Run the pre-commit check
350
195
  (e.g. compile and run test suite) in there.
351
196
 
352
 
  Possibly this should be done by splitting the commit function into
353
 
  several parts (under a single interface).  It is already rather
354
 
  large.  Decomposition:
355
 
 
356
 
   - find tree modifications and prepare in-memory inventory
357
 
 
358
 
   - export that inventory to a temporary directory
359
 
 
360
 
   - run the test in that temporary directory
361
 
 
362
 
   - if that succeeded, continue to actually finish the commit
363
 
 
364
 
  What should be done with the text of modified files while this is
365
 
  underway?  I don't think we want to count on holding them in memory
366
 
  and we can't trust the working files to stay in one place so I
367
 
  suppose we need to move them into the text store, or otherwise into
368
 
  a temporary directory.
369
 
 
370
 
  If the commit does not actually complete, we would rather the
371
 
  content was not left behind in the stores.  
372
 
 
373
197
* Web interface
374
198
 
375
199
* GUI (maybe in Python GTK+?)
380
204
  exports first as a simpler case because then we don't need to deal
381
205
  with removing the tags on the way back in.
382
206
 
383
 
* ``bzr find``