~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Aaron Bentley
  • Date: 2005-08-10 15:05:26 UTC
  • mto: (1092.1.41) (1185.3.4) (974.1.47)
  • mto: This revision was merged to the branch mainline in revision 1110.
  • Revision ID: abentley@panoramicfeedback.com-20050810150526-468a7e2e3dc299e4
Switched to using a set of interesting file_ids instead of SourceFile attribute

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.. -*- mode: indented-text; compile-command: "make -C doc" -*- 
 
1
.. -*- mode: indented-text; compile-command: "make -C doc" -*-
2
2
 
3
3
 
4
4
*******************
17
17
Small things
18
18
------------
19
19
 
 
20
* is_within_any is very very dodgy
 
21
 
 
22
* Merging add of a new file clashing with an existing file doesn't
 
23
  work; add gets an error that it's already versioned and the merge
 
24
  aborts.
 
25
 
 
26
* Merge should ignore the destination's working directory, otherwise
 
27
  we get an error about the statcache when pulling from a remote
 
28
  branch.
 
29
 
20
30
* Add of a file that was present in the base revision should put back
21
31
  the previous file-id.
22
32
 
 
33
* Not sure I'm happy with needing to pass a root id to EmptyTree;
 
34
  comparing anything against an EmptyTree with no root should have the
 
35
  same effect(?)
 
36
 
23
37
* Handle diff of files which do not have a trailing newline; probably
24
38
  requires patching difflib to get it exactly right, or otherwise
25
39
  calling out to GNU diff.
26
40
 
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)
 
41
* Should be able to copy files between branches to preserve their
 
42
  file-id (and perhaps eventually parentage.)
40
43
 
41
44
* -r option should take a revision-id as well as a revno.
42
45
 
43
 
* ``bzr info`` could show space used by working tree, versioned files,
44
 
  unknown and ignored files. 
 
46
* allow ``bzr st -r 300`` to show a summary of changes since then.
45
47
 
46
48
* ``bzr info`` should count only people with distinct email addresses as
47
49
  different committers.  (Or perhaps only distinct userids?)
54
56
* ``bzr ignore`` command that just adds a line to the ``.bzrignore`` file
55
57
  and makes it versioned.  Fix this to break symlinks.
56
58
 
57
 
* ``bzr help commands`` should give a one-line summary of each command.
58
 
 
59
59
* Any useful sanity checks in 'bzr ignore'?  Perhaps give a warning if
60
60
  they try to add a single file which is already versioned, or if they
61
61
  add a pattern which already exists, or if it looks like they gave an
63
63
 
64
64
__ http://mail.python.org/pipermail/python-list/2001-April/037847.html
65
65
 
66
 
* Read and write locks on branch while it's open.
67
 
 
68
66
* Separate read and write version checks?
69
67
 
70
 
* ``bzr status FILE...``
71
 
 
72
 
* Check all commands have decent help.
73
 
 
74
 
* Autogenerate argument/option help.
 
68
* ``bzr status DIR`` should give status on all files under that
 
69
  directory.
 
70
 
 
71
* ``bzr log DIR`` should give changes to any files within DIR.
75
72
 
76
73
* ``bzr inventory -r REV`` and perhaps unify this with ``bzr ls``,
77
74
  giving options to display ids, types, etc.
78
75
 
79
 
* Atomic file class that renames into place when it's closed.
80
 
 
81
 
* Don't abort if ``~/.bzr.log`` can't be used.
 
76
* Split BzrError into various more specific subclasses for different
 
77
  errors people might want to catch.
 
78
 
 
79
* If the export destination ends in '.tar', '.tar.gz', etc then create
 
80
  a tarball instead of a directory.  (Need to actually make a
 
81
  temporary directory and then tar that up.)
 
82
 
 
83
  http://www.gelato.unsw.edu.au/archives/git/0504/2194.html
 
84
 
 
85
* RemoteBranch could maintain a cache either in memory or on disk.  We
 
86
  know more than an external cache might about which files are
 
87
  immutable and which can vary.  On the other hand, it's much simpler
 
88
  to just use an external proxy cache.
 
89
 
 
90
  Perhaps ~/.bzr/http-cache.  Baz has a fairly simple cache under
 
91
  ~/.arch-cache, containing revision information encoded almost as a
 
92
  bunch of archives.  Perhaps we could simply store full paths.
 
93
 
 
94
* Maybe also store directories in the statcache so that we can quickly
 
95
  identify that they still exist.
 
96
 
 
97
* Diff should show timestamps; for files from the working directory we
 
98
  can use the file itself; for files from a revision we should use the
 
99
  commit time of the revision.
 
100
 
 
101
* Perhaps split command infrastructure from the actual command
 
102
  definitions.
 
103
 
 
104
* Cleaner support for negative boolean options like --no-recurse.
 
105
 
 
106
* Statcache should possibly map all file paths to / separators
 
107
 
 
108
* quotefn doubles all backslashes on Windows; this is probably not the
 
109
  best thing to do.  What would be a better way to safely represent
 
110
  filenames?  Perhaps we could doublequote things containing spaces,
 
