http: redact all cookies, teach GIT_TRACE_REDACT=0
[git] / Documentation / RelNotes / 2.27.0.txt
1 Git 2.27 Release Notes
2 ======================
3
4 Updates since v2.26
5 -------------------
6
7 Backward compatibility notes
8
9  * When "git describe C" finds that commit C is pointed by a signed or
10    annotated tag, which records T as its tagname in the object, the
11    command gives T as its answer.  Even if the user renames or moves
12    such a tag from its natural location in the "refs/tags/" hierarchy,
13    "git describe C" would still give T as the answer, but in such a
14    case "git show T^0" would no longer work as expected.  There may be
15    nothing at "refs/tags/T" or even worse there may be a different tag
16    instead.
17
18    Starting from this version, "git describe" will always use the
19    "long" version, as if the "--long" option were given, when giving
20    its output based on such a misplaced tag to work around the problem.
21
22  * "git pull" issues a warning message until the pull.rebase
23    configuration variable is explicitly given, which some existing
24    users may find annoying---those who prefer not to rebase need to
25    set the variable to false to squelch the warning.
26
27
28 UI, Workflows & Features
29
30  * A handful of options to configure SSL when talking to proxies have
31    been added.
32
33  * Smudge/clean conversion filters are now given more information
34    (e.g. the object of the tree-ish in which the blob being converted
35    appears, in addition to its path, which has already been given).
36
37  * When "git describe C" finds an annotated tag with tagname A to be
38    the best name to explain commit C, and the tag is stored in a
39    "wrong" place in the refs/tags hierarchy, e.g. refs/tags/B, the
40    command gave a warning message but used A (not B) to describe C.
41    If C is exactly at the tag, the describe output would be "A", but
42    "git rev-parse A^0" would not be equal as "git rev-parse C^0".  The
43    behavior of the command has been changed to use the "long" form
44    i.e. A-0-gOBJECTNAME, which is correctly interpreted by rev-parse.
45
46  * "git pull" learned to warn when no pull.rebase configuration
47    exists, and neither --[no-]rebase nor --ff-only is given (which
48    would result a merge).
49
50  * "git p4" learned four new hooks and also "--no-verify" option to
51    bypass them (and the existing "p4-pre-submit" hook).
52
53  * "git pull" shares many options with underlying "git fetch", but
54    some of them were not documented and some of those that would make
55    sense to pass down were not passed down.
56
57  * "git rebase" learned the "--no-gpg-sign" option to countermand
58    commit.gpgSign the user may have.
59
60  * The output from "git format-patch" uses RFC 2047 encoding for
61    non-ASCII letters on From: and Subject: headers, so that it can
62    directly be fed to e-mail programs.  A new option has been added
63    to produce these headers in raw.
64
65  * "git log" learned "--show-pulls" that helps pathspec limited
66    history views; a merge commit that takes the whole change from a
67    side branch, which is normally omitted from the output, is shown
68    in addition to the commits that introduce real changes.
69
70  * The interactive input from various codepaths are consolidated and
71    any prompt possibly issued earlier are fflush()ed before we read.
72
73  * Allow "git rebase" to reapply all local commits, even if the may be
74    already in the upstream, without checking first.
75
76  * The 'pack.useSparse' configuration variable now defaults to 'true',
77    enabling an optimization that has been experimental since Git 2.21.
78
79  * "git rebase" happens to call some hooks meant for "checkout" and
80    "commit" by this was not a designed behaviour than historical
81    accident.  This has been documented.
82
83  * "git merge" learns the "--autostash" option.
84
85  * "sparse-checkout" UI improvements.
86
87  * "git update-ref --stdin" learned a handful of new verbs to let the
88    user control ref update transactions more explicitly, which helps
89    as an ingredient to implement two-phase commit-style atomic
90    ref-updates across multiple repositories.
91
92  * "git commit-graph write" learned different ways to write out split
93    files.
94
95  * Introduce an extension to the commit-graph to make it efficient to
96    check for the paths that were modified at each commit using Bloom
97    filters.
98
99  * The approxidate parser learns to parse seconds with fraction and
100    ignore fractional part.
101
102  * The userdiff patterns for Markdown documents have been added.
103
104  * The sparse-checkout patterns have been forbidden from excluding all
105    paths, leaving an empty working tree, for a long time.  This
106    limitation has been lifted.
107
108  * "git restore --staged --worktree" now defaults to take the contents
109    out of "HEAD", instead of erring out.
110
111
112 Performance, Internal Implementation, Development Support etc.
113
114  * The advise API has been revamped to allow more systematic enumeration of
115    advice knobs in the future.
116
117  * SHA-256 transition continues.
118
119  * The code to interface with GnuPG has been refactored.
120
121  * "git stash" has kept an escape hatch to use the scripted version
122    for a few releases, which got stale.  It has been removed.
123
124  * Enable tests that require GnuPG on Windows.
125
126  * Minor test usability improvement.
127
128  * Trace2 enhancement to allow logging of the environment variables.
129
130  * Test clean-up continues.
131
132  * Perf-test update.
133
134  * A Windows-specific test element has been made more robust against
135    misuse from both user's environment and programmer's errors.
136
137  * Various tests have been updated to work around issues found with
138    shell utilities that come with busybox etc.
139
140  * The config API made mixed uses of int and size_t types to represent
141    length of various pieces of text it parsed, which has been updated
142    to use the correct type (i.e. size_t) throughout.
143
144  * The "--decorate-refs" and "--decorate-refs-exclude" options "git
145    log" takes have learned a companion configuration variable
146    log.excludeDecoration that sits at the lowest priority in the
147    family.
148
149  * A new CI job to build and run test suite on linux with musl libc
150    has been added.
151
152  * Update the CI configuration to use GitHub Actions, retiring the one
153    based on Azure Pipelines.
154
155  * The directory traversal code had redundant recursive calls which
156    made its performance characteristics exponential with respect to
157    the depth of the tree, which was corrected.
158
159  * "git blame" learns to take advantage of the "changed-paths" Bloom
160    filter stored in the commit-graph file.
161
162  * The "bugreport" tool has been added.
163
164
165 Fixes since v2.26
166 -----------------
167
168  * The real_path() convenience function can easily be misused; with a
169    bit of code refactoring in the callers' side, its use has been
170    eliminated.
171    (merge 49d3c4b481 am/real-path-fix later to maint).
172
173  * Update "git p4" to work with Python 3.
174    (merge 6bb40ed20a yz/p4-py3 later to maint).
175
176  * The mechanism to prevent "git commit" from making an empty commit
177    or amending during an interrupted cherry-pick was broken during the
178    rewrite of "git rebase" in C, which has been corrected.
179    (merge 430b75f720 pw/advise-rebase-skip later to maint).
180
181  * Fix "git checkout --recurse-submodules" of a nested submodule
182    hierarchy.
183    (merge 846f34d351 pb/recurse-submodules-fix later to maint).
184
185  * The "--fork-point" mode of "git rebase" regressed when the command
186    was rewritten in C back in 2.20 era, which has been corrected.
187    (merge f08132f889 at/rebase-fork-point-regression-fix later to maint).
188
189  * The import-tars importer (in contrib/fast-import/) used to create
190    phony files at the top-level of the repository when the archive
191    contains global PAX headers, which made its own logic to detect and
192    omit the common leading directory ineffective, which has been
193    corrected.
194    (merge c839fcff65 js/import-tars-do-not-make-phony-files-from-pax-headers later to maint).
195
196  * Simplify the commit ancestry connectedness check in a partial clone
197    repository in which "promised" objects are assumed to be obtainable
198    lazily on-demand from promisor remote repositories.
199    (merge 2b98478c6f jt/connectivity-check-optim-in-partial-clone later to maint).
200
201  * The server-end of the v2 protocol to serve "git clone" and "git
202    fetch" was not prepared to see a delim packets at unexpected
203    places, which led to a crash.
204    (merge cacae4329f jk/harden-protocol-v2-delim-handling later to maint).
205
206  * When fed a midx that records no objects, some codepaths tried to
207    loop from 0 through (num_objects-1), which, due to integer
208    arithmetic wrapping around, made it nonsense operation with out of
209    bounds array accesses.  The code has been corrected to reject such
210    an midx file.
211    (merge 796d61cdc0 dr/midx-avoid-int-underflow later to maint).
212
213  * Utitiles run via the run_command() API were not spawned correctly
214    on Cygwin, when the paths to them are given as a full path with
215    backslashes.
216    (merge 05ac8582bc ak/run-command-on-cygwin-fix later to maint).
217
218  * "git pull --rebase" tried to run a rebase even after noticing that
219    the pull results in a fast-forward and no rebase is needed nor
220    sensible, for the past few years due to a mistake nobody noticed.
221    (merge fbae70ddc6 en/pull-do-not-rebase-after-fast-forwarding later to maint).
222
223  * "git rebase" with the merge backend did not work well when the
224    rebase.abbreviateCommands configuration was set.
225    (merge de9f1d3ef4 ag/rebase-merge-allow-ff-under-abbrev-command later to maint).
226
227  * The logic to auto-follow tags by "git clone --single-branch" was
228    not careful to avoid lazy-fetching unnecessary tags, which has been
229    corrected.
230    (merge 167a575e2d jk/use-quick-lookup-in-clone-for-tag-following later to maint).
231
232  * "git rebase -i" did not leave the reflog entries correctly.
233    (merge 1f6965f994 en/sequencer-reflog-action later to maint).
234
235  * The more aggressive updates to remote-tracking branches we had for
236    the past 7 years or so were not reflected in the documentation,
237    which has been corrected.
238    (merge a44088435c pb/pull-fetch-doc later to maint).
239
240  * We've left the command line parsing of "git log :/a/b/" broken for
241    about a full year without anybody noticing, which has been
242    corrected.
243    (merge 0220461071 jc/missing-ref-store-fix later to maint).
244
245  * Misc fixes for Windows.
246    (merge 3efc128cd5 js/mingw-fixes later to maint).
247
248  * "git rebase" (again) learns to honor "--no-keep-empty", which lets
249    the user to discard commits that are empty from the beginning (as
250    opposed to the ones that become empty because of rebasing).  The
251    interactive rebase also marks commits that are empty in the todo.
252    (merge 50ed76148a en/rebase-no-keep-empty later to maint).
253
254  * Parsing the host part out of URL for the credential helper has been corrected.
255    (merge 4c5971e18a jk/credential-parsing-end-of-host-in-URL later to maint).
256
257  * Document the recommended way to abort a failing test early (e.g. by
258    exiting a loop), which is to say "return 1".
259    (merge 7cc112dc95 jc/doc-test-leaving-early later to maint).
260
261  * The code that refreshes the last access and modified time of
262    on-disk packfiles and loose object files have been updated.
263    (merge 312cd76130 lr/freshen-file-fix later to maint).
264
265  * Validation of push certificate has been made more robust against
266    timing attacks.
267    (merge 719483e547 bc/constant-memequal later to maint).
268
269  * The custom hash function used by "git fast-import" has been
270    replaced with the one from hashmap.c, which gave us a nice
271    performance boost.
272    (merge d8410a816b jk/fast-import-use-hashmap later to maint).
273
274  * The "git submodule" command did not initialize a few variables it
275    internally uses and was affected by variable settings leaked from
276    the environment.
277    (merge 65d100c4dd lx/submodule-clear-variables later to maint).
278
279  * Raise the minimum required version of docbook-xsl package to 1.74,
280    as 1.74.0 was from late 2008, which is more than 10 years old, and
281    drop compatibility cruft from our documentation suite.
282    (merge 3c255ad660 ma/doc-discard-docbook-xsl-1.73 later to maint).
283
284  * "git log" learns "--[no-]mailmap" as a synonym to "--[no-]use-mailmap"
285    (merge 88acccda38 jc/log-no-mailmap later to maint).
286
287  * "git commit-graph write --expire-time=<timestamp>" did not use the
288    given timestamp correctly, which has been corrected.
289    (merge b09b785c78 ds/commit-graph-expiry-fix later to maint).
290
291  * Tests update to use "test-chmtime" instead of "touch -t".
292    (merge e892a56845 ds/t5319-touch-fix later to maint).
293
294  * "git diff" in a partial clone learned to avoid lazy loading blob
295    objects in more casese when they are not needed.
296    (merge 95acf11a3d jt/avoid-prefetch-when-able-in-diff later to maint).
297
298  * "git push --atomic" used to show failures for refs that weren't
299    even pushed, which has been corrected.
300    (merge dfe1b7f19c jx/atomic-push later to maint).
301
302  * Code in builtin/*, i.e. those can only be called from within
303    built-in subcommands, that implements bulk of a couple of
304    subcommands have been moved to libgit.a so that they could be used
305    by others.
306    (merge 9460fd48b5 dl/libify-a-few later to maint).
307
308  * Allowing the user to split a patch hunk while "git stash -p" does
309    not work well; a band-aid has been added to make this (partially)
310    work better.
311
312  * "git diff-tree --pretty --notes" used to hit an assertion failure,
313    as it forgot to initialize the notes subsystem.
314    (merge 5778b22b3d tb/diff-tree-with-notes later to maint).
315
316  * "git range-diff" fixes.
317    (merge 8d1675eb7f vd/range-diff-with-custom-pretty-format-fix later to maint).
318
319  * "git grep" did not quote a path with unusual character like other
320    commands (like "git diff", "git status") do, but did quote when run
321    from a subdirectory, both of which has been corrected.
322    (merge 45115d8490 mt/grep-cquote-path later to maint).
323
324  * GNU/Hurd is also among the ones that need the fopen() wrapper.
325    (merge 274a1328fb jc/gnu-hurd-lets-fread-read-dirs later to maint).
326
327  * Those fetching over protocol v2 from linux-next and other kernel
328    repositories are reporting that v2 often fetches way too much than
329    needed.
330    (merge 11c7f2a30b jn/demote-proto2-from-default later to maint).
331
332  * The upload-pack protocol v2 gave up too early before finding a
333    common ancestor, resulting in a wasteful fetch from a fork of a
334    project.  This has been corrected to match the behaviour of v0
335    protocol.
336    (merge 2f0a093dd6 jt/v2-fetch-nego-fix later to maint).
337
338  * The build procedure did not use the libcurl library and its include
339    files correctly for a custom-built installation.
340    (merge 0573831950 jk/build-with-right-curl later to maint).
341
342  * Tighten "git mailinfo" to notice and error out when decoded result
343    contains NUL in it.
344    (merge 3919997447 dd/mailinfo-with-nul later to maint).
345
346  * Fix in-core inconsistency after fetching into a shallow repository
347    that broke the code to write out commit-graph.
348    (merge 37b9dcabfc tb/reset-shallow later to maint).
349
350  * The commit-graph code exhausted file descriptors easily when it
351    does not have to.
352    (merge c8828530b7 tb/commit-graph-fd-exhaustion-fix later to maint).
353
354  * The multi-pack-index left mmapped file descriptors open when it
355    does not have to.
356    (merge 6c7ff7cf7f ds/multi-pack-index later to maint).
357
358  * Recent update to Homebrew used by macOS folks breaks build by
359    moving gettext library and necessary headers.
360    (merge a0b3108618 ds/build-homebrew-gettext-fix later to maint).
361
362  * Incompatible options "--root" and "--fork-point" of "git rebase"
363    have been marked and documented as being incompatible.
364    (merge a35413c378 en/rebase-root-and-fork-point-are-incompatible later to maint).
365
366  * Error and verbose trace messages from "git push" did not redact
367    credential material embedded in URLs.
368    (merge d192fa5006 js/anonymise-push-url-in-errors later to maint).
369
370  * Update the parser used for credential.<URL>.<variable>
371    configuration, to handle <URL>s with '/' in them correctly.
372    (merge b44d0118ac bc/wildcard-credential later to maint).
373
374  * Recent updates broke parsing of "credential.<url>.<key>" where
375    <url> is not a full URL (e.g. [credential "https://"] helper = ...)
376    stopped working, which has been corrected.
377    (merge 9a121b0d22 js/partial-urlmatch-2.17 later to maint).
378    (merge cd93e6c029 js/partial-urlmatch later to maint).
379
380  * Some of the files commit-graph subsystem keeps on disk did not
381    correctly honor the core.sharedRepository settings and some were
382    left read-write.
383
384  * In error messages that "git switch" mentions its option to create a
385    new branch, "-b/-B" options were shown, where "-c/-C" options
386    should be, which has been corrected.
387    (merge 7c16ef7577 dl/switch-c-option-in-error-message later to maint).
388
389  * With the recent tightening of the code that is used to parse
390    various parts of a URL for use in the credential subsystem, a
391    hand-edited credential-store file causes the credential helper to
392    die, which is a bit too harsh to the users.  Demote the error
393    behaviour to just ignore and keep using well-formed lines instead.
394    (merge c03859a665 cb/credential-store-ignore-bogus-lines later to maint).
395
396  * The samples in the credential documentation has been updated to
397    make it clear that we depict what would appear in the .git/config
398    file, by adding appropriate quotes as needed..
399    (merge 177681a07e jk/credential-sample-update later to maint).
400
401  * "git branch" and other "for-each-ref" variants accepted multiple
402    --sort=<key> options in the increasing order of precedence, but it
403    had a few breakages around "--ignore-case" handling, and tie-breaking
404    with the refname, which have been fixed.
405    (merge 7c5045fc18 jk/for-each-ref-multi-key-sort-fix later to maint).
406
407  * The coding guideline for shell scripts instructed to refer to a
408    variable with dollar-sign inside arithmetic expansion to work
409    around a bug in old versions of dash, which is a thing of the past.
410    Now we are not forbidden from writing $((var+1)).
411    (merge 32b5fe7f0e jk/arith-expansion-coding-guidelines later to maint).
412
413  * The <stdlib.h> header on NetBSD brings in its own definition of
414    hmac() function (eek), which conflicts with our own and unrelated
415    function with the same name.  Our function has been renamed to work
416    around the issue.
417    (merge 3013118eb8 cb/avoid-colliding-with-netbsd-hmac later to maint).
418
419  * The basic test did not honor $TEST_SHELL_PATH setting, which has
420    been corrected.
421    (merge 0555e4af58 cb/t0000-use-the-configured-shell later to maint).
422
423  * Other code cleanup, docfix, build fix, etc.
424    (merge 564956f358 jc/maintain-doc later to maint).
425    (merge 7422b2a0a1 sg/commit-slab-clarify-peek later to maint).
426    (merge 9c688735f6 rs/doc-passthru-fetch-options later to maint).
427    (merge 757c2ba3e2 en/oidset-uninclude-hashmap later to maint).
428    (merge 8312aa7d74 jc/config-tar later to maint).
429    (merge d00a5bdd50 ss/submodule-foreach-cb later to maint).
430    (merge 64d1022e14 ar/test-style-fixes later to maint).
431    (merge 4a465443a6 ds/doc-clone-filter later to maint).
432    (merge bb2dbe301b jk/t3419-drop-expensive-tests later to maint).
433    (merge d3507cc712 js/test-junit-finalization-fix later to maint).
434    (merge 2149b6748f bc/faq later to maint).
435    (merge 12dc0879f1 jk/test-cleanup later to maint).
436    (merge 344420bf0f pb/rebase-doc-typofix later to maint).
437    (merge 7cd54d37dc dl/wrapper-fix-indentation later to maint).
438    (merge 78725ebda9 jc/allow-strlen-substitution-in-shell-scripts later to maint).
439    (merge 2ecfcdecc6 jm/gitweb-fastcgi-utf8 later to maint).
440    (merge 0740d0a5d3 jk/oid-array-cleanups later to maint).
441    (merge a1aba0c95c js/t0007-typofix later to maint).
442    (merge 76ba7fa225 ma/config-doc-fix later to maint).
443    (merge 826f0c0df2 js/subtree-doc-update-to-asciidoctor-2 later to maint).
444    (merge 88eaf361e0 eb/mboxrd-doc later to maint).
445    (merge 051cc54941 tm/zsh-complete-switch-restore later to maint).
446    (merge 39102cf4fe ms/doc-revision-illustration-fix later to maint).
447    (merge 4d9378bfad eb/gitweb-more-trailers later to maint).
448    (merge bdccbf7047 mt/doc-worktree-ref later to maint).
449    (merge ce9baf234f dl/push-recurse-submodules-fix later to maint).
450    (merge 4153274052 bc/doc-credential-helper-value later to maint).