~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Martin Pool
  • Date: 2005-05-09 04:38:31 UTC
  • Revision ID: mbp@sourcefrog.net-20050509043831-d45f7832b7d4d5b0
- better message when refusing to add symlinks (from mpe)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
For things to do in Bazaar development, see
2
 
 
3
 
https://bugs.launchpad.net/bzr/
4
 
https://blueprints.launchpad.net/bzr/
 
1
.. -*- mode: indented-text; compile-command: "make -C doc" -*- 
 
2
 
 
3
 
 
4
*******************
 
5
Things to do in bzr
 
6
*******************
 
7
 
 
8
 
 
9
See also various low-level TODOs in the source code.  Try looking in
 
10
the list archive or on gmane.org for previous discussion of these
 
11
issues.
 
12
 
 
13
These are classified by approximate size: an hour or less, a day or
 
14
less, and several days or more.
 
15
 
 
16
 
 
17
Small things
 
18
------------
 
19
 
 
20
* Add of a file that was present in the base revision should put back
 
21
  the previous file-id.
 
22
 
 
23
* Handle diff of files which do not have a trailing newline; probably
 
24
  requires patching difflib to get it exactly right, or otherwise
 
25
  calling out to GNU diff.
 
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
* -r option should take a revision-id as well as a revno.
 
40
 
 
41
* ``bzr info`` could show space used by working tree, versioned files,
 
42
  unknown and ignored files. 
 
43
 
 
44
* ``bzr info`` should count only people with distinct email addresses as
 
45
  different committers.  (Or perhaps only distinct userids?)
 
46
 
 
47
* On Windows, command-line arguments should be `glob-expanded`__,
 
48
  because the shell doesn't do this.  However, there are probably some
 
49
  commands where this shouldn't be done, such as 'bzr ignore', because
 
50
  we want to accept globs.
 
51
 
 
52
* ``bzr ignore`` command that just adds a line to the ``.bzrignore`` file
 
53
  and makes it versioned.  Fix this to break symlinks.
 
54
 
 
55
* Any useful sanity checks in 'bzr ignore'?  Perhaps give a warning if
 
56
  they try to add a single file which is already versioned, or if they
 
57
  add a pattern which already exists, or if it looks like they gave an
 
58
  unquoted glob.
 
59
 
 
60
__ http://mail.python.org/pipermail/python-list/2001-April/037847.html
 
61
 
 
62
* Separate read and write version checks?
 
63
 
 
64
* ``bzr status DIR`` should give status on all files under that
 
65
  directory.
 
66
 
 
67
* Check all commands have decent help.
 
68
 
 
69
* ``bzr inventory -r REV`` and perhaps unify this with ``bzr ls``,
 
70
  giving options to display ids, types, etc.
 
71
 
 
72
* Atomic file class that renames into place when it's closed.
 
73
 
 
74
* Don't abort if ``~/.bzr.log`` can't be used.
 
75
 
 
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
* testbzr should by default test the bzr binary in the same directory
 
86
  as the testbzr script, or take a path to it as a first parameter.
 
87
 
 
88
  Should show the version from bzr and the path name.
 
89
 
 
90
Medium things
 
91
-------------
 
92
 
 
93
* Display command grammar in help messages rather than hardcoding it.
 
94
 
 
95
* Change command functions into Command() objects, like in hct, and
 
96
  then the grammar can be described directly in there.  Since all
 
97
  option definitions are global we can define them just once and
 
98
  reference them from each command.
 
99
 
 
100
* Selective commit of only some files.
 
101
 
 
102
* Faster diff/status.  
 
103
 
 
104
  Status should be handled differently because it needs to report on
 
105
  deleted and unknown files.  diff only needs to deal with versioned
 
106
  files.
 
107
 
 
108
* Merge Aaron's merge code.
 
109
 
 
110
* Merge revert patch.
 
111
 
 
112
* Turn on stat cache code, and add optimization about avoiding
 
113
  dangerous cache entries.
 
114
 
 
115
* ``bzr mv`` that does either rename or move as in Unix.
 
116
 
 
117
* More efficient diff of only selected files.
 
118
 
 
119
* Fix up Inventory objects to represent root object as an entry.
 
120
 
 
121
* Don't convert entire entry from 
 
122
 
 
123
* Extract changes from one revision to the next to a text form
 
124
  suitable for transmission over email.
 
125
 
 
126
* More test cases.
 
127
 
 
128
* Write a reproducible benchmark, perhaps importing various kernel versions.
 
129
 
 
130
* Change test.sh from Bourne shell into something in pure Python so
 
131
  that it can be more portable.
 
132
 
 
133
* Directly import diffs!  It seems a bit redundant to need to rescan
 
134
  the directory to work out what files diff added/deleted/changed when
 
135
  all the information is there in the diff in the first place.
 
136
  Getting the exact behaviour for added/deleted subdirectories etc
 
137
  might be hard.
 
138
 
 
139
  At the very least we could run diffstat over the diff, or perhaps
 
140
  read the status output from patch.  Just knowing which files might
 
141
  be modified would be enough to guide the add and commit.
 
142
  
 
143
  Given this we might be able to import patches at 1/second or better.
 
144
 
 
145
* Get branch over http.
 
