Merge branch 'vs/completion-with-set-u'
[git] / Documentation / RelNotes / 2.32.0.txt
1 Git 2.32 Release Notes
2 ======================
3
4 Backward compatibility notes
5 ----------------------------
6
7  * ".gitattributes", ".gitignore", and ".mailmap" files that are
8    symbolic links are ignored.
9
10
11 Updates since v2.31
12 -------------------
13
14 UI, Workflows & Features
15
16  * It does not make sense to make ".gitattributes", ".gitignore" and
17    ".mailmap" symlinks, as they are supposed to be usable from the
18    object store (think: bare repositories where HEAD:.mailmap etc. are
19    used).  When these files are symbolic links, we used to read the
20    contents of the files pointed by them by mistake, which has been
21    corrected.
22
23  * "git stash show" learned to optionally show untracked part of the
24    stash.
25
26  * "git log --format='...'" learned "%(describe)" placeholder.
27
28  * "git repack" so far has been only capable of repacking everything
29    under the sun into a single pack (or split by size).  A cleverer
30    strategy to reduce the cost of repacking a repository has been
31    introduced.
32
33  * The http codepath learned to let the credential layer to cache the
34    password used to unlock a certificate that has successfully been
35    used.
36
37  * "git commit --fixup=<commit>", which was to tweak the changes made
38    to the contents while keeping the original log message intact,
39    learned "--fixup=(amend|reword):<commit>", that can be used to
40    tweak both the message and the contents, and only the message,
41    respectively.
42
43  * When accessing a server with a URL like https://user:pass@site/, we
44    did not to fall back to the basic authentication with the
45    credential material embedded in the URL after the "Negotiate"
46    authentication failed.  Now we do.
47
48  * "git send-email" learned to honor the core.hooksPath configuration.
49
50  * "git format-patch -v<n>" learned to allow a reroll count that is
51    not an integer.
52
53  * "git commit" learned "--trailer <key>[=<value>]" option; together
54    with the interpret-trailers command, this will make it easier to
55    support custom trailers.
56
57  * "git clone --reject-shallow" option fails the clone as soon as we
58    notice that we are cloning from a shallow repository.
59
60  * A configuration variable has been added to force tips of certain
61    refs to be given a reachability bitmap.
62
63  * "gitweb" learned "e-mail privacy" feature to redact strings that
64    look like e-mail addresses on various pages.
65
66  * "git apply --3way" has always been "to fall back to 3-way merge
67    only when straight application fails". Swap the order of falling
68    back so that 3-way is always attempted first (only when the option
69    is given, of course) and then straight patch application is used as
70    a fallback when it fails.
71
72  * "git apply" now takes "--3way" and "--cached" at the same time, and
73    work and record results only in the index.
74
75  * The command line completion (in contrib/) has learned that
76    CHERRY_PICK_HEAD is a possible pseudo-ref.
77
78  * Userdiff patterns for "Scheme" has been added.
79
80
81 Performance, Internal Implementation, Development Support etc.
82
83  * Rename detection rework continues.
84
85  * GIT_TEST_FAIL_PREREQS is a mechanism to skip test pieces with
86    prerequisites to catch broken tests that depend on the side effects
87    of optional pieces, but did not work at all when negative
88    prerequisites were involved.
89    (merge 27d578d904 jk/fail-prereq-testfix later to maint).
90
91  * "git diff-index" codepath has been taught to trust fsmonitor status
92    to reduce number of lstat() calls.
93    (merge 7e5aa13d2c nk/diff-index-fsmonitor later to maint).
94
95  * Reorganize Makefile to allow building git.o and other essential
96    objects without extra stuff needed only for testing.
97
98  * Preparatory API changes for parallel checkout.
99
100  * A simple IPC interface gets introduced to build services like
101    fsmonitor on top.
102
103  * Fsck API clean-up.
104
105  * SECURITY.md that is facing individual contributors and end users
106    has been introduced.  Also a procedure to follow when preparing
107    embargoed releases has been spelled out.
108    (merge 09420b7648 js/security-md later to maint).
109
110  * Optimize "rev-list --use-bitmap-index --objects" corner case that
111    uses negative tags as the stopping points.
112
113  * CMake update for vsbuild.
114
115  * An on-disk reverse-index to map the in-pack location of an object
116    back to its object name across multiple packfiles is introduced.
117
118  * Generate [ec]tags under $(QUIET_GEN).
119
120  * Clean-up codepaths that implements "git send-email --validate"
121    option and improves the message from it.
122
123  * The last remnant of gettext-poison has been removed.
124
125  * The test framework has been taught to optionally turn the default
126    merge strategy to "ort" throughout the system where we use
127    three-way merges internally, like cherry-pick, rebase etc.,
128    primarily to enhance its test coverage (the strategy has been
129    available as an explicit "-s ort" choice).
130
131  * A bit of code clean-up and a lot of test clean-up around userdiff
132    area.
133
134
135 Fixes since v2.31
136 -----------------
137
138  * The fsmonitor interface read from its input without making sure
139    there is something to read from.  This bug is new in 2.31
140    timeframe.
141
142  * The data structure used by fsmonitor interface was not properly
143    duplicated during an in-core merge, leading to use-after-free etc.
144
145  * "git bisect" reimplemented more in C during 2.30 timeframe did not
146    take an annotated tag as a good/bad endpoint well.  This regression
147    has been corrected.
148
149  * Fix macros that can silently inject unintended null-statements.
150
151  * CALLOC_ARRAY() macro replaces many uses of xcalloc().
152
153  * Update insn in Makefile comments to run fuzz-all target.
154
155  * Fix a corner case bug in "git mv" on case insensitive systems,
156    which was introduced in 2.29 timeframe.
157
158  * We had a code to diagnose and die cleanly when a required
159    clean/smudge filter is missing, but an assert before that
160    unnecessarily fired, hiding the end-user facing die() message.
161    (merge 6fab35f748 mt/cleanly-die-upon-missing-required-filter later to maint).
162
163  * Update C code that sets a few configuration variables when a remote
164    is configured so that it spells configuration variable names in the
165    canonical camelCase.
166    (merge 0f1da600e6 ab/remote-write-config-in-camel-case later to maint).
167
168  * A new configuration variable has been introduced to allow choosing
169    which version of the generation number gets used in the
170    commit-graph file.
171    (merge 702110aac6 ds/commit-graph-generation-config later to maint).
172
173  * Perf test update to work better in secondary worktrees.
174    (merge 36e834abc1 jk/perf-in-worktrees later to maint).
175
176  * Updates to memory allocation code around the use of pcre2 library.
177    (merge c1760352e0 ab/grep-pcre2-allocfix later to maint).
178
179  * "git -c core.bare=false clone --bare ..." would have segfaulted,
180    which has been corrected.
181    (merge 75555676ad bc/clone-bare-with-conflicting-config later to maint).
182
183  * When "git checkout" removes a path that does not exist in the
184    commit it is checking out, it wasn't careful enough not to follow
185    symbolic links, which has been corrected.
186    (merge fab78a0c3d mt/checkout-remove-nofollow later to maint).
187
188  * A few option description strings started with capital letters,
189    which were corrected.
190    (merge 5ee90326dc cc/downcase-opt-help later to maint).
191
192  * Plug or annotate remaining leaks that trigger while running the
193    very basic set of tests.
194    (merge 68ffe095a2 ah/plugleaks later to maint).
195
196  * The hashwrite() API uses a buffering mechanism to avoid calling
197    write(2) too frequently. This logic has been refactored to be
198    easier to understand.
199    (merge ddaf1f62e3 ds/clarify-hashwrite later to maint).
200
201  * "git cherry-pick/revert" with or without "--[no-]edit" did not spawn
202    the editor as expected (e.g. "revert --no-edit" after a conflict
203    still asked to edit the message), which has been corrected.
204    (merge 39edfd5cbc en/sequencer-edit-upon-conflict-fix later to maint).
205
206  * "git daemon" has been tightened against systems that take backslash
207    as directory separator.
208    (merge 9a7f1ce8b7 rs/daemon-sanitize-dir-sep later to maint).
209
210  * A NULL-dereference bug has been corrected in an error codepath in
211    "git for-each-ref", "git branch --list" etc.
212    (merge c685450880 jk/ref-filter-segfault-fix later to maint).
213
214  * Streamline the codepath to fix the UTF-8 encoding issues in the
215    argv[] and the prefix on macOS.
216    (merge c7d0e61016 tb/precompose-prefix-simplify later to maint).
217
218  * The command-line completion script (in contrib/) had a couple of
219    references that would have given a warning under the "-u" (nounset)
220    option.
221    (merge c5c0548d79 vs/completion-with-set-u later to maint).
222
223  * When "git pack-objects" makes a literal copy of a part of existing
224    packfile using the reachability bitmaps, its update to the progress
225    meter was broken.
226    (merge 8e118e8490 jk/pack-objects-bitmap-progress-fix later to maint).
227
228  * The dependencies for config-list.h and command-list.h were broken
229    when the former was split out of the latter, which has been
230    corrected.
231    (merge 56550ea718 sg/bugreport-fixes later to maint).
232
233  * Other code cleanup, docfix, build fix, etc.
234    (merge f451960708 dl/cat-file-doc-cleanup later to maint).
235    (merge 12604a8d0c sv/t9801-test-path-is-file-cleanup later to maint).
236    (merge ea7e63921c jr/doc-ignore-typofix later to maint).
237    (merge 23c781f173 ps/update-ref-trans-hook-doc later to maint).
238    (merge 42efa1231a jk/filter-branch-sha256 later to maint).
239    (merge 4c8e3dca6e tb/push-simple-uses-branch-merge-config later to maint).
240    (merge 6534d436a2 bs/asciidoctor-installation-hints later to maint).
241    (merge 47957485b3 ab/read-tree later to maint).
242    (merge 2be927f3d1 ab/diff-no-index-tests later to maint).
243    (merge 76593c09bb ab/detox-gettext-tests later to maint).
244    (merge 28e29ee38b jc/doc-format-patch-clarify later to maint).
245    (merge fc12b6fdde fm/user-manual-use-preface later to maint).
246    (merge dba94e3a85 cc/test-helper-bloom-usage-fix later to maint).
247    (merge 61a7660516 hn/reftable-tables-doc-update later to maint).
248    (merge 81ed96a9b2 jt/fetch-pack-request-fix later to maint).
249    (merge 151b6c2dd7 jc/doc-do-not-capitalize-clarification later to maint).
250    (merge 9160068ac6 js/access-nul-emulation-on-windows later to maint).