← 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-05-02 04:24:33 UTC
  • Revision ID: mbp@sourcefrog.net-20050502042433-c825a7f7235f6b15
doc: notes on merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
1
 
For things to do in Bazaar development, see
2
 
 
3
 
https://bugs.launchpad.net/bzr/
4
 
https://blueprints.launchpad.net/bzr/
 
1
                                                 -*- indented-text -*-
 
2
 
 
3
See also various low-level TODOs in the source code.  Try looking in
 
4
the list archive or on gmane.org for previous discussion of these
 
5
issues.
 
6
 
 
7
These are classified by approximate size: an hour or less, a day or
 
8
less, and several days or more.
 
9
 
 
10
 
 
11
Small things
 
12
------------
 
13
 
 
14
* Add of a file that was present in the base revision should put back
 
15
  the previous file-id.
 
16
 
 
17
* Handle diff of files which do not have a trailing newline; probably
 
18
  requires patching difflib to get it exactly right, or otherwise
 
19
  calling out to GNU diff.
 
20
 
 
21
* Import ElementTree update patch.
 
22
 
 
23
* Syntax should be "bzr export -r REV".
 
24
 
 
25
* "cat -rREV FILE"
 
26
 
 
27
* Plugins that provide commands.  By just installing a file into some
 
28
  directory (e.g. /usr/share/bzr/plugins) it should be possible to
 
29
  create new top-level commands ("bzr frob").  Extensions can be
 
30
  written in either Python (in which case they use the bzrlib API) or
 
31
  in a separate process (in sh, C, whatever).   It should be possible
 
32
  to get help for plugin commands.
 
33
 
 
34
* Smart rewrap text in help messages to fit in $COLUMNS (or equivalent
 
35
  on Windows)
 
36
 
 
37
* -r option should take a revision-id as well as a revno.
 
38
 
 
39
* "bzr info" could show space used by working tree, versioned files,
 
40
  unknown and ignored files. 
 
41
 
 
42
* "bzr info" should count only people with distinct email addresses as
 
43
  different committers.  (Or perhaps only distinct userids?)
 
44
 
 
45
* Tidier error for EPIPE: should be just "bzr: broken pipe" with no
 
46
  other details because debugging information is rarely interesting.
 
47
 
 
48
* On Windows, command-line arguments should be glob-expanded__,
 
49
  because the shell doesn't do this.  However, there are probably some
 
50
  commands where this shouldn't be done, such as 'bzr ignore', because
 
51
  we want to accept globs.
 
52
 
 
53
__ http://mail.python.org/pipermail/python-list/2001-April/037847.html
 
54
 
 
55
* 'bzr ignore' command that just adds a line to the .bzrignore file
 
56
  and makes it versioned.
 
57
 
 
58
* 'bzr help commands' should give a one-line summary of each command.
 
59
 
 
60
* Any useful sanity checks in 'bzr ignore'?  Perhaps give a warning if
 
61
  they try to add a single file which is already versioned, or if they
 
62
  add a pattern which already exists, or if it looks like they gave an
 
63
  unquoted glob.
 
64
 
 
65
Medium things
 
66
-------------
 
67
 
 
68
* Display command grammar in help messages rather than hardcoding it.
 
69
 
 
70
* Change command functions into Command() objects, like in hct, and
 
71
  then the grammar can be described directly in there.  Since all
 
72
  option definitions are global we can define them just once and
 
73
  reference them from each command.
 
74
 
 
75
* Selective commit of only some files.
 
76
 
 
77
* Faster diff/status.  
 
78
 
 
79
  Status should be handled differently because it needs to report on
 
80
  deleted and unknown files.  diff only needs to deal with versioned
 
81
  files.
 
82
 
 
83
* Merge Aaron's merge code.
 
84
 
 
85
* Merge revert patch.
 
86
 
 
87
* Turn on stat cache code, and add optimization about avoiding
 
88
  dangerous cache entries.
 
89
 
 
90
* mv command?
 
91
 
 
92
* More efficient diff of only selected files.
 
93
 
 
94
* Fix up Inventory objects to represent root object as an entry.
 
95
 
 
96
* Don't convert entire entry from 
 
97
 
 
98
* Extract changes from one revision to the next to a text form
 
99
  suitable for transmission over email.
 
100
 
 
101
* More test cases.
 
102
 
 
103
* Write a reproducible benchmark, perhaps importing various kernel versions.
 
104
 
 
105
* Change test.sh from Bourne shell into something in pure Python so
 
106
  that it can be more portable.
 
107
 
 
108
* Directly import diffs!  It seems a bit redundant to need to rescan
 
109
  the directory to work out what files diff added/deleted/changed when
 
110
  all the information is there in the diff in the first place.
 
111
  Getting the exact behaviour for added/deleted subdirectories etc
 
112
  might be hard.
 
113
 
 
114
  At the very least we could run diffstat over the diff, or perhaps
 
115
  read the status output from patch.  Just knowing which files might
 
116
  be modified would be enough to guide the add and commit.
 
117
  
 
118
  Given this we might be able to import patches at 1/second or better.
 
119
 
 
120
* Get branch over http.
 
121
 
 
122
* Pull pure updates over http.
 
123
 
 
124
* revfile compression.
 
125
 
 
126
* Split inventory into per-directory files.
 
127
 
 
128
* Fix ignore file parsing:
 
129
 
 
130
  - fnmatch is not the same as unix patterns
 
131
 
 
132
  - perhaps add extended globs from rsh/rsync
 
133
 
 
134
  - perhaps a pattern that matches only directories or non-directories
 
135
 
 
136
* Expansion of $Id$ keywords within working files.  Perhaps do this in
 
137
  exports first as a simpler case because then we don't need to deal
 
138
  with removing the tags on the way back in.
 
139
 
 
140
* Consider using Python logging library as well as/instead of
 
141
  bzrlib.trace.
 
142
 
 
143
* Change to using gettext message localization.
 
144
 
 
145
* Make a clearer separation between internal and external bzrlib
 
146
  interfaces.  Make internal interfaces use protected names.  Write at
 
147
  least some documentation for those APIs, probably as docstrings.
 
148
 
 
149
  Consider using ZopeInterface definitions for the external interface;
 
150
  I think these are already used in PyBaz.  They allow automatic
 
151
  checking of the interface but may be unfamiliar to general Python
 
152
  developers.
 
153
 
 
154
* Commands to dump out all command help into a manpage or HTML file or
 
155
  whatever.
 
156
 
 
157
 
 
158
Large things
 
159
------------
 
160
 
 
161
* Hooks for pre-commit, post-commit, etc.
 
162
 
 
163
  Consider the security implications; probably should not enable hooks
 
164
  for remotely-fetched branches by default.
 
165
 
 
166
* Pre-commit check.  If this hook is defined, it needs to be handled
 
167
  specially: create a temporary directory containing the tree as it
 
168
  will be after the commit.  This means excluding any ignored/unknown
 
169
  files, and respecting selective commits.  Run the pre-commit check
 
170
  (e.g. compile and run test suite) in there.
 
171
 
 
172
* Web interface
 
173
 
 
174
* GUI (maybe in Python GTK+?)
 
175
 
 
176
* C library interface