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