Clean up docstrings in dulwich.protocol.
[jelmer/dulwich-libgit2.git] / NEWS
1 0.6.2   UNRELEASED
2
3  BUG FIXES
4
5   * HTTP server correctly handles empty CONTENT_LENGTH. (Dave Borowitz)
6
7   * Don't error when creating GitFiles with the default mode. (Dave Borowitz)
8
9   * ThinPackData.from_file now works with resolve_ext_ref callback.
10     (Dave Borowitz)
11
12  FEATURES
13
14   * Use slots for core objects to save up on memory. (Jelmer Vernooij)
15
16   * Web server supports streaming progress/pack output. (Dave Borowitz)
17
18   * New public function dulwich.pack.write_pack_header. (Dave Borowitz)
19
20   * Distinguish between missing files and read errors in HTTP server.
21     (Dave Borowitz)
22
23   * Initial work on a fastimport parser. (Jelmer Vernooij)
24
25  TESTS
26
27   * Use GitFile when modifying packed-refs in tests. (Dave Borowitz)
28
29   * New tests in test_web with better coverage and fewer ad-hoc mocks.
30     (Dave Borowitz)
31
32   * Standardize quote delimiters in test_protocol. (Dave Borowitz)
33
34   * Fix use when testtools is installed. (Jelmer Vernooij)
35
36   * Add trivial test for write_pack_header. (Jelmer Vernooij)
37
38  API CHANGES
39
40   * ObjectStore.iter_tree_contents now walks contents in depth-first, sorted
41     order. (Dave Borowitz)
42
43   * ObjectStore.iter_tree_contents can optionally yield tree objects as well.
44     (Dave Borowitz).
45
46   * Add side-band-64k support to ReceivePackHandler. (Dave Borowitz)
47
48   * Change server capabilities methods to classmethods. (Dave Borowitz)
49
50   * Tweak server handler injection. (Dave Borowitz)
51
52  DOCUMENTATION
53
54   * Add docstrings for various functions in dulwich.objects. (Jelmer Vernooij)
55
56   * Clean up docstrings in dulwich.protocol. (Dave Borowitz)
57
58
59 0.6.1   2010-07-22
60
61  BUG FIXES
62
63   * Fix memory leak in C implementation of sorted_tree_items. (Dave Borowitz)
64
65   * Use correct path separators for named repo files. (Dave Borowitz)
66
67   * python > 2.7 and testtools-based test runners will now also pick up skipped
68     tests correctly. (Jelmer Vernooij)
69
70  FEATURES
71
72   * Move named file initilization to BaseRepo. (Dave Borowitz)
73
74   * Add logging utilities and git/HTTP server logging. (Dave Borowitz)
75
76   * The GitClient interface has been cleaned up and instances are now reusable.
77     (Augie Fackler)
78
79   * Allow overriding paths to executables in GitSSHClient. 
80     (Ross Light, Jelmer Vernooij, #585204)
81
82   * Add PackBasedObjectStore.pack_loose_objects(). (Jelmer Vernooij)
83
84  TESTS
85
86   * Add tests for sorted_tree_items and C implementation. (Dave Borowitz)
87
88   * Add a MemoryRepo that stores everything in memory. (Dave Borowitz)
89
90   * Quiet logging output from web tests. (Dave Borowitz)
91
92   * More flexible version checking for compat tests. (Dave Borowitz)
93
94   * Compat tests for servers with and without side-band-64k. (Dave Borowitz)
95
96  CLEANUP
97
98   * Clean up file headers. (Dave Borowitz)
99
100  TESTS
101
102   * Use GitFile when modifying packed-refs in tests. (Dave Borowitz)
103
104  API CHANGES
105
106   * dulwich.pack.write_pack_index_v{1,2} now take a file-like object
107     rather than a filename. (Jelmer Vernooij)
108
109   * Make dul-daemon/dul-web trivial wrappers around server functionality.
110     (Dave Borowitz)
111
112   * Move reference WSGI handler to web.py. (Dave Borowitz)
113
114   * Factor out _report_status in ReceivePackHandler. (Dave Borowitz)
115
116   * Factor out a function to convert a line to a pkt-line. (Dave Borowitz)
117
118
119 0.6.0   2010-05-22
120
121 note: This list is most likely incomplete for 0.6.0.
122
123  BUG FIXES
124  
125   * Fix ReceivePackHandler to disallow removing refs without delete-refs.
126     (Dave Borowitz)
127
128   * Deal with capabilities required by the client, even if they 
129     can not be disabled in the server. (Dave Borowitz)
130
131   * Fix trailing newlines in generated patch files.
132     (Jelmer Vernooij)
133
134   * Implement RefsContainer.__contains__. (Jelmer Vernooij)
135
136   * Cope with \r in ref files on Windows. (
137         http://github.com/jelmer/dulwich/issues/#issue/13, Jelmer Vernooij)
138
139   * Fix GitFile breakage on Windows. (Anatoly Techtonik, #557585)
140
141   * Support packed ref deletion with no peeled refs. (Augie Fackler)
142
143   * Fix send pack when there is nothing to fetch. (Augie Fackler)
144
145   * Fix fetch if no progress function is specified. (Augie Fackler)
146
147   * Allow double-staging of files that are deleted in the index. 
148     (Dave Borowitz)
149
150   * Fix RefsContainer.add_if_new to support dangling symrefs.
151     (Dave Borowitz)
152
153   * Non-existant index files in non-bare repositories are now treated as 
154     empty. (Dave Borowitz)
155
156   * Always update ShaFile.id when the contents of the object get changed. 
157     (Jelmer Vernooij)
158
159   * Various Python2.4-compatibility fixes. (Dave Borowitz)
160
161   * Fix thin pack handling. (Dave Borowitz)
162  
163  FEATURES
164
165   * Add include-tag capability to server. (Dave Borowitz)
166
167   * New dulwich.fastexport module that can generate fastexport 
168     streams. (Jelmer Vernooij)
169
170   * Implemented BaseRepo.__contains__. (Jelmer Vernooij)
171
172   * Add __setitem__ to DictRefsContainer. (Dave Borowitz)
173
174   * Overall improvements checking Git objects. (Dave Borowitz)
175
176   * Packs are now verified while they are received. (Dave Borowitz)
177
178  TESTS
179
180   * Add framework for testing compatibility with C Git. (Dave Borowitz)
181
182   * Add various tests for the use of non-bare repositories. (Dave Borowitz)
183
184   * Cope with diffstat not being available on all platforms. 
185     (Tay Ray Chuan, Jelmer Vernooij)
186
187   * Add make_object and make_commit convenience functions to test utils.
188     (Dave Borowitz)
189
190  API BREAKAGES
191
192   * The 'committer' and 'message' arguments to Repo.do_commit() have 
193     been swapped. 'committer' is now optional. (Jelmer Vernooij)
194
195   * Repo.get_blob, Repo.commit, Repo.tag and Repo.tree are now deprecated.
196     (Jelmer Vernooij)
197
198   * RefsContainer.set_ref() was renamed to RefsContainer.set_symbolic_ref(),
199     for clarity. (Jelmer Vernooij)
200
201  API CHANGES
202
203   * The primary serialization APIs in dulwich.objects now work 
204     with chunks of strings rather than with full-text strings. 
205     (Jelmer Vernooij)
206
207 0.5.0   2010-03-03
208
209  BUG FIXES
210
211   * Support custom fields in commits (readonly). (Jelmer Vernooij)
212
213   * Improved ref handling. (Dave Borowitz)
214
215   * Rework server protocol to be smarter and interoperate with cgit client.
216     (Dave Borowitz)
217
218   * Add a GitFile class that uses the same locking protocol for writes as 
219     cgit. (Dave Borowitz)
220
221   * Cope with forward slashes correctly in the index on Windows.
222     (Jelmer Vernooij, #526793)
223
224  FEATURES
225
226   * --pure option to setup.py to allow building/installing without the C 
227     extensions. (Hal Wine, Anatoly Techtonik, Jelmer Vernooij, #434326)
228
229   * Implement Repo.get_config(). (Jelmer Vernooij, Augie Fackler)
230
231   * HTTP dumb and smart server. (Dave Borowitz)
232
233   * Add abstract baseclass for Repo that does not require file system 
234     operations. (Dave Borowitz)
235
236 0.4.1   2010-01-03
237
238  FEATURES
239
240   * Add ObjectStore.iter_tree_contents(). (Jelmer Vernooij)
241
242   * Add Index.changes_from_tree(). (Jelmer Vernooij)
243
244   * Add ObjectStore.tree_changes(). (Jelmer Vernooij)
245
246   * Add functionality for writing patches in dulwich.patch.
247     (Jelmer Vernooij)
248
249 0.4.0   2009-10-07
250
251  DOCUMENTATION
252
253   * Added tutorial.
254
255  API CHANGES
256
257   * dulwich.object_store.tree_lookup_path will now return the mode and 
258     sha of the object found rather than the object itself.
259
260  BUG FIXES
261
262   * Use binascii.hexlify / binascii.unhexlify for better performance.
263
264   * Cope with extra unknown data in index files by ignoring it (for now).
265
266   * Add proper error message when server unexpectedly hangs up. (#415843)
267
268   * Correctly write opcode for equal in create_delta.
269
270 0.3.3   2009-07-23
271
272  FEATURES
273
274   * Implement ShaFile.__hash__().
275
276   * Implement Tree.__len__()
277
278  BUG FIXES
279   
280   * Check for 'objects' and 'refs' directories
281     when looking for a Git repository. (#380818)
282
283 0.3.2   2009-05-20
284
285  BUG FIXES
286
287   * Support the encoding field in Commits.
288   
289   * Some Windows compatibility fixes.
290
291   * Fixed several issues in commit support.
292
293  FEATURES
294
295   * Basic support for handling submodules.
296
297 0.3.1   2009-05-13
298
299  FEATURES
300
301   * Implemented Repo.__getitem__, Repo.__setitem__ and Repo.__delitem__ to 
302     access content.
303
304  API CHANGES
305
306   * Removed Repo.set_ref, Repo.remove_ref, Repo.tags, Repo.get_refs and 
307     Repo.heads in favor of Repo.refs, a dictionary-like object for accessing
308         refs.
309
310  BUG FIXES
311
312   * Removed import of 'sha' module in objects.py, which was causing 
313     deprecation warnings on Python 2.6.
314
315 0.3.0   2009-05-10
316
317  FEATURES
318
319   * A new function `commit_tree' has been added that can commit a tree 
320     based on an index.
321
322  BUG FIXES
323
324   * The memory usage when generating indexes has been significantly reduced.
325  
326   * A memory leak in the C implementation of parse_tree has been fixed.
327
328   * The send-pack smart server command now works. (Thanks Scott Chacon)
329
330   * The handling of short timestamps (less than 10 digits) has been fixed.
331
332   * The handling of timezones has been fixed.
333
334 0.2.1   2009-04-30
335
336  BUG FIXES
337
338   * Fix compatibility with Python2.4.
339
340 0.2.0   2009-04-30
341
342  FEATURES
343
344   * Support for activity reporting in smart protocol client.
345
346   * Optional C extensions for better performance in a couple of 
347     places that are performance-critical.
348
349 0.1.1   2009-03-13
350
351  BUG FIXES
352
353   * Fixed regression in Repo.find_missing_objects()
354
355   * Don't fetch ^{} objects from remote hosts, as requesting them 
356     causes a hangup.
357
358   * Always write pack to disk completely before calculating checksum.
359
360  FEATURES
361
362   * Allow disabling thin packs when talking to remote hosts.
363
364 0.1.0   2009-01-24
365
366  * Initial release.