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