checkout: remove duplicate code
[git] / Documentation / RelNotes / 2.22.0.txt
1 Git 2.22 Release Notes
2 ======================
3
4 Updates since v2.21
5 -------------------
6
7 UI, Workflows & Features
8
9  * "git checkout --no-overlay" can be used to trigger a new mode of
10    checking out paths out of the tree-ish, that allows paths that
11    match the pathspec that are in the current index and working tree
12    and are not in the tree-ish.
13
14  * The %(trailers) formatter in "git log --format=..."  now allows to
15    optionally pick trailers selectively by keyword, show only values,
16    etc.
17
18  * Four new configuration variables {author,committer}.{name,email}
19    have been introduced to override user.{name,email} in more specific
20    cases.
21
22  * Command-line completion (in contrib/) learned to tab-complete the
23    "git submodule absorbgitdirs" subcommand.
24
25  * "git branch" learned a new subcommand "--show-current".
26
27  * Output from "diff --cc" did not show the original paths when the
28    merge involved renames.  A new option adds the paths in the
29    original trees to the output.
30
31  * The command line completion (in contrib/) has been taught to
32    complete more subcommand parameters.
33
34  * The final report from "git bisect" used to show the suspected
35    culprit using a raw "diff-tree", with which there is no output for
36    a merge commit.  This has been updated to use a more modern and
37    human readable output that still is concise enough.
38
39  * "git rebase --rebase-merges" replaces its old "--preserve-merges"
40    option; the latter is now marked as deprecated.
41
42  * Error message given while cloning with --recurse-submodules has
43    been updated.
44
45  * The completion helper code now pays attention to repository-local
46    configuration (when available), which allows --list-cmds to honour
47    a repository specific setting of completion.commands, for example.
48
49  * "git mergetool" learned to offer Sublime Merge (smerge) as one of
50    its backends.
51
52
53 Performance, Internal Implementation, Development Support etc.
54
55  * The diff machinery, one of the oldest parts of the system, which
56    long predates the parse-options API, uses fairly long and complex
57    handcrafted option parser.  This is being rewritten to use the
58    parse-options API.
59
60  * The implementation of pack-redundant has been updated for
61    performance in a repository with many packfiles.
62
63  * A more structured way to obtain execution trace has been added.
64
65  * "git prune" has been taught to take advantage of reachability
66    bitmap when able.
67
68  * The command line parser of "git commit-tree" has been rewritten to
69    use the parse-options API.
70
71  * Suggest GitGitGadget instead of submitGit as a way to submit
72    patches based on GitHub PR to us.
73
74  * The test framework has been updated to help developers by making it
75    easier to run most of the tests under different versions of
76    over-the-wire protocols.
77
78  * Dev support update to make it easier to compare two formatted
79    results from our documentation.
80
81  * The scripted "git rebase" implementation has been retired.
82
83  * "git multi-pack-index verify" did not scale well with the number of
84    packfiles, which is being improved.
85
86  * "git stash" has been rewritten in C.
87
88  * The "check-docs" Makefile target to support developers has been
89    updated.
90
91  * The tests have been updated not to rely on the abbreviated option
92    names the parse-options API offers, to protect us from an
93    abbreviated form of an option that used to be unique within the
94    command getting non-unique when a new option that share the same
95    prefix is added.
96
97
98 Fixes since v2.21
99 -----------------
100
101  * "git prune-packed" did not notice and complain against excess
102    arguments given from the command line, which now it does.
103    (merge 9b0bd87ed2 rj/prune-packed-excess-args later to maint).
104
105  * Split-index fix.
106    (merge 6e37c8ed3c nd/split-index-null-base-fix later to maint).
107
108  * "git diff --no-index" may still want to access Git goodies like
109    --ext-diff and --textconv, but so far these have been ignored,
110    which has been corrected.
111    (merge 287ab28bfa jk/diff-no-index-initialize later to maint).
112
113  * Unify RPC code for smart http in protocol v0/v1 and v2, which fixes
114    a bug in the latter (lack of authentication retry) and generally
115    improves the code base.
116    (merge a97d00799a jt/http-auth-proto-v2-fix later to maint).
117
118  * The include file compat/bswap.h has been updated so that it is safe
119    to (accidentally) include it more than once.
120    (merge 33aa579a55 jk/guard-bswap-header later to maint).
121
122  * The set of header files used by "make hdr-check" unconditionally
123    included sha256/gcrypt.h, even when it is not used, causing the
124    make target to fail.  We now skip it when GCRYPT_SHA256 is not in
125    use.
126    (merge f23aa18e7f rj/hdr-check-gcrypt-fix later to maint).
127
128  * The Makefile uses 'find' utility to enumerate all the *.h header
129    files, which is expensive on platforms with slow filesystems; it
130    now optionally uses "ls-files" if working within a repository,
131    which is a trick similar to how all sources are enumerated to run
132    ETAGS on.
133    (merge 92b88eba9f js/find-lib-h-with-ls-files-when-possible later to maint).
134
135  * "git rebase" that was reimplemented in C did not set ORIG_HEAD
136    correctly, which has been corrected.
137    (merge cbd29ead92 js/rebase-orig-head-fix later to maint).
138
139  * Dev support.
140    (merge f545737144 js/stress-test-ui-tweak later to maint).
141
142  * CFLAGS now can be tweaked when invoking Make while using
143    DEVELOPER=YesPlease; this did not work well before.
144    (merge 6d5d4b4e93 ab/makefile-help-devs-more later to maint).
145
146  * "git fsck --connectivity-only" omits computation necessary to sift
147    the objects that are not reachable from any of the refs into
148    unreachable and dangling.  This is now enabled when dangling
149    objects are requested (which is done by default, but can be
150    overridden with the "--no-dangling" option).
151    (merge 8d8c2a5aef jk/fsck-doc later to maint).
152
153  * On platforms where "git fetch" is killed with SIGPIPE (e.g. OSX),
154    the upload-pack that runs on the other end that hangs up after
155    detecting an error could cause "git fetch" to die with a signal,
156    which led to a flakey test.  "git fetch" now ignores SIGPIPE during
157    the network portion of its operation (this is not a problem as we
158    check the return status from our write(2)s).
159    (merge 143588949c jk/no-sigpipe-during-network-transport later to maint).
160
161  * A recent update broke "is this object available to us?" check for
162    well-known objects like an empty tree (which should yield "yes",
163    even when there is no on-disk object for an empty tree), which has
164    been corrected.
165    (merge f06ab027ef jk/virtual-objects-do-exist later to maint).
166
167  * The setup code has been cleaned up to avoid leaks around the
168    repository_format structure.
169    (merge e8805af1c3 ma/clear-repository-format later to maint).
170
171  * "git config --type=color ..." is meant to replace "git config --get-color"
172    but there is a slight difference that wasn't documented, which is
173    now fixed.
174    (merge cd8e7593b9 jk/config-type-color-ends-with-lf later to maint).
175
176  * When the "clean" filter can reduce the size of a huge file in the
177    working tree down to a small "token" (a la Git LFS), there is no
178    point in allocating a huge scratch area upfront, but the buffer is
179    sized based on the original file size.  The convert mechanism now
180    allocates very minimum and reallocates as it receives the output
181    from the clean filter process.
182    (merge 02156ab031 jh/resize-convert-scratch-buffer later to maint).
183
184  * "git rebase" uses the refs/rewritten/ hierarchy to store its
185    intermediate states, which inherently makes the hierarchy per
186    worktree, but it didn't quite work well.
187    (merge b9317d55a3 nd/rewritten-ref-is-per-worktree later to maint).
188
189  * "git log -L<from>,<to>:<path>" with "-s" did not suppress the patch
190    output as it should.  This has been corrected.
191    (merge 05314efaea jk/line-log-with-patch later to maint).
192
193  * "git worktree add" used to do a "find an available name with stat
194    and then mkdir", which is race-prone.  This has been fixed by using
195    mkdir and reacting to EEXIST in a loop.
196    (merge 7af01f2367 ms/worktree-add-atomic-mkdir later to maint).
197
198  * Build update for SHA-1 with collision detection.
199    (merge 07a20f569b jk/sha1dc later to maint).
200
201  * Build procedure has been fixed around use of asciidoctor instead of
202    asciidoc.
203    (merge 185f9a0ea0 ma/asciidoctor-fixes later to maint).
204
205  * remote-http transport did not anonymize URLs reported in its error
206    messages at places.
207    (merge c1284b21f2 js/anonymize-remote-curl-diag later to maint).
208
209  * Error messages given from the http transport have been updated so
210    that they can be localized.
211    (merge ed8b4132c8 js/remote-curl-i18n later to maint).
212
213  * "git init" forgot to read platform-specific repository
214    configuration, which made Windows port to ignore settings of
215    core.hidedotfiles, for example.
216
217  * A corner-case object name ambiguity while the sequencer machinery
218    is working (e.g. "rebase -i -x") has been fixed.
219
220  * "git format-patch" did not diagnose an error while opening the
221    output file for the cover-letter, which has been corrected.
222    (merge 2fe95f494c jc/format-patch-error-check later to maint).
223
224  * "git checkout -f <branch>" while the index has an unmerged path
225    incorrectly left some paths in an unmerged state, which has been
226    corrected.
227
228  * A corner case bug in the refs API has been corrected.
229    (merge d3322eb28b jk/refs-double-abort later to maint).
230
231  * Unicode update.
232    (merge 584b62c37b bb/unicode-12 later to maint).
233
234  * dumb-http walker has been updated to share more error recovery
235    strategy with the normal codepath.
236
237  * A buglet in configuration parser has been fixed.
238    (merge 19e7fdaa58 nd/include-if-wildmatch later to maint).
239
240  * The documentation for "git read-tree --reset -u" has been updated.
241    (merge b5a0bd694c nd/read-tree-reset-doc later to maint).
242
243  * Code cleanup, docfix, build fix, etc.
244    (merge 11f470aee7 jc/test-yes-doc later to maint).
245    (merge 90503a240b js/doc-symref-in-proto-v1 later to maint).
246    (merge 5c326d1252 jk/unused-params later to maint).
247    (merge 68cabbfda3 dl/doc-submodule-wo-subcommand later to maint).
248    (merge 9903623761 ab/receive-pack-use-after-free-fix later to maint).
249    (merge 1ede45e44b en/merge-options-doc later to maint).
250    (merge 3e14dd2c8e rd/doc-hook-used-in-sample later to maint).
251    (merge c271dc28fd nd/no-more-check-racy later to maint).
252    (merge e6e15194a8 yb/utf-16le-bom-spellfix later to maint).
253    (merge bb101aaf0c rd/attr.c-comment-typofix later to maint).
254    (merge 716a5af812 rd/gc-prune-doc-fix later to maint).
255    (merge 50b206371d js/untravis-windows later to maint).
256    (merge dbf47215e3 js/rebase-recreate-merge later to maint).
257    (merge 56cb2d30f8 dl/reset-doc-no-wrt-abbrev later to maint).
258    (merge 64eca306a2 ja/dir-rename-doc-markup-fix later to maint).
259    (merge af91b0230c dl/ignore-docs later to maint).
260    (merge 59a06e947b ra/t3600-test-path-funcs later to maint).
261    (merge e041d0781b ar/t4150-remove-cruft later to maint).
262    (merge 8d75a1d183 ma/asciidoctor-fixes-more later to maint).
263    (merge 74cc547b0f mh/pack-protocol-doc-fix later to maint).
264    (merge ed31851fa6 ab/doc-misc-typofixes later to maint).
265    (merge a7256debd4 nd/checkout-m-doc-update later to maint).
266    (merge 3a9e1ad78d jt/t5551-protocol-v2-does-not-have-half-auth later to maint).
267    (merge 0b918b75af sg/t5318-cleanup later to maint).
268    (merge 68ed71b53c cb/doco-mono later to maint).
269    (merge a34dca2451 nd/interpret-trailers-docfix later to maint).