146
 
 
147
* Pull pure updates over http.
 
148
 
 
149
* revfile compression.
 
150
 
 
151
* Split inventory into per-directory files.
 
152
 
 
153
* Fix ignore file parsing:
 
154
 
 
155
  - fnmatch is not the same as unix patterns
 
156
 
 
157
  - perhaps add extended globs from rsh/rsync
 
158
 
 
159
  - perhaps a pattern that matches only directories or non-directories
 
160
 
 
161
* Consider using Python logging library as well as/instead of
 
162
  bzrlib.trace.
 
163
 
 
164
* Commands should give some progress indication by default.
 
165
 
 
166
  - But quieten this with ``--silent``.
 
167
 
 
168
* Change to using gettext message localization.
 
169
 
 
170
* Make a clearer separation between internal and external bzrlib
 
171
  interfaces.  Make internal interfaces use protected names.  Write at
 
172
  least some documentation for those APIs, probably as docstrings.
 
173
 
 
174
  Consider using ZopeInterface definitions for the external interface;
 
175
  I think these are already used in PyBaz.  They allow automatic
 
176
  checking of the interface but may be unfamiliar to general Python
 
177
  developers, so I'm not really keen.
 
178
 
 
179
* Commands to dump out all command help into a manpage or HTML file or
 
180
  whatever.
 
181
 
 
182
* Handle symlinks in the working directory; at the very least it
 
183
  should be possible for them to be present and ignored/unknown
 
184
  without causing assertion failures. 
 
185
 
 
186
  Eventually symlinks should be versioned.
 
187
 
 
188
* Allow init in a subdirectory to create a nested repository, but only
 
189
  if the subdirectory is not already versioned.   Perhaps also require
 
190
  a ``--nested`` to protect against confusion.
 
191
 
 
192
* Branch names? 
 
193
 
 
194
* More test framework:
 
195
 
 
196
  - Class that describes the state of a working tree so we can just
 
197
    assert it's equal.
 
198
 
 
199
* There are too many methods on Branch() that really manipulate the
 
200
  WorkingTree.  They should be moved across.  
 
201
 
 
202
  Also there are some methods which are duplicated on Tree and
 
203
  Inventory objects, and it should be made more clear which ones are
 
204
  proxies and which ones behave differently, and how.
 
205
 
 
206
* Try using XSLT to add some formatting to REST-generated HTML.  Or
 
207
  maybe write a small Python program that specifies a header and foot
 
208
  for the pages and calls into the docutils libraries.
 
209
 
 
210
* --format=xml for log, status and other commands.
 
211
 
 
212
* Attempting to explicitly add a file that's already added should give
 
213
  a warning; however there should be no warning for directories (since
 
214
  we scan for new children) or files encountered in a directory that's
 
215
  being scanned.
 
216
 
 
217
* Better handling of possible collisions on case-losing filesystems;
 
218
  make sure a single file does not get added twice under different
 
219
  names.
 
220
 
 
221
* Clean up XML inventory:
 
222
 
 
223
  - Use nesting rather than parent_id pointers.
 
224
 
 
225
  - Hold the ElementTree in memory in the Inventory object and work
 
226
    directly on that, rather than converting into Python objects every
 
227
    time it is read in.  Probably still expose it through some kind of
 
228
    object interface though, but perhaps that should just be a proxy
 
229
    for the elements.
 
230
 
 
231
  - Less special cases for the root directory. 
 
232
 
 
233
* Perhaps inventories should remember the revision in which each file
 
234
  was last changed, as well as its current state?  This is a bit
 
235
  redundant but might often be interested to know.
 
236
 
 
237
 
 
238
Large things
 
239
------------
 
240
 
 
241
* Generate annotations from current file relative to previous
 
242
  annotations.
 
243
 
 
244
  - Is it necessary to store any kind of annotation where data was
 
245
    deleted?
 
246
 
 
247
* Update revfile_ format and make it active:
 
248
 
 
249
  - Texts should be identified by something keyed on the revision, not
 
250
    an individual text-id.  This is much more useful for annotate I
 
251
    think; we want to map back to the revision that last changed it.
 
252
 
 
253
  - Access revfile revisions through the Tree/Store classes.
 
254
 
 
255
  - Check them from check commands.
 
256
 
 
257
  - Store annotations.
 
258
 
 
259
.. _revfile: revfile.html
 
260
 
 
261
* Hooks for pre-commit, post-commit, etc.
 
262
 
 
263
  Consider the security implications; probably should not enable hooks
 
264
  for remotely-fetched branches by default.
 
265
 
 
266
* Pre-commit check.  If this hook is defined, it needs to be handled
 
267
  specially: create a temporary directory containing the tree as it
 
268
  will be after the commit.  This means excluding any ignored/unknown
 
269
  files, and respecting selective commits.  Run the pre-commit check
 
270
  (e.g. compile and run test suite) in there.
 
271
 
 
272
* Web interface
 
273
 
 
274
* GUI (maybe in Python GTK+?)
 
275
 
 
276
* C library interface
 
277
 
 
278
* Expansion of $Id$ keywords within working files.  Perhaps do this in
 
279
  exports first as a simpler case because then we don't need to deal
 
280
  with removing the tags on the way back in.
 
281
 
 
282
* ``bzr find``