reset: make sparse-aware (except --mixed)
[git.git] / Documentation / RelNotes / 2.34.0.txt
blob9d583ead0406126715e43b13cb033e62ad71ac2e
1 Git 2.34 Release Notes
2 ======================
4 Updates since Git 2.33
5 ----------------------
7 UI, Workflows & Features
9  * Pathname expansion (like "~username/") learned a way to specify a
10    location relative to Git installation (e.g. its $sharedir which is
11    $(prefix)/share), with "%(prefix)".
13  * Use `ort` instead of `recursive` as the default merge strategy.
15  * The userdiff pattern for "java" language has been updated.
17  * "git rebase" by default skips changes that are equivalent to
18    commits that are already in the history the branch is rebased onto;
19    give messages when this happens to let the users be aware of
20    skipped commits, and also teach them how to tell "rebase" to keep
21    duplicated changes.
23  * The advice message that "git cherry-pick" gives when it asks
24    conflicted replay of a commit to be resolved by the end user has
25    been updated.
27  * After "git clone --recurse-submodules", all submodules are cloned
28    but they are not by default recursed into by other commands.  With
29    submodule.stickyRecursiveClone configuration set, submodule.recurse
30    configuration is set to true in a repository created by "clone"
31    with "--recurse-submodules" option.
33  * The logic for auto-correction of misspelt subcommands learned to go
34    interactive when the help.autocorrect configuration variable is set
35    to 'prompt'.
37  * "git maintenance" scheduler learned to use systemd timers as a
38    possible backend.
40  * "git diff --submodule=diff" showed failure from run_command() when
41    trying to run diff inside a submodule, when the user manually
42    removes the submodule directory.
44  * "git bundle unbundle" learned to show progress display.
46  * In cone mode, the sparse-index code path learned to remove ignored
47    files (like build artifacts) outside the sparse cone, allowing the
48    entire directory outside the sparse cone to be removed, which is
49    especially useful when the sparse patterns change.
51  * Taking advantage of the CGI interface, http-backend has been
52    updated to enable protocol v2 automatically when the other side
53    asks for it.
55  * The credential-cache helper has been adjusted to Windows.
57  * The error in "git help no-such-git-command" is handled better.
59  * The unicode character width table (used for output alignment) has
60    been updated.
62  * The ref iteration code used to optionally allow dangling refs to be
63    shown, which has been tightened up.
66 Performance, Internal Implementation, Development Support etc.
68  * "git bisect" spawned "git show-branch" only to pretty-print the
69    title of the commit after checking out the next version to be
70    tested; this has been rewritten in C.
72  * "git add" can work better with the sparse index.
74  * Support for ancient versions of cURL library (pre 7.19.4) has been
75    dropped.
77  * A handful of tests that assumed implementation details of files
78    backend for refs have been cleaned up.
80  * trace2 logs learned to show parent process name to see in what
81    context Git was invoked.
83  * Loading of ref tips to prepare for common ancestry negotiation in
84    "git fetch-pack" has been optimized by taking advantage of the
85    commit graph when available.
87  * Remind developers that the userdiff patterns should be kept simple
88    and permissive, assuming that the contents they apply are always
89    syntactically correct.
91  * The current implementation of GIT_TEST_FAIL_PREREQS is broken in
92    that checking for the lack of a prerequisite would not work.  Avoid
93    the use of "if ! test_have_prereq X" in a test script.
95  * The revision traversal API has been optimized by taking advantage
96    of the commit-graph, when available, to determine if a commit is
97    reachable from any of the existing refs.
99  * "git fetch --quiet" optimization to avoid useless computation of
100    info that will never be displayed.
102  * Callers from older advice_config[] based API has been updated to
103    use the newer advice_if_enabled() and advice_enabled() API.
105  * Teach "test_pause" and "debug" helpers to allow using the HOME and
106    TERM environment variables the user usually uses.
108  * "make INSTALL_STRIP=-s install" allows the installation step to use
109    "install -s" to strip the binaries as they get installed.
111  * Code that handles large number of refs in the "git fetch" code
112    path has been optimized.
114  * The reachability bitmap file used to be generated only for a single
115    pack, but now we've learned to generate bitmaps for history that
116    span across multiple packfiles.
118  * The code to make "git grep" recurse into submodules has been
119    updated to migrate away from the "add submodule's object store as
120    an alternate object store" mechanism (which is suboptimal).
122  * The tracing of process ancestry information has been enhanced.
124  * Reduce number of write(2) system calls while sending the
125    ref advertisement.
127  * Update the build procedure to use the "-pedantic" build when
128    DEVELOPER makefile macro is in effect.
130  * Large part of "git submodule add" gets rewritten in C.
132  * The run-command API has been updated so that the callers can easily
133    ask the file descriptors open for packfiles to be closed immediately
134    before spawning commands that may trigger auto-gc.
136  * An oddball OPTION_ARGUMENT feature has been removed from the
137    parse-options API.
139  * The mergesort implementation used to sort linked list has been
140    optimized.
142  * Remove external declaration of functions that no longer exist.
145 Fixes since v2.33
146 -----------------
148  * Input validation of "git pack-objects --stdin-packs" has been
149    corrected.
150    (merge 561fa03529 ab/pack-stdin-packs-fix later to maint).
152  * Bugfix for common ancestor negotiation recently introduced in "git
153    push" code path.
154    (merge 82823118b9 jt/push-negotiation-fixes later to maint).
156  * "git pull" had various corner cases that were not well thought out
157    around its --rebase backend, e.g. "git pull --ff-only" did not stop
158    but went ahead and rebased when the history on other side is not a
159    descendant of our history.  The series tries to fix them up.
160    (merge 6f843a3355 en/pull-conflicting-options later to maint).
162  * "git apply" miscounted the bytes and failed to read to the end of
163    binary hunks.
164    (merge 46d723ce57 jk/apply-binary-hunk-parsing-fix later to maint).
166  * "git range-diff" code clean-up.
167    (merge c4d5907324 jk/range-diff-fixes later to maint).
169  * "git commit --fixup" now works with "--edit" again, after it was
170    broken in v2.32.
171    (merge 8ef6aad664 jk/commit-edit-fixup-fix later to maint).
173  * Use upload-artifacts v1 (instead of v2) for 32-bit linux, as the
174    new version has a blocker bug for that architecture.
175    (merge 3cf9bb36bf cb/ci-use-upload-artifacts-v1 later to maint).
177  * Checking out all the paths from HEAD during the last conflicted
178    step in "git rebase" and continuing would cause the step to be
179    skipped (which is expected), but leaves MERGE_MSG file behind in
180    $GIT_DIR and confuses the next "git commit", which has been
181    corrected.
182    (merge e5ee33e855 pw/rebase-skip-final-fix later to maint).
184  * Various bugs in "git rebase -r" have been fixed.
185    (merge f2563c9ef3 pw/rebase-r-fixes later to maint).
187  * mmap() imitation used to call xmalloc() that dies upon malloc()
188    failure, which has been corrected to just return an error to the
189    caller to be handled.
190    (merge 95b4ff3931 rs/git-mmap-uses-malloc later to maint).
192  * "git diff --relative" segfaulted and/or produced incorrect result
193    when there are unmerged paths.
194    (merge 8174627b3d dd/diff-files-unmerged-fix later to maint).
196  * The delayed checkout code path in "git checkout" etc. were chatty
197    even when --quiet and/or --no-progress options were given.
198    (merge 7a132c628e mt/quiet-with-delayed-checkout later to maint).
200  * "git branch -D <branch>" used to refuse to remove a broken branch
201    ref that points at a missing commit, which has been corrected.
202    (merge 597a977489 rs/branch-allow-deleting-dangling later to maint).
204  * Build update for Apple clang.
205    (merge f32c5d3716 cb/makefile-apple-clang later to maint).
207  * The parser for the "--nl" option of "git column" has been
208    corrected.
209    (merge c93ca46cf5 sg/column-nl later to maint).
211  * "git upload-pack" which runs on the other side of "git fetch"
212    forgot to take the ref namespaces into account when handling
213    want-ref requests.
214    (merge 53a66ec37c ka/want-ref-in-namespace later to maint).
216  * The sparse-index support can corrupt the index structure by storing
217    a stale and/or uninitialized data, which has been corrected.
218    (merge d9e9b44d7a jh/sparse-index-resize-fix later to maint).
220  * Buggy tests could damage repositories outside the throw-away test
221    area we created.  We now by default export GIT_CEILING_DIRECTORIES
222    to limit the damage from such a stray test.
223    (merge 614c3d8f2e sg/set-ceiling-during-tests later to maint).
225  * Even when running "git send-email" without its own threaded
226    discussion support, a threading related header in one message is
227    carried over to the subsequent message to result in an unwanted
228    threading, which has been corrected.
229    (merge e082113484 mh/send-email-reset-in-reply-to later to maint).
231  * The output from "git fast-export", when its anonymization feature
232    is in use, showed an annotated tag incorrectly.
233    (merge 2f040a9671 tk/fast-export-anonymized-tag-fix later to maint).
235  * Doc update plus improved error reporting.
236    (merge 1e93770888 jk/log-warn-on-bogus-encoding later to maint).
238  * Recent "diff -m" changes broke "gitk", which has been corrected.
239    (merge 5acffd3473 so/diff-index-regression-fix later to maint).
241  * Regression fix.
242    (merge b996f84989 ab/send-email-config-fix later to maint).
244  * The "git apply -3" code path learned not to bother the lower level
245    merge machinery when the three-way merge can be trivially resolved
246    without the content level merge.  This fixes a regression caused by
247    recent "-3way first and fall back to direct application" change.
248    (merge 57f183b698 jc/trivial-threeway-binary-merge later to maint).
250  * The code that optionally creates the *.rev reverse index file has
251    been optimized to avoid needless computation when it is not writing
252    the file out.
253    (merge 8fe8bae9d2 ab/reverse-midx-optim later to maint).
255  * "git range-diff -I... <range> <range>" segfaulted, which has been
256    corrected.
257    (merge 709b3f32d3 rs/range-diff-avoid-segfault-with-I later to maint).
259  * The order in which various files that make up a single (conceptual)
260    packfile has been reevaluated and straightened up.  This matters in
261    correctness, as an incomplete set of files must not be shown to a
262    running Git.
263    (merge 4bc1fd6e39 tb/pack-finalize-ordering later to maint).
265  * The "mode" word is useless in a call to open(2) that does not
266    create a new file.  Such a call in the files backend of the ref
267    subsystem has been cleaned up.
268    (merge 35cf94eaf6 rs/no-mode-to-open-when-appending later to maint).
270  * "git update-ref --stdin" failed to flush its output as needed,
271    which potentially led the conversation to a deadlock.
272    (merge 7c1200745b ps/update-ref-batch-flush later to maint).
274  * When "git am --abort" fails to abort correctly, it still exited
275    with exit status of 0, which has been corrected.
276    (merge c5ead19ea2 en/am-abort-fix later to maint).
278  * Correct nr and alloc members of strvec struct to be of type size_t.
279    (merge 8d133a4653 jk/strvec-typefix later to maint).
281  * "git stash", where the tentative change involves changing a
282    directory to a file (or vice versa), was confused, which has been
283    corrected.
284    (merge bee8691f19 en/stash-df-fix later to maint).
286  * "git clone" from a repository whose HEAD is unborn into a bare
287    repository didn't follow the branch name the other side used, which
288    is corrected.
289    (merge 6b58df54cf jk/clone-unborn-head-in-bare later to maint).
291  * "git cvsserver" had a long-standing bug in its authentication code,
292    which has finally been corrected (it is unclear and is a separate
293    question if anybody is seriously using it, though).
294    (merge 4b81f690f6 cb/cvsserver later to maint).
296  * "git difftool --dir-diff" mishandled symbolic links.
297    (merge 5bafb3576a da/difftool-dir-diff-symlink-fix later to maint).
299  * Sensitive data in the HTTP trace were supposed to be redacted, but
300    we failed to do so in HTTP/2 requests.
301    (merge b66c77a64e jk/http-redact-fix later to maint).
303  * "make clean" has been updated to remove leftover .depend/
304    directories, even when it is not told to use them to compute header
305    dependencies.
306    (merge f0a74bcb03 ab/make-clean-depend-dirs later to maint).
308  * Protocol v0 clients can get stuck parsing a malformed feature line.
309    (merge 44d2aec6e8 ah/connect-parse-feature-v0-fix later to maint).
311  * Other code cleanup, docfix, build fix, etc.
312    (merge 1d9c8daef8 ab/bundle-doc later to maint).
313    (merge 81483fe613 en/merge-strategy-docs later to maint).
314    (merge 626beebdf8 js/log-protocol-version later to maint).
315    (merge 00e302da76 cb/builtin-merge-format-string-fix later to maint).
316    (merge ad51ae4dc0 cb/ci-freebsd-update later to maint).
317    (merge be6444d1ca fc/completion-updates later to maint).
318    (merge ff7b83f562 ti/tcsh-completion-regression-fix later to maint).
319    (merge 325b06deda sg/make-fix-ar-invocation later to maint).
320    (merge bd72824c60 me/t5582-cleanup later to maint).
321    (merge f6a5af0f62 ga/send-email-sendmail-cmd later to maint).
322    (merge f58c7468cd ab/ls-remote-packet-trace later to maint).
323    (merge 0160f7e725 ab/rebase-fatal-fatal-fix later to maint).
324    (merge a16eb6b1ff js/maintenance-launchctl-fix later to maint).
325    (merge c21b2511c2 jk/t5323-no-pack-test-fix later to maint).
326    (merge 5146c2f148 mh/credential-leakfix later to maint).
327    (merge 1549577338 dd/t6300-wo-gpg-fix later to maint).
328    (merge 66e905b7dd rs/xopen-reports-open-failures later to maint).
329    (merge 469888e6a5 es/walken-tutorial-fix later to maint).
330    (merge 88682b016d ba/object-info later to maint).
331    (merge b45c172e51 ab/gc-log-rephrase later to maint).
332    (merge ccdd5d1eb1 ab/mailmap-leakfix later to maint).
333    (merge 6540b71614 cb/remote-ndebug-fix later to maint).
334    (merge e4f8d27585 rs/show-branch-simplify later to maint).
335    (merge e124ecf7f7 rs/archive-use-object-id later to maint).
336    (merge cebead1ebf cb/ci-build-pedantic later to maint).
337    (merge ca0cc98e03 bs/doc-bugreport-outdir later to maint).
338    (merge 72b113e562 ab/no-more-check-bindir later to maint).
339    (merge 92a5d1c9b4 jc/prefix-filename-allocates later to maint).
340    (merge d9a65b6c0a rs/setup-use-xopen-and-xdup later to maint).
341    (merge e8f55568de jk/t5562-racefix later to maint).
342    (merge 8f0f110156 rs/drop-core-compression-vars later to maint).
343    (merge b6d8887d3d ma/doc-git-version later to maint).
344    (merge 66c0c44df6 cb/plug-leaks-in-alloca-emu-users later to maint).
345    (merge afb32e8101 kz/revindex-comment-fix later to maint).
346    (merge ae578de926 po/git-config-doc-mentions-help-c later to maint).
347    (merge 187fc8b8b6 cb/unicode-14 later to maint).
348    (merge 3584cff71c en/typofixes later to maint).
349    (merge f188160be9 ab/bundle-remove-verbose-option later to maint).
350    (merge 8c6b4332b4 rs/close-pack-leakfix later to maint).
351    (merge 51b04c05b7 bs/difftool-msg-tweak later to maint).
352    (merge dd20e4a6db ab/make-compdb-fix later to maint).
353    (merge 6ffb990dc4 os/status-docfix later to maint).