RelNotes/2.23.0: fix a few typos and other minor issues
[git/git.git] / Documentation / RelNotes / 2.23.0.txt
CommitLineData
0aae918d
JH
1Git 2.23 Release Notes
2======================
3
4Updates since v2.22
5-------------------
6
7Backward compatibility note
8
9 * The "--base" option of "format-patch" computed the patch-ids for
10 prerequisite patches in an unstable way, which has been updated to
11 compute in a way that is compatible with "git patch-id --stable".
12
13
14UI, Workflows & Features
15
16 * The "git fast-export/import" pair has been taught to handle commits
17 with log messages in encoding other than UTF-8 better.
18
19 * In recent versions of Git, per-worktree refs are exposed in
20 refs/worktrees/<wtname>/ hierarchy, which means that worktree names
21 must be a valid refname component. The code now sanitizes the names
22 given to worktrees, to make sure these refs are well-formed.
23
24 * "git merge" learned "--quit" option that cleans up the in-progress
25 merge while leaving the working tree and the index still in a mess.
26
27 * "git format-patch" learns a configuration to set the default for
28 its --notes=<ref> option.
29
30 * The code to show args with potential typo that cannot be
31 interpreted as a commit-ish has been improved.
32
a6a95cd1
JH
33 * "git clone --recurse-submodules" learned to set up the submodules
34 to ignore commit object names recorded in the superproject gitlink
35 and instead use the commits that happen to be at the tip of the
36 remote-tracking branches from the get-go, by passing the new
37 "--remote-submodules" option.
38
39 * The pattern "git diff/grep" use to extract funcname and words
40 boundary for Matlab has been extend to cover Octave, which is more
41 or less equivalent.
42
43 * "git help git" was hard to discover (well, at least for some
44 people).
45
8dca754b
JH
46 * The pattern "git diff/grep" use to extract funcname and words
47 boundary for Rust has been added.
48
6d5b2642
JH
49 * "git status" can be told a non-standard default value for the
50 "--[no-]ahead-behind" option with a new configuration variable
51 status.aheadBehind.
52
53 * "git fetch" and "git pull" reports when a fetch results in
54 non-fast-forward updates to let the user notice unusual situation.
a45f5314 55 The commands learned "--no-show-forced-updates" option to disable
6d5b2642
JH
56 this safety feature.
57
58 * Two new commands "git switch" and "git restore" are introduced to
59 split "checking out a branch to work on advancing its history" and
60 "checking out paths out of the index and/or a tree-ish to work on
61 advancing the current history" out of the single "git checkout"
62 command.
63
64 * "git branch --list" learned to always output the detached HEAD as
65 the first item (when the HEAD is detached, of course), regardless
66 of the locale.
67
68 * The conditional inclusion mechanism learned to base the choice on
69 the branch the HEAD currently is on.
70
a45f5314 71 * "git rev-list --objects" learned the "--no-object-names" option to
6d5b2642
JH
72 squelch the path to the object that is used as a grouping hint for
73 pack-objects.
74
75 * A new tag.gpgSign configuration variable turns "git tag -a" into
76 "git tag -s".
77
9c9b961d
JH
78 * "git multi-pack-index" learned expire and repack subcommands.
79
80 * "git blame" learned to "ignore" commits in the history, whose
81 effects (as well as their presence) get ignored.
82
83 * "git cherry-pick/revert" learned a new "--skip" action.
84
85 * The tips of refs from the alternate object store can be used as
86 starting point for reachability computation now.
87
88 * Extra blank lines in "git status" output have been reduced.
89
90 * The commits in a repository can be described by multiple
91 commit-graph files now, which allows the commit-graph files to be
92 updated incrementally.
93
7b974e3e
JH
94 * The "git log" command learns to issue a warning when log.mailmap
95 configuration is not set and --[no-]mailmap option is not used, to
96 prepare users for future versions of Git that uses the mailmap by
97 default.
98
99 * "git range-diff" output has been tweaked for easier identification
100 of which part of what file the patch shown is about.
101
0aae918d
JH
102
103Performance, Internal Implementation, Development Support etc.
104
105 * Update supporting parts of "git rebase" to remove code that should
106 no longer be used.
107
108 * Developer support to emulate unsatisfied prerequisites in tests to
a45f5314 109 ensure that the remainder of the tests still succeeds when tests
0aae918d
JH
110 with prerequisites are skipped.
111
112 * "git update-server-info" learned not to rewrite the file with the
113 same contents.
114
115 * The way of specifying the path to find dynamic libraries at runtime
116 has been simplified. The old default to pass -R/path/to/dir has been
117 replaced with the new default to pass -Wl,-rpath,/path/to/dir,
118 which is the more recent GCC uses. Those who need to build with an
119 old GCC can still use "CC_LD_DYNPATH=-R"
120
a6a95cd1
JH
121 * Prepare use of reachability index in topological walker that works
122 on a range (A..B).
123
a45f5314 124 * A new tutorial targeting specifically aspiring git-core
a6a95cd1
JH
125 developers has been added.
126
6d5b2642
JH
127 * Auto-detect how to tell HP-UX aCC where to use dynamically linked
128 libraries from at runtime.
129
130 * "git mergetool" and its tests now spawn fewer subprocesses.
131
132 * Dev support update to help tracing out tests.
133
134 * Support to build with MSVC has been updated.
135
136 * "git fetch" that grabs from a group of remotes learned to run the
137 auto-gc only once at the very end.
a6a95cd1 138
9d418600
JH
139 * A handful of Windows build patches have been upstreamed.
140
9c9b961d
JH
141 * The code to read state files used by the sequencer machinery for
142 "git status" has been made more robust against a corrupt or stale
143 state files.
144
145 * "git for-each-ref" with multiple patterns have been optimized.
146
147 * The tree-walk API learned to pass an in-core repository
148 instance throughout more codepaths.
149
150 * When one step in multi step cherry-pick or revert is reset or
151 committed, the command line prompt script failed to notice the
152 current status, which has been improved.
153
7b974e3e
JH
154 * Many GIT_TEST_* environment variables control various aspects of
155 how our tests are run, but a few followed "non-empty is true, empty
156 or unset is false" while others followed the usual "there are a few
157 ways to spell true, like yes, on, etc., and also ways to spell
158 false, like no, off, etc." convention.
159
160 * Adjust the dir-iterator API and apply it to the local clone
161 optimization codepath.
162
163 * We have been trying out a few language features outside c89; the
164 coding guidelines document did not talk about them and instead had
165 a blanket ban against them.
7b974e3e
JH
166
167 * A test helper has been introduced to optimize preparation of test
168 repositories with many simple commits, and a handful of test
169 scripts have been updated to use it.
170
0aae918d
JH
171
172Fixes since v2.22
173-----------------
174
175 * A relative pathname given to "git init --template=<path> <repo>"
176 ought to be relative to the directory "git init" gets invoked in,
177 but it instead was made relative to the repository, which has been
178 corrected.
0aae918d
JH
179
180 * "git worktree add" used to fail when another worktree connected to
181 the same repository was corrupt, which has been corrected.
0aae918d
JH
182
183 * The ownership rule for the file descriptor to fast-import remote
a45f5314 184 backend was mixed up, leading to an unrelated file descriptor getting
0aae918d 185 closed, which has been fixed.
0aae918d
JH
186
187 * A "merge -c" instruction during "git rebase --rebase-merges" should
188 give the user a chance to edit the log message, even when there is
189 otherwise no need to create a new merge and replace the existing
190 one (i.e. fast-forward instead), but did not. Which has been
191 corrected.
192
a6a95cd1 193 * Code cleanup and futureproof.
a6a95cd1
JH
194
195 * More parameter validation.
a6a95cd1
JH
196
197 * "git update-server-info" used to leave stale packfiles in its
198 output, which has been corrected.
a6a95cd1
JH
199
200 * The server side support for "git fetch" used to show incorrect
201 value for the HEAD symbolic ref when the namespace feature is in
202 use, which has been corrected.
a6a95cd1
JH
203
204 * "git am -i --resolved" segfaulted after trying to see a commit as
205 if it were a tree, which has been corrected.
a6a95cd1
JH
206
207 * "git bundle verify" needs to see if prerequisite objects exist in
208 the receiving repository, but the command did not check if we are
209 in a repository upfront, which has been corrected.
a6a95cd1
JH
210
211 * "git merge --squash" is designed to update the working tree and the
212 index without creating the commit, and this cannot be countermanded
213 by adding the "--commit" option; the command now refuses to work
214 when both options are given.
a6a95cd1
JH
215
216 * The data collected by fsmonitor was not properly written back to
217 the on-disk index file, breaking t7519 tests occasionally, which
218 has been corrected.
a6a95cd1
JH
219
220 * Update to Unicode 12.1 width table.
a6a95cd1
JH
221
222 * The command line to invoke a "git cat-file" command from inside
223 "git p4" was not properly quoted to protect a caret and running a
224 broken command on Windows, which has been corrected.
a6a95cd1
JH
225
226 * "git request-pull" learned to warn when the ref we ask them to pull
227 from in the local repository and in the published repository are
228 different.
a6a95cd1
JH
229
230 * When creating a partial clone, the object filtering criteria is
231 recorded for the origin of the clone, but this incorrectly used a
232 hardcoded name "origin" to name that remote; it has been corrected
233 to honor the "--origin <name>" option.
a6a95cd1 234
8dca754b
JH
235 * "git fetch" into a lazy clone forgot to fetch base objects that are
236 necessary to complete delta in a thin packfile, which has been
237 corrected.
8dca754b
JH
238
239 * The filter_data used in the list-objects-filter (which manages a
240 lazily sparse clone repository) did not use the dynamic array API
241 correctly---'nr' is supposed to point at one past the last element
242 of the array in use. This has been corrected.
8dca754b
JH
243
244 * The description about slashes in gitignore patterns (used to
245 indicate things like "anchored to this level only" and "only
246 matches directories") has been revamped.
8dca754b
JH
247
248 * The URL decoding code has been updated to avoid going past the end
249 of the string while parsing %-<hex>-<hex> sequence.
8dca754b
JH
250
251 * The list of for-each like macros used by clang-format has been
252 updated.
8dca754b 253
6d5b2642
JH
254 * "git branch --list" learned to show branches that are checked out
255 in other worktrees connected to the same repository prefixed with
256 '+', similar to the way the currently checked out branch is shown
257 with '*' in front.
258 (merge 6e9381469e nb/branch-show-other-worktrees-head later to maint).
259
260 * Code restructuring during 2.20 period broke fetching tags via
261 "import" based transports.
6d5b2642
JH
262
263 * The commit-graph file is now part of the "files that the runtime
264 may keep open file descriptors on, all of which would need to be
265 closed when done with the object store", and the file descriptor to
266 an existing commit-graph file now is closed before "gc" finalizes a
267 new instance to replace it.
6d5b2642
JH
268
269 * "git checkout -p" needs to selectively apply a patch in reverse,
270 which did not work well.
6d5b2642
JH
271
272 * Code clean-up to avoid signed integer wraparounds during binary search.
6d5b2642
JH
273
274 * "git interpret-trailers" always treated '#' as the comment
275 character, regardless of core.commentChar setting, which has been
276 corrected.
6d5b2642
JH
277
278 * "git stash show 23" used to work, but no more after getting
279 rewritten in C; this regression has been corrected.
6d5b2642
JH
280
281 * "git rebase --abort" used to leave refs/rewritten/ when concluding
282 "git rebase -r", which has been corrected.
6d5b2642
JH
283
284 * An incorrect list of options was cached after command line
285 completion failed (e.g. trying to complete a command that requires
286 a repository outside one), which has been corrected.
6d5b2642
JH
287
288 * The code to parse scaled numbers out of configuration files has
289 been made more robust and also easier to follow.
6d5b2642
JH
290
291 * The codepath to compute delta islands used to spew progress output
292 without giving the callers any way to squelch it, which has been
293 fixed.
6d5b2642
JH
294
295 * Protocol capabilities that go over wire should never be translated,
296 but it was incorrectly marked for translation, which has been
297 corrected. The output of protocol capabilities for debugging has
298 been tweaked a bit.
299
300 * Use "Erase in Line" CSI sequence that is already used in the editor
301 support to clear cruft in the progress output.
6d5b2642
JH
302
303 * "git submodule foreach" did not protect command line options passed
304 to the command to be run in each submodule correctly, when the
305 "--recursive" option was in use.
6d5b2642 306
9d418600
JH
307 * The configuration variable rebase.rescheduleFailedExec should be
308 effective only while running an interactive rebase and should not
a45f5314 309 affect anything when running a non-interactive one, which was not
9d418600 310 the case. This has been corrected.
9d418600
JH
311
312 * The "git clone" documentation refers to command line options in its
313 description in the short form; they have been replaced with long
314 forms to make them more recognisable.
9d418600 315
9c9b961d
JH
316 * Generation of pack bitmaps are now disabled when .keep files exist,
317 as these are mutually exclusive features.
318 (merge 7328482253 ew/repack-with-bitmaps-by-default later to maint).
319
7b974e3e
JH
320 * "git rm" to resolve a conflicted path leaked an internal message
321 "needs merge" before actually removing the path, which was
322 confusing. This has been corrected.
7b974e3e
JH
323
324 * "git stash --keep-index" did not work correctly on paths that have
325 been removed, which has been fixed.
326 (merge b932f6a5e8 tg/stash-keep-index-with-removed-paths later to maint).
327
328 * Window 7 update ;-)
7b974e3e
JH
329
330 * A codepath that reads from GPG for signed object verification read
331 past the end of allocated buffer, which has been fixed.
7b974e3e
JH
332
333 * "git clean" silently skipped a path when it cannot lstat() it; now
334 it gives a warning.
7b974e3e
JH
335
336 * "git push --atomic" that goes over the transport-helper (namely,
337 the smart http transport) failed to prevent refs to be pushed when
338 it can locally tell that one of the ref update will fail without
339 having to consult the other end, which has been corrected.
7b974e3e 340
026dd738 341 * The internal diff machinery can be made to read out of bounds while
a45f5314 342 looking for --function-context line in a corner case, which has been
026dd738
JH
343 corrected.
344 (merge b777f3fd61 jk/xdiff-clamp-funcname-context-index later to maint).
345
0aae918d 346 * Other code cleanup, docfix, build fix, etc.
9c9b961d 347 (merge fbec05c210 cc/test-oidmap later to maint).
f36d08d7
JH
348 (merge 7a06fb038c jk/no-system-includes-in-dot-c later to maint).
349 (merge 81ed2b405c cb/xdiff-no-system-includes-in-dot-c later to maint).