← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Martin Pool
  • Date: 2005-04-26 05:20:17 UTC
  • Revision ID: mbp@sourcefrog.net-20050426052016-8445d0f4fec584d0
- move all TODO items into ./TODO

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
 
 
 
1
(See also various low-level TODOs in the source code.)
16
2
 
17
3
Small things
18
4
------------
26
12
 
27
13
* Import ElementTree update patch.
28
14
 
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
15
 
84
16
Medium things
85
17
-------------
86
18
 
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
19
* Faster diff/status.  
97
20
 
98
21
  Status should be handled differently because it needs to report on
106
29
* Turn on stat cache code, and add optimization about avoiding
107
30
  dangerous cache entries.
108
31
 
109
 
* ``bzr mv`` that does either rename or move as in Unix.
 
32
* mv command?
110
33
 
111
34
* More efficient diff of only selected files.
112
35
 
144
67
 
145
68
* Split inventory into per-directory files.
146
69
 
147
 
* Fix ignore file parsing:
148
 
 
149
 
  - fnmatch is not the same as unix patterns
150
 
 
151
 
  - perhaps add extended globs from rsh/rsync
152
 
 
153
 
  - perhaps a pattern that matches only directories or non-directories
154
 
 
155
 
* Consider using Python logging library as well as/instead of
156
 
  bzrlib.trace.
157
 
 
158
 
* Commands should give some progress indication by default.
159
 
 
160
 
  - But quieten this with ``--silent``.
161
 
 
162
 
* Change to using gettext message localization.
163
 
 
164
 
* Make a clearer separation between internal and external bzrlib
165
 
  interfaces.  Make internal interfaces use protected names.  Write at
166
 
  least some documentation for those APIs, probably as docstrings.
167
 
 
168
 
  Consider using ZopeInterface definitions for the external interface;
169
 
  I think these are already used in PyBaz.  They allow automatic
170
 
  checking of the interface but may be unfamiliar to general Python
171
 
  developers, so I'm not really keen.
172
 
 
173
 
* Commands to dump out all command help into a manpage or HTML file or
174
 
  whatever.
175
 
 
176
 
* Handle symlinks in the working directory; at the very least it
177
 
  should be possible for them to be present and ignored/unknown
178
 
  without causing assertion failures. 
179
 
 
180
 
  Eventually symlinks should be versioned.
181
 
 
182
 
* Allow init in a subdirectory to create a nested repository, but only
183
 
  if the subdirectory is not already versioned.   Perhaps also require
184
 
  a ``--nested`` to protect against confusion.
185
 
 
186
 
* Branch names? 
187
 
 
188
 
 
189
 
 
190
70
 
191
71
Large things
192
72
------------
193
73
 
194
 
* Generate annotations from current file relative to previous
195
 
  annotations.
196
 
 
197
 
  - Is it necessary to store any kind of annotation where data was
198
 
    deleted?
199
 
 
200
 
* Update revfile_ format and make it active:
201
 
 
202
 
  - Texts should be identified by something keyed on the revision, not
203
 
    an individual text-id.  This is much more useful for annotate I
204
 
    think; we want to map back to the revision that last changed it.
205
 
 
206
 
  - Access revfile revisions through the Tree/Store classes.
207
 
 
208
 
  - Check them from check commands.
209
 
 
210
 
  - Store annotations.
211
 
 
212
 
.. _revfile: revfile.html
213
 
 
214
 
* Hooks for pre-commit, post-commit, etc.
215
 
 
216
 
  Consider the security implications; probably should not enable hooks
217
 
  for remotely-fetched branches by default.
218
 
 
219
 
* Pre-commit check.  If this hook is defined, it needs to be handled
220
 
  specially: create a temporary directory containing the tree as it
221
 
  will be after the commit.  This means excluding any ignored/unknown
222
 
  files, and respecting selective commits.  Run the pre-commit check
223
 
  (e.g. compile and run test suite) in there.
224
 
 
225
74
* Web interface
226
75
 
227
76
* GUI (maybe in Python GTK+?)
228
77
 
229
 
* C library interface
230
 
 
231
 
* Expansion of $Id$ keywords within working files.  Perhaps do this in
232
 
  exports first as a simpler case because then we don't need to deal
233
 
  with removing the tags on the way back in.
234
 
 
235
 
* ``bzr find``
 
78
* C library interface
 
 
b'\\ No newline at end of file'