111
  on the principle that filenames containing quotes are unlikely?
 
112
  Nice for humans; less good for machine parsing.
 
113
 
 
114
* Patches should probably use only forward slashes, even on Windows,
 
115
  otherwise Unix patch can't apply them. (?)
 
116
 
 
117
* Branch.update_revisions() inefficiently fetches revisions from the
 
118
  remote server twice; once to find out what text and inventory they
 
119
  need and then again to actually get the thing.  This is a bit
 
120
  inefficient.
 
121
 
 
122
  One complicating factor here is that we don't really want to have
 
123
  revisions present in the revision-store until all their constituent
 
124
  parts are also stored.
 
125
 
 
126
  The basic problem is that RemoteBranch.get_revision() and similar
 
127
  methods return object, but what we really want is the raw XML, which
 
128
  can be popped into our own store.  That needs to be refactored.
 
129
 
 
130
* ``bzr status FOO`` where foo is ignored should say so.
 
131
 
 
132
* ``bzr mkdir A...`` should just create and add A.
 
133
 
 
134
* Guard against repeatedly merging any particular patch.
 
135
 
 
136
* More options for diff:
 
137
 
 
138
  - diff two revisions of the same tree
 
139
 
 
140
  - diff two different branches, optionally at different revisions
 
141
 
 
142
  - diff a particular file in another tree against the corresponding
 
143
    version in this tree (which should be the default if the second
 
144
    parameter is a tree root)
 
145
 
 
146
  - diff everything under a particular directory, in any of the above
 
147
    ways
 
148
 
 
149
  - diff two files inside the same tree, even if they have different
 
150
    ids
 
151
 
 
152
  - and, of course, tests for all this
 
153
 
 
154
* ``bzr add`` with no arguments should probably be the same as ``bzr add .``
 
155
 
 
156
* Reproducible performance benchmark to measure whether performance is 
 
157
  getting better or worse.
82
158
 
83
159
 
84
160
Medium things
85
161
-------------
86
162
 
87
 
* Display command grammar in help messages rather than hardcoding it.
88
 
 
89
 
* Change command functions into Command() objects, like in hct, and
90
 
  then the grammar can be described directly in there.  Since all
91
 
  option definitions are global we can define them just once and
92
 
  reference them from each command.
93
 
 
94
 
* Selective commit of only some files.
95
 
 
96
 
* Faster diff/status.  
97
 
 
98
 
  Status should be handled differently because it needs to report on
99
 
  deleted and unknown files.  diff only needs to deal with versioned
100
 
  files.
101
 
 
102
 
* Merge Aaron's merge code.
103
 
 
104
163
* Merge revert patch.
105
164
 
106
 
* Turn on stat cache code, and add optimization about avoiding
107
 
  dangerous cache entries.
108
 
 
109
165
* ``bzr mv`` that does either rename or move as in Unix.
110
166
 
111
 
* More efficient diff of only selected files.
 
167
* More efficient diff of only selected files.  We should be able to
 
168
  just get the id for the selected files, look up their location and
 
169
  diff just those files.  No need to traverse the entire inventories.
 
170
 
 
171
* ``bzr status DIR`` or ``bzr diff DIR`` should report on all changes
 
172
  under that directory.
112
173
 
113
174
* Fix up Inventory objects to represent root object as an entry.
114
175
 
115
 
* Don't convert entire entry from 
 
176
* Don't convert entire entry from ElementTree to an object when it is
 
177
  read in, but rather wait until the program actually wants to know
 
178
  about that node.
116
179
 
117
180
* Extract changes from one revision to the next to a text form
118
181
  suitable for transmission over email.
119
182
 
120
183
* More test cases.
121
184
 
 
185
  - Selected-file commit
 
186
 
 
187
  - Impossible selected-file commit: adding things in non-versioned
 
188
    directories, crossing renames, etc.
 
189
 
122
190
* Write a reproducible benchmark, perhaps importing various kernel versions.
123
191
 
124
 
* Change test.sh from Bourne shell into something in pure Python so
125
 
  that it can be more portable.
126
 
 
127
192
* Directly import diffs!  It seems a bit redundant to need to rescan
128
193
  the directory to work out what files diff added/deleted/changed when
129
194
  all the information is there in the diff in the first place.
133
198
  At the very least we could run diffstat over the diff, or perhaps
134
199
  read the status output from patch.  Just knowing which files might
135
200
  be modified would be enough to guide the add and commit.
136
 
  
 
201
 
137
202
  Given this we might be able to import patches at 1/second or better.
138
203
 
139
204
* Get branch over http.
175
240
 
176
241
* Handle symlinks in the working directory; at the very least it
177
242
  should be possible for them to be present and ignored/unknown
178
 
  without causing assertion failures. 
 
243
  without causing assertion failures.
179
244
 
180
245
  Eventually symlinks should be versioned.
181
246
 
183
248
  if the subdirectory is not already versioned.   Perhaps also require
184
249
  a ``--nested`` to protect against confusion.
185
250
 
186
 
* Branch names? 
187
 
 
188
 
 
 
251
* Branch names?
 
252
 
 
253
* More test framework:
 
