NEWS

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