/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-03 02:39:45 UTC
  • Revision ID: mbp@sourcefrog.net-20050503023945-542829ff748301e8
- more documentation of revfile+annotation

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.
 
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
 
 
71
Medium things
 
72
-------------
 
73
 
 
74
* Display command grammar in help messages rather than hardcoding it.
 
75
 
 
76
* Change command functions into Command() objects, like in hct, and
 
77
  then the grammar can be described directly in there.  Since all
 
78
  option definitions are global we can define them just once and
 
79
  reference them from each command.
 
80
 
 
81
* Selective commit of only some files.
 
82
 
 
83
* Faster diff/status.  
 
84
 
 
85
  Status should be handled differently because it needs to report on
 
86
  deleted and unknown files.  diff only needs to deal with versioned
 
87
  files.
 
88
 
 
89
* Merge Aaron's merge code.
 
90
 
 
91
* Merge revert patch.
 
92
 
 
93
* Turn on stat cache code, and add optimization about avoiding
 
94
  dangerous cache entries.
 
95
 
 
96
* mv command?
 
97
 
 
98
* More efficient diff of only selected files.
 
99
 
 
100
* Fix up Inventory objects to represent root object as an entry.
 
101
 
 
102
* Don't convert entire entry from 
 
103
 
 
104
* Extract changes from one revision to the next to a text form
 
105
  suitable for transmission over email.
 
106
 
 
107
* More test cases.
 
108
 
 
109
* Write a reproducible benchmark, perhaps importing various kernel versions.
 
110
 
 
111
* Change test.sh from Bourne shell into something in pure Python so
 
112
  that it can be more portable.
 
113
 
 
114
* Directly import diffs!  It seems a bit redundant to need to rescan
 
115
  the directory to work out what files diff added/deleted/changed when
 
116
  all the information is there in the diff in the first place.
 
117
  Getting the exact behaviour for added/deleted subdirectories etc
 
118
  might be hard.
 
119
 
 
120
  At the very least we could run diffstat over the diff, or perhaps
 
121
  read the status output from patch.  Just knowing which files might
 
122
  be modified would be enough to guide the add and commit.
 
123
  
 
124
  Given this we might be able to import patches at 1/second or better.
 
125
 
 
126
* Get branch over http.
 
127
 
 
128
* Pull pure updates over http.
 
129
 
 
130
* revfile compression.
 
131
 
 
132
* Split inventory into per-directory files.
 
133
 
 
134
* Fix ignore file parsing:
 
135
 
 
136
  - fnmatch is not the same as unix patterns
 
137
 
 
138
  - perhaps add extended globs from rsh/rsync
 
139
 
 
140
  - perhaps a pattern that matches only directories or non-directories
 
141
 
 
142
* Consider using Python logging library as well as/instead of
 
143
  bzrlib.trace.
 
144
 
 
145
* Change to using gettext message localization.
 
146
 
 
147
* Make a clearer separation between internal and external bzrlib
 
148
  interfaces.  Make internal interfaces use protected names.  Write at
 
149
  least some documentation for those APIs, probably as docstrings.
 
150
 
 
151
  Consider using ZopeInterface definitions for the external interface;
 
152
  I think these are already used in PyBaz.  They allow automatic
 
153
  checking of the interface but may be unfamiliar to general Python
 
154
  developers, so I'm not really keen.
 
155
 
 
156
* Commands to dump out all command help into a manpage or HTML file or
 
157
  whatever.
 
158
 
 
159
* Handle symlinks in the working directory; at the very least it
 
160
  should be possible for them to be present and ignored/unknown
 
161
  without causing assertion failures. 
 
162
 
 
163
  Eventually symlinks should be versioned.
 
164
 
 
165
 
 
166
Large things
 
167
------------
 
168
 
 
169
* Generate annotations from current file relative to previous
 
170
  annotations.
 
171
 
 
172
  - Is it necessary to store any kind of annotation where data was
 
173
    deleted?
 
174
 
 
175
* Update revfile_ format and make it active:
 
176
 
 
177
  - Texts should be identified by something keyed on the revision, not
 
178
    an individual text-id.  This is much more useful for annotate I
 
179
    think; we want to map back to the revision that last changed it.
 
180
 
 
181
  - Access revfile revisions through the Tree/Store classes.
 
182
 
 
183
  - Check them from check commands.
 
184
 
 
185
  - Store annotations.
 
186
 
 
187
.. _revfile: revfile.html
 
188
 
 
189
* Hooks for pre-commit, post-commit, etc.
 
190
 
 
191
  Consider the security implications; probably should not enable hooks
 
192
  for remotely-fetched branches by default.
 
193
 
 
194
* Pre-commit check.  If this hook is defined, it needs to be handled
 
195
  specially: create a temporary directory containing the tree as it
 
196
  will be after the commit.  This means excluding any ignored/unknown
 
197
  files, and respecting selective commits.  Run the pre-commit check
 
198
  (e.g. compile and run test suite) in there.
 
199
 
 
200
* Web interface
 
201
 
 
202
* GUI (maybe in Python GTK+?)
 
203
 
 
204
* C library interface
 
205
 
 
206
* Expansion of $Id$ keywords within working files.  Perhaps do this in
 
207
  exports first as a simpler case because then we don't need to deal
 
208
  with removing the tags on the way back in.
 
209