~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: mbp at sourcefrog
  • Date: 2005-03-23 06:25:55 UTC
  • Revision ID: mbp@sourcefrog.net-20050323062555-5489339018d0c043
- import a subset of elementtree for easier installation

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
* 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)
40
 
 
41
 
* -r option should take a revision-id as well as a revno.
42
 
 
43
 
* ``bzr info`` could show space used by working tree, versioned files,
44
 
  unknown and ignored files. 
45
 
 
46
 
* ``bzr info`` should count only people with distinct email addresses as
47
 
  different committers.  (Or perhaps only distinct userids?)
48
 
 
49
 
* On Windows, command-line arguments should be `glob-expanded`__,
50
 
  because the shell doesn't do this.  However, there are probably some
51
 
  commands where this shouldn't be done, such as 'bzr ignore', because
52
 
  we want to accept globs.
53
 
 
54
 
* ``bzr ignore`` command that just adds a line to the ``.bzrignore`` file
55
 
  and makes it versioned.  Fix this to break symlinks.
56
 
 
57
 
* ``bzr help commands`` should give a one-line summary of each command.
58
 
 
59
 
* Any useful sanity checks in 'bzr ignore'?  Perhaps give a warning if
60
 
  they try to add a single file which is already versioned, or if they
61
 
  add a pattern which already exists, or if it looks like they gave an
62
 
  unquoted glob.
63
 
 
64
 
__ http://mail.python.org/pipermail/python-list/2001-April/037847.html
65
 
 
66
 
* Read and write locks on branch while it's open.
67
 
 
68
 
* Separate read and write version checks?
69
 
 
70
 
* ``bzr status FILE...``
71
 
 
72
 
* Check all commands have decent help.
73
 
 
74
 
* Autogenerate argument/option help.
75
 
 
76
 
* ``bzr inventory -r REV`` and perhaps unify this with ``bzr ls``,
77
 
  giving options to display ids, types, etc.
78
 
 
79
 
* Atomic file class that renames into place when it's closed.
80
 
 
81
 
 
82
 
Medium things
83
 
-------------
84
 
 
85
 
* Display command grammar in help messages rather than hardcoding it.
86
 
 
87
 
* Change command functions into Command() objects, like in hct, and
88
 
  then the grammar can be described directly in there.  Since all
89
 
  option definitions are global we can define them just once and
90
 
  reference them from each command.
91
 
 
92
 
* Selective commit of only some files.
93
 
 
94
 
* Faster diff/status.  
95
 
 
96
 
  Status should be handled differently because it needs to report on
97
 
  deleted and unknown files.  diff only needs to deal with versioned
98
 
  files.
99
 
 
100
 
* Merge Aaron's merge code.
101
 
 
102
 
* Merge revert patch.
103
 
 
104
 
* Turn on stat cache code, and add optimization about avoiding
105
 
  dangerous cache entries.
106
 
 
107
 
* ``bzr mv`` that does either rename or move as in Unix.
108
 
 
109
 
* More efficient diff of only selected files.
110
 
 
111
 
* Fix up Inventory objects to represent root object as an entry.
112
 
 
113
 
* Don't convert entire entry from 
114
 
 
115
 
* Extract changes from one revision to the next to a text form
116
 
  suitable for transmission over email.
117
 
 
118
 
* More test cases.
119
 
 
120
 
* Write a reproducible benchmark, perhaps importing various kernel versions.
121
 
 
122
 
* Change test.sh from Bourne shell into something in pure Python so
123
 
  that it can be more portable.
124
 
 
125
 
* Directly import diffs!  It seems a bit redundant to need to rescan
126
 
  the directory to work out what files diff added/deleted/changed when
127
 
  all the information is there in the diff in the first place.
128
 
  Getting the exact behaviour for added/deleted subdirectories etc
129
 
  might be hard.
130
 
 
131
 
  At the very least we could run diffstat over the diff, or perhaps
132
 
  read the status output from patch.  Just knowing which files might
133
 
  be modified would be enough to guide the add and commit.
134
 
  
135
 
  Given this we might be able to import patches at 1/second or better.
136
 
 
137
 
* Get branch over http.
138
 
 
139
 
* Pull pure updates over http.
140
 
 
141
 
* revfile compression.
142
 
 
143
 
* Split inventory into per-directory files.
144
 
 
145
 
* Fix ignore file parsing:
146
 
 
147
 
  - fnmatch is not the same as unix patterns
148
 
 
149
 
  - perhaps add extended globs from rsh/rsync
150
 
 
151
 
  - perhaps a pattern that matches only directories or non-directories
152
 
 
153
 
* Consider using Python logging library as well as/instead of
154
 
  bzrlib.trace.
155
 
 
156
 
* Change to using gettext message localization.
157
 
 
158
 
* Make a clearer separation between internal and external bzrlib
159
 
  interfaces.  Make internal interfaces use protected names.  Write at
160
 
  least some documentation for those APIs, probably as docstrings.
161
 
 
162
 
  Consider using ZopeInterface definitions for the external interface;
163
 
  I think these are already used in PyBaz.  They allow automatic
164
 
  checking of the interface but may be unfamiliar to general Python
165
 
  developers, so I'm not really keen.
166
 
 
167
 
* Commands to dump out all command help into a manpage or HTML file or
168
 
  whatever.
169
 
 
170
 
* Handle symlinks in the working directory; at the very least it
171
 
  should be possible for them to be present and ignored/unknown
172
 
  without causing assertion failures. 
173
 
 
174
 
  Eventually symlinks should be versioned.
175
 
 
176
 
* Allow init in a subdirectory to create a nested repository, but only
177
 
  if the subdirectory is not already versioned.   Perhaps also require
178
 
  a ``--nested`` to protect against confusion.
179
 
 
180
 
* Branch names? 
181
 
 
182
 
 
183
 
 
184
 
 
185
 
Large things
186
 
------------
187
 
 
188
 
* Generate annotations from current file relative to previous
189
 
  annotations.
190
 
 
191
 
  - Is it necessary to store any kind of annotation where data was
192
 
    deleted?
193
 
 
194
 
* Update revfile_ format and make it active:
195
 
 
196
 
  - Texts should be identified by something keyed on the revision, not
197
 
    an individual text-id.  This is much more useful for annotate I
198
 
    think; we want to map back to the revision that last changed it.
199
 
 
200
 
  - Access revfile revisions through the Tree/Store classes.
201
 
 
202
 
  - Check them from check commands.
203
 
 
204
 
  - Store annotations.
205
 
 
206
 
.. _revfile: revfile.html
207
 
 
208
 
* Hooks for pre-commit, post-commit, etc.
209
 
 
210
 
  Consider the security implications; probably should not enable hooks
211
 
  for remotely-fetched branches by default.
212
 
 
213
 
* Pre-commit check.  If this hook is defined, it needs to be handled
214
 
  specially: create a temporary directory containing the tree as it
215
 
  will be after the commit.  This means excluding any ignored/unknown
216
 
  files, and respecting selective commits.  Run the pre-commit check
217
 
  (e.g. compile and run test suite) in there.
218
 
 
219
 
* Web interface
220
 
 
221
 
* GUI (maybe in Python GTK+?)
222
 
 
223
 
* C library interface
224
 
 
225
 
* Expansion of $Id$ keywords within working files.  Perhaps do this in
226
 
  exports first as a simpler case because then we don't need to deal
227
 
  with removing the tags on the way back in.
228
 
 
229
 
* ``bzr find``