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