254
 
 
255
  - Class that describes the state of a working tree so we can just
 
256
    assert it's equal.
 
257
 
 
258
* There are too many methods on Branch() that really manipulate the
 
259
  WorkingTree.  They should be moved across.
 
260
 
 
261
  Also there are some methods which are duplicated on Tree and
 
262
  Inventory objects, and it should be made more clear which ones are
 
263
  proxies and which ones behave differently, and how.
 
264
 
 
265
* Try using XSLT to add some formatting to REST-generated HTML.  Or
 
266
  maybe write a small Python program that specifies a header and foot
 
267
  for the pages and calls into the docutils libraries.
 
268
 
 
269
* --format=xml for log, status and other commands.
 
270
 
 
271
* Attempting to explicitly add a file that's already added should give
 
272
  a warning; however there should be no warning for directories (since
 
273
  we scan for new children) or files encountered in a directory that's
 
274
  being scanned.
 
275
 
 
276
* Better handling of possible collisions on case-losing filesystems;
 
277
  make sure a single file does not get added twice under different
 
278
  names.
 
279
 
 
280
* Clean up XML inventory:
 
281
 
 
282
  - Use nesting rather than parent_id pointers.
 
283
 
 
284
  - Hold the ElementTree in memory in the Inventory object and work
 
285
    directly on that, rather than converting into Python objects every
 
286
    time it is read in.  Probably still exposoe it through some kind of
 
287
    object interface though, but perhaps that should just be a proxy
 
288
    for the elements.
 
289
 
 
290
  - Less special cases for the root directory.
 
291
 
 
292
* Perhaps inventories should remember the revision in which each file
 
293
  was last changed, as well as its current state?  This is a bit
 
294
  redundant but might often be interested to know.
 
295
 
 
296
* stat cache should perhaps only stat files as necessary, rather than
 
297
  doing them all up-front.  On the other hand, that disallows the
 
298
  opimization of stating them in inode order.
 
299
 
 
300
* It'd be nice to pipeline multiple HTTP requests.  Often we can
 
301
  predict what will be wanted in future: all revisions, or all texts
 
302
  in a particular revision, etc.
 
303
 
 
304
  urlgrabber's docs say they are working on batched downloads; we
 
305
  could perhaps ride on that or just create a background thread (ew).
 
306
 
 
307
* Paranoid mode where we never trust SHA-1 matches.
 
308
 
 
309
* Don't commit if there are no changes unless forced.
 
310
 
 
311
* --dry-run mode for commit?  (Or maybe just run with
 
312
  check-command=false?)
 
313
 
 
314
* Generally, be a bit more verbose unless --silent is specified.
 
315
 
 
316
* Function that finds all changes to files under a given directory;
 
317
  perhaps log should use this if a directory is given.
 
318
 
 
319
* XML attributes might have trouble with filenames containing \n and
 
320
  \r.  Do we really want to support this?  I think perhaps not.
 
321
 
 
322
* Remember execute bits, so that exports will work OK.
 
323
 
 
324
* Unify smart_add and plain Branch.add(); perhaps smart_add should
 
325
  just build a list of files to add and pass that to the regular add
 
326
  function.
 
327
 
 
328
* Function to list a directory, saying in which revision each file was
 
329
  last modified.  Useful for web and gui interfaces, and slow to
 
330
  compute one file at a time.
 
331
 
 
332
* unittest is standard, but the results are kind of ugly; would be
 
333
  nice to make it cleaner.
 
334
 
 
335
* Check locking is correct during merge-related operations.
 
336
 
 
337
* Perhaps attempts to get locks should timeout after some period of
 
338
  time, or at least display a progress message.
 
339
 
 
340
* Split out upgrade functionality from check command into a separate
 
341
  ``bzr upgrade``.
 
342
 
 
343
* Don't pass around command classes but rather pass objects.  This'd
 
344
  make it cleaner to construct objects wrapping external commands.
 
345
 
 
346
* Track all merged-in revisions in a versioned add-only metafile.
189
347
 
190
348
 
191
349
Large things
222
380
  files, and respecting selective commits.  Run the pre-commit check
223
381
  (e.g. compile and run test suite) in there.
224
382
 
 
383
  Possibly this should be done by splitting the commit function into
 
384
  several parts (under a single interface).  It is already rather
 
385
  large.  Decomposition:
 
386
 
 
387
   - find tree modifications and prepare in-memory inventory
 
388
 
 
389
   - export that inventory to a temporary directory
 
390
 
 
391
   - run the test in that temporary directory
 
392
 
 
393
   - if that succeeded, continue to actually finish the commit
 
394
 
 
395
  What should be done with the text of modified files while this is
 
396
  underway?  I don't think we want to count on holding them in memory
 
397
  and we can't trust the working files to stay in one place so I
 
398
  suppose we need to move them into the text store, or otherwise into
 
399
  a temporary directory.
 
400
 
 
401
  If the commit does not actually complete, we would rather the
 
402
  content was not left behind in the stores.
 
403
 
225
404
* Web interface
226
405
 
227
406
* GUI (maybe in Python GTK+?)