Merge branch 'bw/submodule-helper-usage-fix'
[git/git.git] / Documentation / RelNotes / 2.24.0.txt
1 Git 2.24 Release Notes
2 ======================
4 Updates since v2.23
5 -------------------
7 Backward compatibility note
9 * Although it is not officially deprecated, "filter-branch" is
10 showing its age and alternatives are available. From this release,
11 we started to discourage its uses and hint people about
12 filter-repo.
14 UI, Workflows & Features
16 * We now have an active interim maintainer for the Git-Gui part of
17 the system. Praise and thank Pratyush Yadav for volunteering.
19 * The command line parser learned "--end-of-options" notation; the
20 standard convention for scripters to have hardcoded set of options
21 first on the command line, and force the command to treat end-user
22 input as non-options, has been to use "--" as the delimiter, but
23 that would not work for commands that use "--" as a delimiter
24 between revs and pathspec.
26 * A mechanism to affect the default setting for a (related) group of
27 configuration variables is introduced.
29 * "git fetch" learned "--set-upstream" option to help those who first
30 clone from their private fork they intend to push to, add the true
31 upstream via "git remote add" and then "git fetch" from it.
33 * Device-tree files learned their own userdiff patterns.
34 (merge 3c81760bc6 sb/userdiff-dts later to maint).
36 * "git rebase --rebase-merges" learned to drive different merge
37 strategies and pass strategy specific options to them.
39 * A new "pre-merge-commit" hook has been introduced.
41 * Command line completion updates for "git -c" have been
42 added.
44 * The lazy clone machinery has been taught that there can be more
45 than one promisor remote and consult them in order when downloading
46 missing objects on demand.
48 * The list-objects-filter API (used to create a sparse/lazy clone)
49 learned to take a combined filter specification.
51 * The documentation and tests for "git format-patch" have been
52 cleaned up.
54 * On Windows, the root level of UNC share is now allowed to be used
55 just like any other directory.
57 * The command line completion support (in contrib/) learned about the
58 "--skip" option of "git revert" and "git cherry-pick".
60 * "git rebase --keep-base <upstream>" tries to find the original base
61 of the topic being rebased and rebase on top of that same base,
62 which is useful when running the "git rebase -i" (and its limited
63 variant "git rebase -x").
65 The command also has learned to fast-forward in more cases where it
66 can instead of replaying to recreate identical commits.
68 * A configuration variable tells "git fetch" to write the commit
69 graph after finishing.
72 Performance, Internal Implementation, Development Support etc.
74 * The code to write commit-graph over given commit object names has
75 been made a bit more robust.
77 * The first line of verbose output from each test piece now carries
78 the test name and number to help scanning with eyeballs.
80 * Further clean-up of the initialization code.
82 * xmalloc() used to have a mechanism to ditch memory and address
83 space resources as the last resort upon seeing an allocation
84 failure from the underlying malloc(), which made the code complex
85 and thread-unsafe with dubious benefit, as major memory resource
86 users already do limit their uses with various other mechanisms.
87 It has been simplified away.
89 * Unnecessary full-tree diff in "git log -L" machinery has been
90 optimized away.
92 * The http transport lacked some optimization the native transports
93 learned to avoid unnecessary ref advertisement, which has been
94 corrected.
96 * Preparation for SHA-256 upgrade continues in the test department.
97 (merge 0c37c41d13 bc/hash-independent-tests-part-5 later to maint).
99 * The memory ownership model of the "git fast-import" got
100 straightened out.
102 * Output from trace2 subsystem is formatted more prettily now.
104 * The internal code originally invented for ".gitignore" processing
105 got reshuffled and renamed to make it less tied to "excluding" and
106 stress more that it is about "matching", as it has been reused for
107 things like sparse checkout specification that want to check if a
108 path is "included".
112 Fixes since v2.23
113 -----------------
115 * "git grep --recurse-submodules" that looks at the working tree
116 files looked at the contents in the index in submodules, instead of
117 files in the working tree.
118 (merge 6a289d45c0 mt/grep-submodules-working-tree later to maint).
120 * Codepaths to walk tree objects have been audited for integer
121 overflows and hardened.
122 (merge 5aa02f9868 jk/tree-walk-overflow later to maint).
124 * "git pack-refs" can lose refs that are created while running, which
125 is getting corrected.
126 (merge a613d4f817 sc/pack-refs-deletion-racefix later to maint).
128 * "git checkout" and "git restore" to re-populate the index from a
129 tree-ish (typically HEAD) did not work correctly for a path that
130 was removed and then added again with the intent-to-add bit, when
131 the corresponding working tree file was empty. This has been
132 corrected.
134 * Compilation fix.
135 (merge 70597e8386 rs/nedalloc-fixlets later to maint).
137 * "git gui" learned to call the clean-up procedure before exiting.
138 (merge 0d88f3d2c5 py/git-gui-do-quit later to maint).
140 * We promoted the "indent heuristics" that decides where to split
141 diff hunks from experimental to the default a few years ago, but
142 some stale documentation still marked it as experimental, which has
143 been corrected.
144 (merge 64e5e1fba1 sg/diff-indent-heuristic-non-experimental later to maint).
146 * Fix a mismerge that happened in 2.22 timeframe.
147 (merge acb7da05ac en/checkout-mismerge-fix later to maint).
149 * "git archive" recorded incorrect length in extended pax header in
150 some corner cases, which has been corrected.
151 (merge 71d41ff651 rs/pax-extended-header-length-fix later to maint).
153 * On-demand object fetching in lazy clone incorrectly tried to fetch
154 commits from submodule projects, while still working in the
155 superproject, which has been corrected.
156 (merge a63694f523 jt/diff-lazy-fetch-submodule-fix later to maint).
158 * Prepare get_short_oid() codepath to be thread-safe.
159 (merge 7cfcb16b0e rs/sort-oid-array-thread-safe later to maint).
161 * "for-each-ref" and friends that show refs did not protect themselves
162 against ancient tags that did not record tagger names when asked to
163 show "%(taggername)", which have been corrected.
164 (merge 8b3f33ef11 mp/for-each-ref-missing-name-or-email later to maint).
166 * The "git am" based backend of "git rebase" ignored the result of
167 updating ".gitattributes" done in one step when replaying
168 subsequent steps.
169 (merge 2c65d90f75 bc/reread-attributes-during-rebase later to maint).
171 * Tell cURL library to use the same malloc() implementation, with the
172 xmalloc() wrapper, as the rest of the system, for consistency.
173 (merge 93b980e58f cb/curl-use-xmalloc later to maint).
175 * Build fix to adjust .gitignore to unignore a path that we started to track.
176 (merge aac6ff7b5b js/visual-studio later to maint).
178 * A few implementation fixes in the notes API.
179 (merge 60fe477a0b mh/notes-duplicate-entries later to maint).
181 * Fix an earlier regression to "git push --all" which should have
182 been forbidden when the target remote repository is set to be a
183 mirror.
184 (merge 8e4c8af058 tg/push-all-in-mirror-forbidden later to maint).
186 * Fix an earlier regression in the test suite, which mistakenly
187 stopped running HTTPD tests.
188 (merge 3960290675 sg/git-test-boolean later to maint).
190 * "git rebase --autostash <upstream> <branch>", when <branch> is
191 different from the current branch, incorrectly moved the tip of the
192 current branch, which has been corrected.
193 (merge bf1e28e0ad bw/rebase-autostash-keep-current-branch later to maint).
195 * Update support for Asciidoctor documentation toolchain.
196 (merge 83b0b8953e ma/asciidoctor-refmiscinfo later to maint).
198 * Start using DocBook 5 (instead of DocBook 4.5) as Asciidoctor 2.0
199 no longer works with the older one.
200 (merge f6461b82b9 bc/doc-use-docbook-5 later to maint).
202 * The markup used in user-manual has been updated to work better with
203 asciidoctor.
204 (merge c4d2f6143a ma/user-manual-markup-update later to maint).
206 * Make sure the grep machinery does not abort when seeing a payload
207 that is not UTF-8 even when JIT is not in use with PCRE1.
208 (merge ad7c543e3b cb/skip-utf8-check-with-pcre1 later to maint).
210 * Other code cleanup, docfix, build fix, etc.
211 (merge d1387d3895 en/fast-import-merge-doc later to maint).
212 (merge 1c24a54ea4 bm/repository-layout-typofix later to maint).
213 (merge 415b770b88 ds/midx-expire-repack later to maint).
214 (merge 19800bdc3f nd/diff-parseopt later to maint).
215 (merge 58166c2e9d tg/t0021-racefix later to maint).
216 (merge 7027f508c7 dl/compat-cleanup later to maint).
217 (merge e770fbfeff jc/test-cleanup later to maint).
218 (merge 1fd881d404 rs/trace2-dst-warning later to maint).
219 (merge 7e92756751 mh/http-urlmatch-cleanup later to maint).
220 (merge 9784f97321 mh/release-commit-memory-fix later to maint).
221 (merge 60d198d022 tb/banned-vsprintf-namefix later to maint).
222 (merge 80e3658647 rs/help-unknown-ref-does-not-return later to maint).
223 (merge 0a8bc7068f dt/remote-helper-doc-re-lock-option later to maint).
224 (merge 27fd1e4ea7 en/merge-options-ff-and-friends later to maint).
225 (merge 502c386ff9 sg/clean-nested-repo-with-ignored later to maint).
226 (merge 26e3d1cbea am/mailmap-andrey-mazo later to maint).