/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

  • Committer: Martin Pool
  • Date: 2005-05-09 03:01:21 UTC
  • Revision ID: mbp@sourcefrog.net-20050509030121-c025382fb31c72ed
- very short tutorial on help page

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