Deprecate Tree.entries.
[jelmer/dulwich.git] / NEWS
1 0.7.1   UNRELEASED
2
3  BUG FIXES
4
5   * Fix double decref in _diff_tree.c. (Ted Horst, #715528)
6
7   * Fix the build on Windows. (Pascal Quantin)
8
9   * Fix get_transport_and_path compatibility with pre-2.6.5 versions of Python.
10     (Max Bowsher, #707438)
11
12   * BaseObjectStore.determine_wants_all no longer breaks on zero SHAs.
13     (Jelmer Vernooij)
14
15  IMPROVEMENTS
16
17   * Sphinxified documentation. (Lukasz Balcerzak)
18
19  API CHANGES
20
21   * Tree.entries() is now deprecated in favour of Tree.items() and
22     Tree.iteritems(). (Jelmer Vernooij)
23
24 0.7.0   2011-01-21
25
26  FEATURES
27
28   * New `dulwich.diff_tree` module for simple content-based rename detection.
29     (Dave Borowitz)
30
31   * Add Tree.items(). (Jelmer Vernooij)
32
33   * Add eof() and unread_pkt_line() methods to Protocol. (Dave Borowitz)
34
35   * Add write_tree_diff(). (Jelmer Vernooij)
36
37   * Add `serve_command` function for git server commands as executables.
38     (Jelmer Vernooij)
39
40   * dulwich.client.get_transport_and_path now supports rsync-style repository URLs.
41     (Dave Borowitz, #568493)
42
43  BUG FIXES
44
45   * Correct short-circuiting operation for no-op fetches in the server.
46     (Dave Borowitz)
47
48   * Support parsing git mbox patches without a version tail, as generated by
49     Mercurial.  (Jelmer Vernooij)
50
51   * Fix dul-receive-pack and dul-upload-pack. (Jelmer Vernooij)
52
53   * Zero-padded file modes in Tree objects no longer trigger an exception but
54     the check code warns about them. (Augie Fackler, #581064)
55
56   * Repo.init() now honors the mkdir flag. (#671159)
57
58   * The ref format is now checked when setting a ref rather than when reading it back.
59     (Dave Borowitz, #653527)
60
61   * Make sure pack files are closed correctly. (Tay Ray Chuan)
62
63  DOCUMENTATION
64
65   * Run the tutorial inside the test suite. (Jelmer Vernooij)
66
67   * Reorganized and updated the tutorial. (Jelmer Vernooij, Dave Borowitz, #610550,
68      #610540)
69
70
71 0.6.2   2010-10-16
72
73  BUG FIXES
74
75   * HTTP server correctly handles empty CONTENT_LENGTH. (Dave Borowitz)
76
77   * Don't error when creating GitFiles with the default mode. (Dave Borowitz)
78
79   * ThinPackData.from_file now works with resolve_ext_ref callback.
80     (Dave Borowitz)
81
82   * Provide strnlen() on mingw32 which doesn't have it. (Hans Kolek)
83
84   * Set bare=true in the configuratin for bare repositories. (Dirk Neumann)
85
86  FEATURES
87
88   * Use slots for core objects to save up on memory. (Jelmer Vernooij)
89
90   * Web server supports streaming progress/pack output. (Dave Borowitz)
91
92   * New public function dulwich.pack.write_pack_header. (Dave Borowitz)
93
94   * Distinguish between missing files and read errors in HTTP server.
95     (Dave Borowitz)
96
97   * Initial work on support for fastimport using python-fastimport.
98     (Jelmer Vernooij)
99
100   * New dulwich.pack.MemoryPackIndex class. (Jelmer Vernooij)
101
102   * Delegate SHA peeling to the object store.  (Dave Borowitz)
103
104  TESTS
105
106   * Use GitFile when modifying packed-refs in tests. (Dave Borowitz)
107
108   * New tests in test_web with better coverage and fewer ad-hoc mocks.
109     (Dave Borowitz)
110
111   * Standardize quote delimiters in test_protocol. (Dave Borowitz)
112
113   * Fix use when testtools is installed. (Jelmer Vernooij)
114
115   * Add trivial test for write_pack_header. (Jelmer Vernooij)
116
117   * Refactor some of dulwich.tests.compat.server_utils. (Dave Borowitz)
118
119   * Allow overwriting id property of objects in test utils. (Dave Borowitz)
120
121   * Use real in-memory objects rather than stubs for server tests.
122     (Dave Borowitz)
123
124   * Clean up MissingObjectFinder. (Dave Borowitz)
125
126  API CHANGES
127
128   * ObjectStore.iter_tree_contents now walks contents in depth-first, sorted
129     order. (Dave Borowitz)
130
131   * ObjectStore.iter_tree_contents can optionally yield tree objects as well.
132     (Dave Borowitz).
133
134   * Add side-band-64k support to ReceivePackHandler. (Dave Borowitz)
135
136   * Change server capabilities methods to classmethods. (Dave Borowitz)
137
138   * Tweak server handler injection. (Dave Borowitz)
139
140   * PackIndex1 and PackIndex2 now subclass FilePackIndex, which is 
141     itself a subclass of PackIndex. (Jelmer Vernooij)
142
143  DOCUMENTATION
144
145   * Add docstrings for various functions in dulwich.objects. (Jelmer Vernooij)
146
147   * Clean up docstrings in dulwich.protocol. (Dave Borowitz)
148
149   * Explicitly specify allowed protocol commands to
150     ProtocolGraphWalker.read_proto_line.  (Dave Borowitz)
151
152   * Add utility functions to DictRefsContainer. (Dave Borowitz)
153
154
155 0.6.1   2010-07-22
156
157  BUG FIXES
158
159   * Fix memory leak in C implementation of sorted_tree_items. (Dave Borowitz)
160
161   * Use correct path separators for named repo files. (Dave Borowitz)
162
163   * python > 2.7 and testtools-based test runners will now also pick up skipped
164     tests correctly. (Jelmer Vernooij)
165
166  FEATURES
167
168   * Move named file initilization to BaseRepo. (Dave Borowitz)
169
170   * Add logging utilities and git/HTTP server logging. (Dave Borowitz)
171
172   * The GitClient interface has been cleaned up and instances are now reusable.
173     (Augie Fackler)
174
175   * Allow overriding paths to executables in GitSSHClient. 
176     (Ross Light, Jelmer Vernooij, #585204)
177
178   * Add PackBasedObjectStore.pack_loose_objects(). (Jelmer Vernooij)
179
180  TESTS
181
182   * Add tests for sorted_tree_items and C implementation. (Dave Borowitz)
183
184   * Add a MemoryRepo that stores everything in memory. (Dave Borowitz)
185
186   * Quiet logging output from web tests. (Dave Borowitz)
187
188   * More flexible version checking for compat tests. (Dave Borowitz)
189
190   * Compat tests for servers with and without side-band-64k. (Dave Borowitz)
191
192  CLEANUP
193
194   * Clean up file headers. (Dave Borowitz)
195
196  TESTS
197
198   * Use GitFile when modifying packed-refs in tests. (Dave Borowitz)
199
200  API CHANGES
201
202   * dulwich.pack.write_pack_index_v{1,2} now take a file-like object
203     rather than a filename. (Jelmer Vernooij)
204
205   * Make dul-daemon/dul-web trivial wrappers around server functionality.
206     (Dave Borowitz)
207
208   * Move reference WSGI handler to web.py. (Dave Borowitz)
209
210   * Factor out _report_status in ReceivePackHandler. (Dave Borowitz)
211
212   * Factor out a function to convert a line to a pkt-line. (Dave Borowitz)
213
214
215 0.6.0   2010-05-22
216
217 note: This list is most likely incomplete for 0.6.0.
218
219  BUG FIXES
220  
221   * Fix ReceivePackHandler to disallow removing refs without delete-refs.
222     (Dave Borowitz)
223
224   * Deal with capabilities required by the client, even if they 
225     can not be disabled in the server. (Dave Borowitz)
226
227   * Fix trailing newlines in generated patch files.
228     (Jelmer Vernooij)
229
230   * Implement RefsContainer.__contains__. (Jelmer Vernooij)
231
232   * Cope with \r in ref files on Windows. (
233     http://github.com/jelmer/dulwich/issues/#issue/13, Jelmer Vernooij)
234
235   * Fix GitFile breakage on Windows. (Anatoly Techtonik, #557585)
236
237   * Support packed ref deletion with no peeled refs. (Augie Fackler)
238
239   * Fix send pack when there is nothing to fetch. (Augie Fackler)
240
241   * Fix fetch if no progress function is specified. (Augie Fackler)
242
243   * Allow double-staging of files that are deleted in the index. 
244     (Dave Borowitz)
245
246   * Fix RefsContainer.add_if_new to support dangling symrefs.
247     (Dave Borowitz)
248
249   * Non-existant index files in non-bare repositories are now treated as 
250     empty. (Dave Borowitz)
251
252   * Always update ShaFile.id when the contents of the object get changed. 
253     (Jelmer Vernooij)
254
255   * Various Python2.4-compatibility fixes. (Dave Borowitz)
256
257   * Fix thin pack handling. (Dave Borowitz)
258  
259  FEATURES
260
261   * Add include-tag capability to server. (Dave Borowitz)
262
263   * New dulwich.fastexport module that can generate fastexport 
264     streams. (Jelmer Vernooij)
265
266   * Implemented BaseRepo.__contains__. (Jelmer Vernooij)
267
268   * Add __setitem__ to DictRefsContainer. (Dave Borowitz)
269
270   * Overall improvements checking Git objects. (Dave Borowitz)
271
272   * Packs are now verified while they are received. (Dave Borowitz)
273
274  TESTS
275
276   * Add framework for testing compatibility with C Git. (Dave Borowitz)
277
278   * Add various tests for the use of non-bare repositories. (Dave Borowitz)
279
280   * Cope with diffstat not being available on all platforms. 
281     (Tay Ray Chuan, Jelmer Vernooij)
282
283   * Add make_object and make_commit convenience functions to test utils.
284     (Dave Borowitz)
285
286  API BREAKAGES
287
288   * The 'committer' and 'message' arguments to Repo.do_commit() have 
289     been swapped. 'committer' is now optional. (Jelmer Vernooij)
290
291   * Repo.get_blob, Repo.commit, Repo.tag and Repo.tree are now deprecated.
292     (Jelmer Vernooij)
293
294   * RefsContainer.set_ref() was renamed to RefsContainer.set_symbolic_ref(),
295     for clarity. (Jelmer Vernooij)
296
297  API CHANGES
298
299   * The primary serialization APIs in dulwich.objects now work 
300     with chunks of strings rather than with full-text strings. 
301     (Jelmer Vernooij)
302
303 0.5.02010-03-03
304
305  BUG FIXES
306
307   * Support custom fields in commits (readonly). (Jelmer Vernooij)
308
309   * Improved ref handling. (Dave Borowitz)
310
311   * Rework server protocol to be smarter and interoperate with cgit client.
312     (Dave Borowitz)
313
314   * Add a GitFile class that uses the same locking protocol for writes as 
315     cgit. (Dave Borowitz)
316
317   * Cope with forward slashes correctly in the index on Windows.
318     (Jelmer Vernooij, #526793)
319
320  FEATURES
321
322   * --pure option to setup.py to allow building/installing without the C 
323     extensions. (Hal Wine, Anatoly Techtonik, Jelmer Vernooij, #434326)
324
325   * Implement Repo.get_config(). (Jelmer Vernooij, Augie Fackler)
326
327   * HTTP dumb and smart server. (Dave Borowitz)
328
329   * Add abstract baseclass for Repo that does not require file system 
330     operations. (Dave Borowitz)
331
332 0.4.1   2010-01-03
333
334  FEATURES
335
336   * Add ObjectStore.iter_tree_contents(). (Jelmer Vernooij)
337
338   * Add Index.changes_from_tree(). (Jelmer Vernooij)
339
340   * Add ObjectStore.tree_changes(). (Jelmer Vernooij)
341
342   * Add functionality for writing patches in dulwich.patch.
343     (Jelmer Vernooij)
344
345 0.4.0   2009-10-07
346
347  DOCUMENTATION
348
349   * Added tutorial.
350
351  API CHANGES
352
353   * dulwich.object_store.tree_lookup_path will now return the mode and 
354     sha of the object found rather than the object itself.
355
356  BUG FIXES
357
358   * Use binascii.hexlify / binascii.unhexlify for better performance.
359
360   * Cope with extra unknown data in index files by ignoring it (for now).
361
362   * Add proper error message when server unexpectedly hangs up. (#415843)
363
364   * Correctly write opcode for equal in create_delta.
365
366 0.3.3   2009-07-23
367
368  FEATURES
369
370   * Implement ShaFile.__hash__().
371
372   * Implement Tree.__len__()
373
374  BUG FIXES
375   
376   * Check for 'objects' and 'refs' directories
377     when looking for a Git repository. (#380818)
378
379 0.3.2   2009-05-20
380
381  BUG FIXES
382
383   * Support the encoding field in Commits.
384   
385   * Some Windows compatibility fixes.
386
387   * Fixed several issues in commit support.
388
389  FEATURES
390
391   * Basic support for handling submodules.
392
393 0.3.1   2009-05-13
394
395  FEATURES
396
397   * Implemented Repo.__getitem__, Repo.__setitem__ and Repo.__delitem__ to 
398     access content.
399
400  API CHANGES
401
402   * Removed Repo.set_ref, Repo.remove_ref, Repo.tags, Repo.get_refs and 
403     Repo.heads in favor of Repo.refs, a dictionary-like object for accessing
404     refs.
405
406  BUG FIXES
407
408   * Removed import of 'sha' module in objects.py, which was causing 
409     deprecation warnings on Python 2.6.
410
411 0.3.0   2009-05-10
412
413  FEATURES
414
415   * A new function 'commit_tree' has been added that can commit a tree 
416     based on an index.
417
418  BUG FIXES
419
420   * The memory usage when generating indexes has been significantly reduced.
421  
422   * A memory leak in the C implementation of parse_tree has been fixed.
423
424   * The send-pack smart server command now works. (Thanks Scott Chacon)
425
426   * The handling of short timestamps (less than 10 digits) has been fixed.
427
428   * The handling of timezones has been fixed.
429
430 0.2.1   2009-04-30
431
432  BUG FIXES
433
434   * Fix compatibility with Python2.4.
435
436 0.2.0   2009-04-30
437
438  FEATURES
439
440   * Support for activity reporting in smart protocol client.
441
442   * Optional C extensions for better performance in a couple of 
443     places that are performance-critical.
444
445 0.1.1   2009-03-13
446
447  BUG FIXES
448
449   * Fixed regression in Repo.find_missing_objects()
450
451   * Don't fetch ^{} objects from remote hosts, as requesting them 
452     causes a hangup.
453
454   * Always write pack to disk completely before calculating checksum.
455
456  FEATURES
457
458   * Allow disabling thin packs when talking to remote hosts.
459
460 0.1.0   2009-01-24
461
462  * Initial release.