Merge branch 'js/t5526-with-no-particular-primary-branch-name'
[git] / Documentation / RelNotes / 2.30.0.txt
1 Git 2.30 Release Notes
2 ======================
3
4 Updates since v2.29
5 -------------------
6
7 UI, Workflows & Features
8
9  * Userdiff for PHP update.
10
11  * Userdiff for Rust update.
12
13  * Userdiff for CSS update.
14
15  * The command line completion script (in contrib/) learned that "git
16    stash show" takes the options "git diff" takes.
17
18  * "git worktree list" now shows if each worktree is locked.  This
19    possibly may open us to show other kinds of states in the future.
20
21  * "git maintenance", an extended big brother of "git gc", continues
22    to evolve.
23
24  * "git push --force-with-lease[=<ref>]" can easily be misused to lose
25    commits unless the user takes good care of their own "git fetch".
26    A new option "--force-if-includes" attempts to ensure that what is
27    being force-pushed was created after examining the commit at the
28    tip of the remote ref that is about to be force-replaced.
29
30  * "git clone" learned clone.defaultremotename configuration variable
31    to customize what nickname to use to call the remote the repository
32    was cloned from.
33
34  * "git checkout" learned to use checkout.guess configuration variable
35    and enable/disable its "--[no-]guess" option accordingly.
36
37  * "git resurrect" script (in contrib/) learned that the object names
38    may be longer than 40-hex depending on the hash function in use.
39
40  * "git diff A...B" learned "git diff --merge-base A B", which is a
41    longer short-hand to say the same thing.
42
43  * A sample 'push-to-checkout' hook, that performs the same as
44    what the built-in default action does, has been added.
45
46  * "git diff" family of commands learned the "-I<regex>" option to
47    ignore hunks whose changed lines all match the given pattern.
48
49  * The userdiff pattern learned to identify the function definition in
50    POSIX shells and bash.
51
52  * "git checkout-index" did not consistently signal an error with its
53    exit status, but now it does.
54
55  * A commit and tag object may have CR at the end of each and
56    every line (you can create such an object with hash-object or
57    using --cleanup=verbatim to decline the default clean-up
58    action), but it would make it impossible to have a blank line
59    to separate the title from the body of the message.  We are now
60    more lenient and accept a line with lone CR on it as a blank line,
61    too.
62
63  * Exit codes from "git remote add" etc. were not usable by scripted
64    callers, but now they are.
65
66  * "git archive" now allows compression level higher than "-9"
67    when generating tar.gz output.
68
69  * Zsh autocompletion (in contrib/) update.
70
71  * The maximum length of output filenames "git format-patch" creates
72    has become configurable (used to be capped at 64).
73
74  * "git rev-parse" learned the "--end-of-options" to help scripts to
75    safely take a parameter that is supposed to be a revision, e.g.
76    "git rev-parse --verify -q --end-of-options $rev".
77
78  * The command line completion script (in contrib/) learned to expand
79    commands that are alias of alias.
80
81  * "git update-ref --stdin" learns to take multiple transactions in a
82    single session.
83
84  * Various subcommands of "git config" that takes value_regex
85    learn the "--literal-value" option to take the value_regex option
86    as a literal string.
87
88  * The transport layer was taught to optionally exchange the session
89    ID assigned by the trace2 subsystem during fetch/push transactions.
90
91  * "git imap-send" used to ignore configuration variables like
92    core.askpass; this has been corrected.
93
94
95 Performance, Internal Implementation, Development Support etc.
96
97  * Use "git archive" more to produce the release tarball.
98
99  * GitHub Actions automated test improvement to skip tests on a tree
100    identical to what has already been tested.
101
102  * Test-coverage for running commit-graph task "git maintenance" has
103    been extended.
104
105  * Our test scripts can be told to run only individual pieces while
106    skipping others with the "--run=..." option; they were taught to
107    take a substring of test title, in addition to numbers, to name the
108    test pieces to run.
109
110  * Adjust tests so that they won't scream when the default initial
111    branch name is changed to 'main'.
112
113  * Rewriting "git bisect" in C continues.
114
115  * More preliminary tests have been added to document desired outcome
116    of various "directory rename" situations.
117
118  * Micro clean-up of a couple of test scripts.
119
120  * "git diff" and other commands that share the same machinery to
121    compare with working tree files have been taught to take advantage
122    of the fsmonitor data when available.
123
124  * The code to detect premature EOF in the sideband demultiplexer has
125    been cleaned up.
126
127  * Test scripts are being prepared to transition of the default branch
128    name to 'main'.
129
130  * "git fetch --depth=<n>" over the stateless RPC / smart HTTP
131    transport handled EOF from the client poorly at the server end.
132
133  * A specialization of hashmap that uses a string as key has been
134    introduced.  Hopefully it will see wider use over time.
135
136  * "git bisect start/next" in a large span of history spends a lot of
137    time trying to come up with exactly the half-way point; this can be
138    optimized by stopping when we see a commit that is close enough to
139    the half-way point.
140
141  * A lazily defined test prerequisite can now be defined in terms of
142    another lazily defined test prerequisite.
143
144  * Expectation for the original contributor after responding to a
145    review comment to use the explanation in a patch update has been
146    described.
147
148  * Multiple "credential-store" backends can race to lock the same
149    file, causing everybody else but one to fail---reattempt locking
150    with some timeout to reduce the rate of the failure.
151
152  * "git-parse-remote" shell script library outlived its usefulness.
153
154  * Like die() and error(), a call to warning() will also trigger a
155    trace2 event.
156
157  * Use of non-reentrant localtime() has been removed.
158
159  * Non-reentrant time-related library functions and ctime/asctime with
160    awkward calling interfaces are banned from the codebase.
161
162
163 Fixes since v2.29
164 -----------------
165
166  * In 2.29, "--committer-date-is-author-date" option of "rebase" and
167    "am" subcommands lost the e-mail address by mistake, which has been
168    corrected.
169    (merge 5f35edd9d7 jk/committer-date-is-author-date-fix later to maint).
170
171  * "git checkout -p A...B [-- <path>]" did not work, even though the
172    same command without "-p" correctly used the merge-base between
173    commits A and B.
174    (merge 35166b1fb5 dl/checkout-p-merge-base later to maint).
175
176  * The side-band status report can be sent at the same time as the
177    primary payload multiplexed, but the demultiplexer on the receiving
178    end incorrectly split a single status report into two, which has
179    been corrected.
180    (merge 712b0377db js/avoid-split-sideband-message later to maint).
181
182  * "git fast-import" wasted a lot of memory when many marks were in use.
183    (merge 3f018ec716 jk/fast-import-marks-alloc-fix later to maint).
184
185  * A test helper "test_cmp A B" was taught to diagnose missing files A
186    or B as a bug in test, but some tests legitimately wanted to notice
187    a failure to even create file B as an error, in addition to leaving
188    the expected result in it, and were misdiagnosed as a bug.  This
189    has been corrected.
190    (merge 262d5ad5a5 es/test-cmp-typocatcher later to maint).
191
192  * When "git commit-graph" detects the same commit recorded more than
193    once while it is merging the layers, it used to die.  The code now
194    ignores all but one of them and continues.
195    (merge 85102ac71b ds/commit-graph-merging-fix later to maint).
196
197  * The meaning of a Signed-off-by trailer can vary from project to
198    project; this and also what it means to this project has been
199    clarified in the documentation.
200    (merge 3abd4a67d9 bk/sob-dco later to maint).
201
202  * "git credential' didn't honor the core.askPass configuration
203    variable (among other things), which has been corrected.
204    (merge 567ad2c0f9 tk/credential-config later to maint).
205
206  * Dev support to catch a tentative definition of a variable in our C
207    code as an error.
208    (merge 5539183622 jk/no-common later to maint).
209
210  * "git rebase --rebase-merges" did not correctly pass --gpg-sign
211    command line option to underlying "git merge" when replaying a merge
212    using non-default merge strategy or when replaying an octopus merge
213    (because replaying a two-head merge with the default strategy was
214    done in a separate codepath, the problem did not trigger for most
215    users), which has been corrected.
216    (merge 43ad4f2eca sc/sequencer-gpg-octopus later to maint).
217
218  * "git apply -R" did not handle patches that touch the same path
219    twice correctly, which has been corrected.  This is most relevant
220    in a patch that changes a path from a regular file to a symbolic
221    link (and vice versa).
222    (merge b0f266de11 jt/apply-reverse-twice later to maint).
223
224  * A recent oid->hash conversion missed one spot, breaking "git svn".
225    (merge 03bb366de4 bc/svn-hash-oid-fix later to maint).
226
227  * The documentation on the "--abbrev=<n>" option did not say the
228    output may be longer than "<n>" hexdigits, which has been
229    clarified.
230    (merge cda34e0d0c jc/abbrev-doc later to maint).
231
232  * "git p4" now honors init.defaultBranch configuration.
233    (merge 1b09d1917f js/p4-default-branch later to maint).
234
235  * Recently the format of an internal state file "rebase -i" uses has
236    been tightened up for consistency, which would hurt those who start
237    "rebase -i" with old git and then continue with new git.  Loosen
238    the reader side a bit (which we may want to tighten again in a year
239    or so).
240    (merge c779386182 jc/sequencer-stopped-sha-simplify later to maint).
241
242  * The code to see if "git stash drop" can safely remove refs/stash
243    has been made more carerful.
244    (merge 4f44c5659b rs/empty-reflog-check-fix later to maint).
245
246  * "git log -L<range>:<path>" is documented to take no pathspec, but
247    this was not enforced by the command line option parser, which has
248    been corrected.
249    (merge 39664cb0ac jc/line-log-takes-no-pathspec later to maint).
250
251  * "git format-patch --output=there" did not work as expected and
252    instead crashed.  The option is now supported.
253    (merge dc1672dd10 jk/format-patch-output later to maint).
254
255  * Define ARM64 compiled with MSVC to be little-endian.
256    (merge 0c038fc65a dg/bswap-msvc later to maint).
257
258  * "git rebase -i" did not store ORIG_HEAD correctly.
259    (merge 8843302307 pw/rebase-i-orig-head later to maint).
260
261  * "git blame -L :funcname -- path" did not work well for a path for
262    which a userdiff driver is defined.
263
264  * "make DEVELOPER=1 sparse" used to run sparse and let it emit
265    warnings; now such warnings will cause an error.
266    (merge 521dc56270 jc/sparse-error-for-developer-build later to maint).
267
268  * "git blame --ignore-revs-file=<file>" learned to ignore a
269    non-existent object name in the input, instead of complaining.
270    (merge c714d05875 jc/blame-ignore-fix later to maint).
271
272  * Running "git diff" while allowing external diff in a state with
273    unmerged paths used to segfault, which has been corrected.
274    (merge d66851806f jk/diff-release-filespec-fix later to maint).
275
276  * Build configuration cleanup.
277    (merge b990f02fd8 ab/config-mak-uname-simplify later to maint).
278
279  * Fix regression introduced when nvimdiff support in mergetool was added.
280    (merge 12026f46e7 pd/mergetool-nvimdiff later to maint).
281
282  * The exchange between receive-pack and proc-receive hook did not
283    carefully check for errors.
284
285  * The code was not prepared to deal with pack .idx file that is
286    larger than 4GB.
287    (merge 81c4c5cf2e jk/4gb-idx later to maint).
288
289  * Since jgit does not yet work with SHA-256 repositories, mark the
290    tests that uses it not to run unless we are testing with ShA-1
291    repositories.
292    (merge ea699b4adc sg/t5310-jgit-wants-sha1 later to maint).
293
294  * Config parser fix for "git notes".
295    (merge 45fef1599a na/notes-displayref-is-not-boolean later to maint).
296
297  * Move a definition of compatibility wrapper from cache.h to
298    git-compat-util.h
299    (merge a76b138daa hn/sleep-millisec-decl later to maint).
300
301  * Error message fix.
302    (merge eaf5341538 km/stash-error-message-fix later to maint).
303
304  * "git pull --rebase --recurse-submodules" checked for local changes
305    in a wrong range and failed to run correctly when it should.
306    (merge 5176f20ffe pb/pull-rebase-recurse-submodules later to maint).
307
308  * "git push" that is killed may leave a pack-objects process behind,
309    still computing to find a good compression, wasting cycles.  This
310    has been corrected.
311    (merge 8b59935114 jk/stop-pack-objects-when-push-is-killed later to maint).
312
313  * "git fetch" that is killed may leave a pack-objects process behind,
314    still computing to find a good compression, wasting cycles.  This
315    has been corrected.
316    (merge 309a4028e7 jk/stop-pack-objects-when-fetch-is-killed later to maint).
317
318  * "git add -i" failed to honor custom colors configured to show
319    patches, which has been corrected.
320    (merge 96386faa03 js/add-i-color-fix later to maint).
321
322  * Processes that access packdata while the .idx file gets removed
323    (e.g. while repacking) did not fail or fall back gracefully as they
324    could.
325    (merge 506ec2fbda tb/idx-midx-race-fix later to maint).
326
327  * "git apply" adjusted the permission bits of working-tree files and
328    directories according core.sharedRepository setting by mistake and
329    for a long time, which has been corrected.
330    (merge eb3c027e17 mt/do-not-use-scld-in-working-tree later to maint).
331
332  * "fetch-pack" could pass NULL pointer to unlink(2) when it sees an
333    invalid filename; the error checking has been tightened to make
334    this impossible.
335    (merge 6031af387e rs/fetch-pack-invalid-lockfile later to maint).
336
337  * "git maintenance run/start/stop" needed to be run in a repository
338    to hold the lockfile they use, but didn't make sure they are
339    actually in a repository, which has been corrected.
340
341  * Other code cleanup, docfix, build fix, etc.
342    (merge 3e0a5dc9af cc/doc-filter-branch-typofix later to maint).
343    (merge 32c83afc2c cw/ci-ghwf-check-ws-errors later to maint).
344    (merge 5eb2ed691b rs/tighten-callers-of-deref-tag later to maint).
345    (merge 6db29ab213 jk/fast-import-marks-cleanup later to maint).
346    (merge e5cf6d3df4 nk/dir-c-comment-update later to maint).
347    (merge 5710dcce74 jk/report-fn-typedef later to maint).
348    (merge 9a82db1056 en/sequencer-rollback-lock-cleanup later to maint).
349    (merge 4e1bee9a99 js/t7006-cleanup later to maint).
350    (merge f5bcde6c58 es/tutorial-mention-asciidoc-early later to maint).
351    (merge 714d491af0 so/format-patch-doc-on-default-diff-format later to maint).
352    (merge 0795df4b9b rs/clear-commit-marks-in-repo later to maint).
353    (merge 9542d56379 sd/prompt-local-variable later to maint).
354    (merge 06d43fad18 rs/pack-write-hashwrite-simplify later to maint).
355    (merge b7e20b4373 mc/typofix later to maint).
356    (merge f6bcd9a8a4 js/test-whitespace-fixes later to maint).
357    (merge 53b67a801b js/test-file-size later to maint).
358    (merge 970909c2a7 rs/hashwrite-be64 later to maint).
359    (merge 5a923bb1f0 ma/list-object-filter-opt-msgfix later to maint).
360    (merge 1c3e412916 rs/archive-plug-leak-refname later to maint).
361    (merge d44e5267ea rs/plug-diff-cache-leak later to maint).
362    (merge 793c1464d3 ab/gc-keep-base-option later to maint).
363    (merge b86339b12b mt/worktree-error-message-fix later to maint).
364    (merge e01ae2a4a7 js/pull-rebase-use-advise later to maint).
365    (merge e63d774242 sn/config-doc-typofix later to maint).