Merge branch 'js/mingw-use-utf8'
[git] / Documentation / RelNotes / 2.23.0.txt
1 Git 2.23 Release Notes
2 ======================
3
4 Updates since v2.22
5 -------------------
6
7 Backward 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
14 UI, 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
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
46  * The pattern "git diff/grep" use to extract funcname and words
47    boundary for Rust has been added.
48
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.
55    The commands learned "--no-shown-forced-updates" option to disable
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
71  * "git rev-list --objects" learned with "--no-object-names" option to
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
78
79 Performance, Internal Implementation, Development Support etc.
80
81  * Update supporting parts of "git rebase" to remove code that should
82    no longer be used.
83
84  * Developer support to emulate unsatisfied prerequisites in tests to
85    ensure that the remainer of the tests still succeeds when tests
86    with prerequisites are skipped.
87
88  * "git update-server-info" learned not to rewrite the file with the
89    same contents.
90
91  * The way of specifying the path to find dynamic libraries at runtime
92    has been simplified.  The old default to pass -R/path/to/dir has been
93    replaced with the new default to pass -Wl,-rpath,/path/to/dir,
94    which is the more recent GCC uses.  Those who need to build with an
95    old GCC can still use "CC_LD_DYNPATH=-R"
96
97  * Prepare use of reachability index in topological walker that works
98    on a range (A..B).
99
100  * A new tutorial targetting specifically aspiring git-core
101    developers has been added.
102
103  * Auto-detect how to tell HP-UX aCC where to use dynamically linked
104    libraries from at runtime.
105
106  * "git mergetool" and its tests now spawn fewer subprocesses.
107
108  * Dev support update to help tracing out tests.
109
110  * Support to build with MSVC has been updated.
111
112  * "git fetch" that grabs from a group of remotes learned to run the
113    auto-gc only once at the very end.
114
115
116 Fixes since v2.22
117 -----------------
118
119  * A relative pathname given to "git init --template=<path> <repo>"
120    ought to be relative to the directory "git init" gets invoked in,
121    but it instead was made relative to the repository, which has been
122    corrected.
123    (merge e1df7fe43f nd/init-relative-template-fix later to maint).
124
125  * "git worktree add" used to fail when another worktree connected to
126    the same repository was corrupt, which has been corrected.
127    (merge 105df73e71 nd/corrupt-worktrees later to maint).
128
129  * The ownership rule for the file descriptor to fast-import remote
130    backend was mixed up, leading to unrelated file descriptor getting
131    closed, which has been fixed.
132    (merge 3203566a71 mh/import-transport-fd-fix later to maint).
133
134  * A "merge -c" instruction during "git rebase --rebase-merges" should
135    give the user a chance to edit the log message, even when there is
136    otherwise no need to create a new merge and replace the existing
137    one (i.e. fast-forward instead), but did not.  Which has been
138    corrected.
139
140  * Code cleanup and futureproof.
141    (merge 31f5256c82 ds/object-info-for-prefetch-fix later to maint).
142
143  * More parameter validation.
144    (merge de99eb0c24 es/grep-require-name-when-needed later to maint).
145
146  * "git update-server-info" used to leave stale packfiles in its
147    output, which has been corrected.
148    (merge e941c48d49 ew/server-info-remove-crufts later to maint).
149
150  * The server side support for "git fetch" used to show incorrect
151    value for the HEAD symbolic ref when the namespace feature is in
152    use, which has been corrected.
153    (merge 533e088250 jk/HEAD-symref-in-xfer-namespaces later to maint).
154
155  * "git am -i --resolved" segfaulted after trying to see a commit as
156    if it were a tree, which has been corrected.
157    (merge 7663e438c5 jk/am-i-resolved-fix later to maint).
158
159  * "git bundle verify" needs to see if prerequisite objects exist in
160    the receiving repository, but the command did not check if we are
161    in a repository upfront, which has been corrected.
162    (merge 3bbbe467f2 js/bundle-verify-require-object-store later to maint).
163
164  * "git merge --squash" is designed to update the working tree and the
165    index without creating the commit, and this cannot be countermanded
166    by adding the "--commit" option; the command now refuses to work
167    when both options are given.
168    (merge 1d14d0c994 vv/merge-squash-with-explicit-commit later to maint).
169
170  * The data collected by fsmonitor was not properly written back to
171    the on-disk index file, breaking t7519 tests occasionally, which
172    has been corrected.
173    (merge b5a8169752 js/fsmonitor-unflake later to maint).
174
175  * Update to Unicode 12.1 width table.
176    (merge 5817f9caa3 bb/unicode-12.1-reiwa later to maint).
177
178  * The command line to invoke a "git cat-file" command from inside
179    "git p4" was not properly quoted to protect a caret and running a
180    broken command on Windows, which has been corrected.
181    (merge c3f2358de3 mm/p4-unshelve-windows-fix later to maint).
182
183  * "git request-pull" learned to warn when the ref we ask them to pull
184    from in the local repository and in the published repository are
185    different.
186    (merge 0454220d66 pb/request-pull-verify-remote-ref later to maint).
187
188  * When creating a partial clone, the object filtering criteria is
189    recorded for the origin of the clone, but this incorrectly used a
190    hardcoded name "origin" to name that remote; it has been corrected
191    to honor the "--origin <name>" option.
192    (merge 1c4a9f9114 xl/record-partial-clone-origin later to maint).
193
194  * "git fetch" into a lazy clone forgot to fetch base objects that are
195    necessary to complete delta in a thin packfile, which has been
196    corrected.
197    (merge 810e19322d jt/partial-clone-missing-ref-delta-base later to maint).
198
199  * The filter_data used in the list-objects-filter (which manages a
200    lazily sparse clone repository) did not use the dynamic array API
201    correctly---'nr' is supposed to point at one past the last element
202    of the array in use.  This has been corrected.
203    (merge 7140600e2e md/list-objects-filter-memfix later to maint).
204
205  * The description about slashes in gitignore patterns (used to
206    indicate things like "anchored to this level only" and "only
207    matches directories") has been revamped.
208    (merge 1a58bad014 an/ignore-doc-update later to maint).
209
210  * The URL decoding code has been updated to avoid going past the end
211    of the string while parsing %-<hex>-<hex> sequence.
212    (merge d37dc239a4 md/url-parse-harden later to maint).
213
214  * The list of for-each like macros used by clang-format has been
215    updated.
216    (merge fc7e03aace mo/clang-format-for-each-update later to maint).
217
218  * "git branch --list" learned to show branches that are checked out
219    in other worktrees connected to the same repository prefixed with
220    '+', similar to the way the currently checked out branch is shown
221    with '*' in front.
222    (merge 6e9381469e nb/branch-show-other-worktrees-head later to maint).
223
224  * Code restructuring during 2.20 period broke fetching tags via
225    "import" based transports.
226    (merge f80d922355 fc/fetch-with-import-fix later to maint).
227
228  * The commit-graph file is now part of the "files that the runtime
229    may keep open file descriptors on, all of which would need to be
230    closed when done with the object store", and the file descriptor to
231    an existing commit-graph file now is closed before "gc" finalizes a
232    new instance to replace it.
233    (merge 2d511cfc0b ds/close-object-store later to maint).
234
235  * "git checkout -p" needs to selectively apply a patch in reverse,
236    which did not work well.
237    (merge 2bd69b9024 pw/add-p-recount later to maint).
238
239  * Code clean-up to avoid signed integer wraparounds during binary search.
240    (merge 568a05c5ec rs/avoid-overflow-in-midpoint-computation later to maint).
241
242  * "git interpret-trailers" always treated '#' as the comment
243    character, regardless of core.commentChar setting, which has been
244    corrected.
245    (merge 29c83fc23f jk/trailers-use-config later to maint).
246
247  * "git stash show 23" used to work, but no more after getting
248    rewritten in C; this regression has been corrected.
249    (merge 63b50c8ffe tg/stash-ref-by-index-fix later to maint).
250
251  * "git rebase --abort" used to leave refs/rewritten/ when concluding
252    "git rebase -r", which has been corrected.
253    (merge d559f502c5 pw/rebase-abort-clean-rewritten later to maint).
254
255  * An incorrect list of options was cached after command line
256    completion failed (e.g. trying to complete a command that requires
257    a repository outside one), which has been corrected.
258    (merge 69702523af nd/completion-no-cache-failure later to maint).
259
260  * The code to parse scaled numbers out of configuration files has
261    been made more robust and also easier to follow.
262    (merge 39c575c969 rs/config-unit-parsing later to maint).
263
264  * The codepath to compute delta islands used to spew progress output
265    without giving the callers any way to squelch it, which has been
266    fixed.
267    (merge bdbdf42f8a jk/delta-islands-progress-fix later to maint).
268
269  * Protocol capabilities that go over wire should never be translated,
270    but it was incorrectly marked for translation, which has been
271    corrected.  The output of protocol capabilities for debugging has
272    been tweaked a bit.
273
274  * Use "Erase in Line" CSI sequence that is already used in the editor
275    support to clear cruft in the progress output.
276    (merge 5b12e3123b sg/rebase-progress later to maint).
277
278  * "git submodule foreach" did not protect command line options passed
279    to the command to be run in each submodule correctly, when the
280    "--recursive" option was in use.
281    (merge 30db18b148 ms/submodule-foreach-fix later to maint).
282
283  * Other code cleanup, docfix, build fix, etc.
284    (merge f547101b26 es/git-debugger-doc later to maint).
285    (merge 7877ac3d7b js/bisect-helper-check-get-oid-return-value later to maint).
286    (merge 0108f47eb3 sw/git-p4-unshelve-branched-files later to maint).
287    (merge 9df8f734fd cm/send-email-document-req-modules later to maint).
288    (merge afc3bf6eb1 ab/hash-object-doc later to maint).
289    (merge 1fde99cfc7 po/doc-branch later to maint).
290    (merge 459842e1c2 dl/config-alias-doc later to maint).
291    (merge 5d137fc2c7 cb/fsmonitor-intfix later to maint).
292    (merge 921d49be86 rs/copy-array later to maint).
293    (merge cc8d872e69 js/t3404-typofix later to maint).
294    (merge 729a9b558b cb/mkstemps-uint-type-fix later to maint).
295    (merge 9dae4fe79f js/gcc-8-and-9 later to maint).
296    (merge ed33bd8f30 js/t0001-case-insensitive later to maint).
297    (merge dfa880e336 jw/gitweb-sample-update later to maint).
298    (merge e532a90a9f sg/t5551-fetch-smart-error-is-translated later to maint).