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