~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Martin Pool
  • Date: 2005-05-02 07:24:07 UTC
  • Revision ID: mbp@sourcefrog.net-20050502072407-2a8eef6f88018fc0
- update todo list

Show diffs side-by-side

added added

removed removed

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