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