/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to TODO

Fix formatting, remove catch-all for exceptions when opening local repositories.

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
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
 
* Don't abort if ``~/.bzr.log`` can't be used.
82
 
 
83
 
* Split BzrError into various more specific subclasses for different
84
 
  errors people might want to catch.
85
 
 
86
 
Medium things
87
 
-------------
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
 
 
106
 
* Merge revert patch.
107
 
 
108
 
* Turn on stat cache code, and add optimization about avoiding
109
 
  dangerous cache entries.
110
 
 
111
 
* ``bzr mv`` that does either rename or move as in Unix.
112
 
 
113
 
* More efficient diff of only selected files.
114
 
 
115
 
* Fix up Inventory objects to represent root object as an entry.
116
 
 
117
 
* Don't convert entire entry from 
118
 
 
119
 
* Extract changes from one revision to the next to a text form
120
 
  suitable for transmission over email.
121
 
 
122
 
* More test cases.
123
 
 
124
 
* Write a reproducible benchmark, perhaps importing various kernel versions.
125
 
 
126
 
* Change test.sh from Bourne shell into something in pure Python so
127
 
  that it can be more portable.
128
 
 
129
 
* Directly import diffs!  It seems a bit redundant to need to rescan
130
 
  the directory to work out what files diff added/deleted/changed when
131
 
  all the information is there in the diff in the first place.
132
 
  Getting the exact behaviour for added/deleted subdirectories etc
133
 
  might be hard.
134
 
 
135
 
  At the very least we could run diffstat over the diff, or perhaps
136
 
  read the status output from patch.  Just knowing which files might
137
 
  be modified would be enough to guide the add and commit.
138
 
  
139
 
  Given this we might be able to import patches at 1/second or better.
140
 
 
141
 
* Get branch over http.
142
 
 
143
 
* Pull pure updates over http.
144
 
 
145
 
* revfile compression.
146
 
 
147
 
* Split inventory into per-directory files.
148
 
 
149
 
* Fix ignore file parsing:
150
 
 
151
 
  - fnmatch is not the same as unix patterns
152
 
 
153
 
  - perhaps add extended globs from rsh/rsync
154
 
 
155
 
  - perhaps a pattern that matches only directories or non-directories
156
 
 
157
 
* Consider using Python logging library as well as/instead of
158
 
  bzrlib.trace.
159
 
 
160
 
* Commands should give some progress indication by default.
161
 
 
162
 
  - But quieten this with ``--silent``.
163
 
 
164
 
* Change to using gettext message localization.
165
 
 
166
 
* Make a clearer separation between internal and external bzrlib
167
 
  interfaces.  Make internal interfaces use protected names.  Write at
168
 
  least some documentation for those APIs, probably as docstrings.
169
 
 
170
 
  Consider using ZopeInterface definitions for the external interface;
171
 
  I think these are already used in PyBaz.  They allow automatic
172
 
  checking of the interface but may be unfamiliar to general Python
173
 
  developers, so I'm not really keen.
174
 
 
175
 
* Commands to dump out all command help into a manpage or HTML file or
176
 
  whatever.
177
 
 
178
 
* Handle symlinks in the working directory; at the very least it
179
 
  should be possible for them to be present and ignored/unknown
180
 
  without causing assertion failures. 
181
 
 
182
 
  Eventually symlinks should be versioned.
183
 
 
184
 
* Allow init in a subdirectory to create a nested repository, but only
185
 
  if the subdirectory is not already versioned.   Perhaps also require
186
 
  a ``--nested`` to protect against confusion.
187
 
 
188
 
* Branch names? 
189
 
 
190
 
* More test framework:
191
 
 
192
 
  - Class that describes the state of a working tree so we can just
193
 
    assert it's equal.
194
 
 
195
 
* There are too many methods on Branch() that really manipulate the
196
 
  WorkingTree.  They should be moved across.
197
 
 
198
 
 
199
 
 
200
 
 
201
 
Large things
202
 
------------
203
 
 
204
 
* Generate annotations from current file relative to previous
205
 
  annotations.
206
 
 
207
 
  - Is it necessary to store any kind of annotation where data was
208
 
    deleted?
209
 
 
210
 
* Update revfile_ format and make it active:
211
 
 
212
 
  - Texts should be identified by something keyed on the revision, not
213
 
    an individual text-id.  This is much more useful for annotate I
214
 
    think; we want to map back to the revision that last changed it.
215
 
 
216
 
  - Access revfile revisions through the Tree/Store classes.
217
 
 
218
 
  - Check them from check commands.
219
 
 
220
 
  - Store annotations.
221
 
 
222
 
.. _revfile: revfile.html
223
 
 
224
 
* Hooks for pre-commit, post-commit, etc.
225
 
 
226
 
  Consider the security implications; probably should not enable hooks
227
 
  for remotely-fetched branches by default.
228
 
 
229
 
* Pre-commit check.  If this hook is defined, it needs to be handled
230
 
  specially: create a temporary directory containing the tree as it
231
 
  will be after the commit.  This means excluding any ignored/unknown
232
 
  files, and respecting selective commits.  Run the pre-commit check
233
 
  (e.g. compile and run test suite) in there.
234
 
 
235
 
* Web interface
236
 
 
237
 
* GUI (maybe in Python GTK+?)
238
 
 
239
 
* C library interface
240
 
 
241
 
* Expansion of $Id$ keywords within working files.  Perhaps do this in
242
 
  exports first as a simpler case because then we don't need to deal
243
 
  with removing the tags on the way back in.
244
 
 
245
 
* ``bzr find``