d750d010ecc1eeefd3bb40c934289773764df529
[git/git.git] / Documentation / RelNotes / 2.18.0.txt
1 Git 2.18 Release Notes
2 ======================
3
4 Updates since v2.17
5 -------------------
6
7 UI, Workflows & Features
8
9 * Rename detection logic in "diff" family that is used in "merge" has
10 learned to guess when all of x/a, x/b and x/c have moved to z/a,
11 z/b and z/c, it is likely that x/d added in the meantime would also
12 want to move to z/d by taking the hint that the entire directory
13 'x' moved to 'z'. A bug causing dirty files involved in a rename
14 to be overwritten during merge has also been fixed as part of this
15 work.
16
17 * "git filter-branch" learned to use a different exit code to allow
18 the callers to tell the case where there was no new commits to
19 rewrite from other error cases.
20
21 * When built with more recent cURL, GIT_SSL_VERSION can now specify
22 "tlsv1.3" as its value.
23
24 * "git gui" learned that "~/.ssh/id_ecdsa.pub" and
25 "~/.ssh/id_ed25519.pub" are also possible SSH key files.
26 (merge 2e2f0288ef bb/git-gui-ssh-key-files later to maint).
27
28 * "git gui" performs commit upon CTRL/CMD+ENTER but the
29 CTRL/CMD+KP_ENTER (i.e. enter key on the numpad) did not have the
30 same key binding. It now does.
31 (merge 28a1d94a06 bp/git-gui-bind-kp-enter later to maint).
32
33 * "git gui" has been taught to work with old versions of tk (like
34 8.5.7) that do not support "ttk::style theme use" as a way to query
35 the current theme.
36 (merge 4891961105 cb/git-gui-ttk-style later to maint).
37
38 * "git rebase" has learned to honor "--signoff" option when using
39 backends other than "am" (but not "--preserve-merges").
40
41 * "git branch --list" during an interrupted "rebase -i" now lets
42 users distinguish the case where a detached HEAD is being rebased
43 and a normal branch is being rebased.
44
45 * "git mergetools" learned talking to guiffy.
46
47 * The scripts in contrib/emacs/ have outlived their usefulness and
48 have been replaced with a stub that errors out and tells the user
49 there are replacements.
50
51 * The new "checkout-encoding" attribute can ask Git to convert the
52 contents to the specified encoding when checking out to the working
53 tree (and the other way around when checking in).
54
55 * The "git config" command uses separate options e.g. "--int",
56 "--bool", etc. to specify what type the caller wants the value to
57 be interpreted as. A new "--type=<typename>" option has been
58 introduced, which would make it cleaner to define new types.
59
60 * "git config --get" learned the "--default" option, to help the
61 calling script. Building on top of the above changes, the
62 "git config" learns "--type=color" type. Taken together, you can
63 do things like "git config --get foo.color --default blue" and get
64 the ANSI color sequence for the color given to foo.color variable,
65 or "blue" if the variable does not exist.
66
67 * "git ls-remote" learned an option to allow sorting its output based
68 on the refnames being shown.
69
70 * The command line completion (in contrib/) has been taught that "git
71 stash save" has been deprecated ("git stash push" is the preferred
72 spelling in the new world) and does not offer it as a possible
73 completion candidate when "git stash push" can be.
74
75 * "git gc --prune=nonsense" spent long time repacking and then
76 silently failed when underlying "git prune --expire=nonsense"
77 failed to parse its command line. This has been corrected.
78
79 * Error messages from "git push" can be painted for more visibility.
80
81 * "git http-fetch" (deprecated) had an optional and experimental
82 "feature" to fetch only commits and/or trees, which nobody used.
83 This has been removed.
84
85 * The functionality of "$GIT_DIR/info/grafts" has been superseded by
86 the "refs/replace/" mechanism for some time now, but the internal
87 code had support for it in many places, which has been cleaned up
88 in order to drop support of the "grafts" mechanism.
89
90 * "git worktree add" learned to check out an existing branch.
91
92 * "git --no-pager cmd" did not have short-and-sweet single letter
93 option. Now it does as "-P".
94 (merge 7213c28818 js/no-pager-shorthand later to maint).
95
96 * "git rebase" learned "--rebase-merges" to transplant the whole
97 topology of commit graph elsewhere.
98
99 * "git status" learned to pay attention to UI related diff
100 configuration variables such as diff.renames.
101
102 * The command line completion mechanism (in contrib/) learned to load
103 custom completion file for "git $command" where $command is a
104 custom "git-$command" that the end user has on the $PATH when using
105 newer version of bash.
106
107 * "git send-email" can sometimes offer confirmation dialog "Send this
108 email?" with choices 'Yes', 'No', 'Quit', and 'All'. A new action
109 'Edit' has been added to this dialog's choice.
110
111 * With merge.renames configuration set to false, the recursive merge
112 strategy can be told not to spend cycles trying to find renamed
113 paths and merge them accordingly.
114
115 * "git status" learned to honor a new status.renames configuration to
116 skip rename detection, which could be useful for those who want to
117 do so without disabling the default rename detection done by the
118 "git diff" command.
119
120 * Command line completion (in contrib/) learned to complete pathnames
121 for various commands better.
122
123 * "git blame" learns to unhighlight uninteresting metadata from the
124 originating commit on lines that are the same as the previous one,
125 and also paint lines in different colors depending on the age of
126 the commit.
127
128 * Transfer protocol v2 learned to support the partial clone.
129
130 * When a short hexadecimal string is used to name an object but there
131 are multiple objects that share the string as the prefix of their
132 names, the code lists these ambiguous candidates in a help message.
133 These object names are now sorted according to their types for
134 easier eyeballing.
135
136
137 Performance, Internal Implementation, Development Support etc.
138
139 * A "git fetch" from a repository with insane number of refs into a
140 repository that is already up-to-date still wasted too many cycles
141 making many lstat(2) calls to see if these objects at the tips
142 exist as loose objects locally. These lstat(2) calls are optimized
143 away by enumerating all loose objects beforehand.
144 It is unknown if the new strategy negatively affects existing use
145 cases, fetching into a repository with many loose objects from a
146 repository with small number of refs.
147
148 * Git can be built to use either v1 or v2 of the PCRE library, and so
149 far, the build-time configuration USE_LIBPCRE=YesPlease instructed
150 the build procedure to use v1, but now it means v2. USE_LIBPCRE1
151 and USE_LIBPCRE2 can be used to explicitly choose which version to
152 use, as before.
153
154 * The build procedure learned to optionally use symbolic links
155 (instead of hardlinks and copies) to install "git-foo" for built-in
156 commands, whose binaries are all identical.
157
158 * Conversion from uchar[20] to struct object_id continues.
159
160 * The way "git worktree prune" worked internally has been simplified,
161 by assuming how "git worktree move" moves an existing worktree to a
162 different place.
163
164 * Code clean-up for the "repository" abstraction.
165 (merge 00a3da2a13 nd/remove-ignore-env-field later to maint).
166
167 * Code to find the length to uniquely abbreviate object names based
168 on packfile content, which is a relatively recent addtion, has been
169 optimized to use the same fan-out table.
170
171 * The mechanism to use parse-options API to automate the command line
172 completion continues to get extended and polished.
173
174 * Copies of old scripted Porcelain commands in contrib/examples/ have
175 been removed.
176
177 * Some tests that rely on the exact hardcoded values of object names
178 have been updated in preparation for hash function migration.
179
180 * Perf-test update.
181
182 * Test helper update.
183
184 * The effort continues to refactor the internal global data structure
185 to make it possible to open multiple repositories, work with and
186 then close them,
187
188 * Small test-helper programs have been consolidated into a single
189 binary.
190
191 * API clean-up around ref-filter code.
192
193 * Shell completion (in contrib) that gives list of paths have been
194 optimized somewhat.
195
196 * The index file is updated to record the fsmonitor section after a
197 full scan was made, to avoid wasting the effort that has already
198 spent.
199
200 * Performance measuring framework in t/perf learned to help bisecting
201 performance regressions.
202
203 * Some multi-word source filenames are being renamed to separate
204 words with dashes instead of underscores.
205
206 * An reusable "memory pool" implementation has been extracted from
207 fast-import.c, which in turn has become the first user of the
208 mem-pool API.
209
210 * A build-time option has been added to allow Git to be told to refer
211 to its associated files relative to the main binary, in the same
212 way that has been possible on Windows for quite some time, for
213 Linux, BSDs and Darwin.
214
215 * Precompute and store information necessary for ancestry traversal
216 in a separate file to optimize graph walking.
217
218 * The effort to pass the repository in-core structure throughout the
219 API continues. This round deals with the code that implements the
220 refs/replace/ mechanism.
221
222 * The build procedure "make DEVELOPER=YesPlease" learned to enable a
223 bit more warning options depending on the compiler used to help
224 developers more. There also is "make DEVOPTS=tokens" knob
225 available now, for those who want to help fixing warnings we
226 usually ignore, for example.
227
228 * A new version of the transport protocol is being worked on.
229
230 * The code to interface to GPG has been restructured somewhat to make
231 it cleaner to integrate with other types of signature systems later.
232
233 * The code has been taught to use the duplicated information stored
234 in the commit-graph file to learn the tree object name for a commit
235 to avoid opening and parsing the commit object when it makes sense
236 to do so.
237
238 * "git gc" in a large repository takes a lot of time as it considers
239 to repack all objects into one pack by default. The command has
240 been taught to pretend as if the largest existing packfile is
241 marked with ".keep" so that it is left untouched while objects in
242 other packs and loose ones are repacked.
243
244 * The transport protocol v2 is getting updated further.
245
246 * The codepath around object-info API has been taught to take the
247 repository object (which in turn tells the API which object store
248 the objects are to be located).
249
250 * Rename detection logic in "diff" family that is used in "merge" has
251 learned to guess when all of x/a, x/b and x/c have moved to z/a,
252 z/b and z/c, it is likely that x/d added in the meantime would also
253 want to move to z/d by taking the hint that the entire directory
254 'x' moved to 'z'. A bug causing dirty files involved in a rename
255 to be overwritten during merge has also been fixed as part of this
256 work. Incidentally, this also avoids updating a file in the
257 working tree after a (non-trivial) merge whose result matches what
258 our side originally had.
259
260 * "git pack-objects" needs to allocate tons of "struct object_entry"
261 while doing its work, and shrinking its size helps the performance
262 quite a bit.
263
264 * The implementation of "git rebase -i --root" has been updated to use
265 the sequencer machinery more.
266
267 * Developer support update, by using BUG() macro instead of die() to
268 mark codepaths that should not happen more clearly.
269
270 * Developer support. Use newer GCC on one of the builds done at
271 TravisCI.org to get more warnings and errors diagnosed.
272
273 * Conversion from uchar[20] to struct object_id continues.
274
275
276 Also contains various documentation updates and code clean-ups.
277
278
279 Fixes since v2.17
280 -----------------
281
282 * "git shortlog cruft" aborted with a BUG message when run outside a
283 Git repository. The command has been taught to complain about
284 extra and unwanted arguments on its command line instead in such a
285 case.
286 (merge 4aa0161e83 ma/shortlog-revparse later to maint).
287
288 * "git stash push -u -- <pathspec>" gave an unnecessary and confusing
289 error message when there was no tracked files that match the
290 <pathspec>, which has been fixed.
291 (merge 353278687e tg/stash-untracked-with-pathspec-fix later to maint).
292
293 * "git tag --contains no-such-commit" gave a full list of options
294 after giving an error message.
295 (merge 3bb0923f06 ps/contains-id-error-message later to maint).
296
297 * "diff-highlight" filter (in contrib/) learned to undertand "git log
298 --graph" output better.
299 (merge 4551fbba14 jk/diff-highlight-graph-fix later to maint).
300
301 * when refs that do not point at committish are given, "git
302 filter-branch" gave a misleading error messages. This has been
303 corrected.
304 (merge f78ab355e7 yk/filter-branch-non-committish-refs later to maint).
305
306 * "git submodule status" misbehaved on a submodule that has been
307 removed from the working tree.
308 (merge 74b6bda32f rs/status-with-removed-submodule later to maint).
309
310 * When credential helper exits very quickly without reading its
311 input, it used to cause Git to die with SIGPIPE, which has been
312 fixed.
313 (merge a0d51e8d0e eb/cred-helper-ignore-sigpipe later to maint).
314
315 * "git rebase --keep-empty" still removed an empty commit if the
316 other side contained an empty commit (due to the "does an
317 equivalent patch exist already?" check), which has been corrected.
318 (merge 3d946165e1 pw/rebase-keep-empty-fixes later to maint).
319
320 * Some codepaths, including the refs API, get and keep relative
321 paths, that go out of sync when the process does chdir(2). The
322 chdir-notify API is introduced to let these codepaths adjust these
323 cached paths to the new current directory.
324 (merge fb9c2d2703 jk/relative-directory-fix later to maint).
325
326 * "cd sub/dir && git commit ../path" ought to record the changes to
327 the file "sub/path", but this regressed long time ago.
328 (merge 86238e07ef bw/commit-partial-from-subdirectory-fix later to maint).
329
330 * Recent introduction of "--log-destination" option to "git daemon"
331 did not work well when the daemon was run under "--inetd" mode.
332 (merge e67d906d73 lw/daemon-log-destination later to maint).
333
334 * Small fix to the autoconf build procedure.
335 (merge 249482daf0 es/fread-reads-dir-autoconf-fix later to maint).
336
337 * Fix an unexploitable (because the oversized contents are not under
338 attacker's control) buffer overflow.
339 (merge d8579accfa bp/fsmonitor-bufsize-fix later to maint).
340
341 * Recent simplification of build procedure forgot a bit of tweak to
342 the build procedure of contrib/mw-to-git/
343 (merge d8698987f3 ab/simplify-perl-makefile later to maint).
344
345 * Moving a submodule that itself has submodule in it with "git mv"
346 forgot to make necessary adjustment to the nested sub-submodules;
347 now the codepath learned to recurse into the submodules.
348
349 * "git config --unset a.b", when "a.b" is the last variable in an
350 otherwise empty section "a", left an empty section "a" behind, and
351 worse yet, a subsequent "git config a.c value" did not reuse that
352 empty shell and instead created a new one. These have been
353 (partially) corrected.
354 (merge c71d8bb38a js/empty-config-section-fix later to maint).
355
356 * "git worktree remove" learned that "-f" is a shorthand for
357 "--force" option, just like for "git worktree add".
358 (merge d228eea514 sb/worktree-remove-opt-force later to maint).
359
360 * The completion script (in contrib/) learned to clear cached list of
361 command line options upon dot-sourcing it again in a more efficient
362 way.
363 (merge 94408dc71c sg/completion-clear-cached later to maint).
364
365 * "git svn" had a minor thinko/typo which has been fixed.
366 (merge 51db271587 ab/git-svn-get-record-typofix later to maint).
367
368 * During a "rebase -i" session, the code could give older timestamp
369 to commits created by later "pick" than an earlier "reword", which
370 has been corrected.
371 (merge 12f7babd6b js/ident-date-fix later to maint).
372
373 * "git submodule status" did not check the symbolic revision name it
374 computed for the submodule HEAD is not the NULL, and threw it at
375 printf routines, which has been corrected.
376 (merge 0b5e2ea7cf nd/submodule-status-fix later to maint).
377
378 * When fed input that already has In-Reply-To: and/or References:
379 headers and told to add the same information, "git send-email"
380 added these headers separately, instead of appending to an existing
381 one, which is a violation of the RFC. This has been corrected.
382 (merge 256be1d3f0 sa/send-email-dedup-some-headers later to maint).
383
384 * "git fast-export" had a regression in v2.15.0 era where it skipped
385 some merge commits in certain cases, which has been corrected.
386 (merge be011bbe00 ma/fast-export-skip-merge-fix later to maint).
387
388 * The code did not propagate the terminal width to subprocesses via
389 COLUMNS environment variable, which it now does. This caused
390 trouble to "git column" helper subprocess when "git tag --column=row"
391 tried to list the existing tags on a display with non-default width.
392 (merge b5d5a567fb nd/term-columns later to maint).
393
394 * We learned that our source files with ".pl" and ".py" extensions
395 are Perl and Python files respectively and changes to them are
396 better viewed as such with appropriate diff drivers.
397 (merge 7818b619e2 ab/perl-python-attrs later to maint).
398
399 * "git rebase -i" sometimes left intermediate "# This is a
400 combination of N commits" message meant for the human consumption
401 inside an editor in the final result in certain corner cases, which
402 has been fixed.
403 (merge 15ef69314d js/rebase-i-clean-msg-after-fixup-continue later to maint).
404
405 * A test to see if the filesystem normalizes UTF-8 filename has been
406 updated to check what we need to know in a more direct way, i.e. a
407 path created in NFC form can be accessed with NFD form (or vice
408 versa) to cope with APFS as well as HFS.
409 (merge 742ae10e35 tb/test-apfs-utf8-normalization later to maint).
410
411 * "git format-patch --cover --attach" created a broken MIME multipart
412 message for the cover letter, which has been fixed by keeping the
413 cover letter as plain text file.
414 (merge 50cd54ef4e bc/format-patch-cover-no-attach later to maint).
415
416 * The split-index feature had a long-standing and dormant bug in
417 certain use of the in-core merge machinery, which has been fixed.
418 (merge 7db118303a en/unpack-trees-split-index-fix later to maint).
419
420 * Asciidoctor gives a reasonable imitation for AsciiDoc, but does not
421 render illustration in a literal block correctly when indented with
422 HT by default. The problem is fixed by forcing 8-space tabs.
423 (merge 379805051d bc/asciidoctor-tab-width later to maint).
424
425 * Code clean-up to adjust to a more recent lockfile API convention that
426 allows lockfile instances kept on the stack.
427 (merge 0fa5a2ed8d ma/lockfile-cleanup later to maint).
428
429 * the_repository->index is not a allocated piece of memory but
430 repo_clear() indiscriminately attempted to free(3) it, which has
431 been corrected.
432 (merge 74373b5f10 nd/repo-clear-keep-the-index later to maint).
433
434 * Code clean-up to avoid non-standard-conformant pointer arithmetic.
435 (merge c112084af9 rs/no-null-ptr-arith-in-fast-export later to maint).
436
437 * Code clean-up to turn history traversal more robust in a
438 semi-corrupt repository.
439 (merge 8702b30fd7 jk/unavailable-can-be-missing later to maint).
440
441 * "git update-ref A B" is supposed to ensure that ref A does not yet
442 exist when B is a NULL OID, but this check was not done correctly
443 for pseudo-refs outside refs/ hierarchy, e.g. MERGE_HEAD.
444
445 * "git submodule update" and "git submodule add" supported the
446 "--reference" option to borrow objects from a neighbouring local
447 repository like "git clone" does, but lacked the more recent
448 invention "--dissociate". Also "git submodule add" has been taught
449 to take the "--progress" option.
450 (merge a0ef29341a cf/submodule-progress-dissociate later to maint).
451
452 * Update credential-netrc helper (in contrib/) to allow customizing
453 the GPG used to decrypt the encrypted .netrc file.
454 (merge 786ef50a23 lm/credential-netrc later to maint).
455
456 * "git submodule update" attempts two different kinds of "git fetch"
457 against the upstream repository to grab a commit bound at the
458 submodule's path, but it incorrectly gave up if the first kind
459 (i.e. a normal fetch) failed, making the second "last resort" one
460 (i.e. fetching an exact commit object by object name) ineffective.
461 This has been corrected.
462 (merge e30d833671 sb/submodule-update-try-harder later to maint).
463
464 * Other minor doc, test and build updates and code cleanups.
465 (merge 248f66ed8e nd/trace-with-env later to maint).
466 (merge 14ced5562c ys/bisect-object-id-missing-conversion-fix later to maint).
467 (merge 5988eb631a ab/doc-hash-brokenness later to maint).
468 (merge a4d4e32a70 pk/test-avoid-pipe-hiding-exit-status later to maint).
469 (merge 05e293c1ac jk/flockfile-stdio later to maint).
470 (merge e9184b0789 jk/t5561-missing-curl later to maint).
471 (merge b1801b85a3 nd/worktree-move later to maint).
472 (merge bbd374dd20 ak/bisect-doc-typofix later to maint).
473 (merge 4855f06fb3 mn/send-email-credential-doc later to maint).
474 (merge 8523b1e355 en/doc-typoes later to maint).
475 (merge 43b44ccfe7 js/t5404-path-fix later to maint).
476 (merge decf711fc1 ps/test-chmtime-get later to maint).
477 (merge 22d11a6e8e es/worktree-docs later to maint).
478 (merge 92a5dbbc22 tg/use-git-contacts later to maint).
479 (merge adc887221f tq/t1510 later to maint).
480 (merge bed21a8ad6 sg/doc-gc-quote-mismatch-fix later to maint).
481 (merge 73364e4f10 tz/doc-git-urls-reference later to maint).
482 (merge cd1e606bad bc/mailmap-self later to maint).
483 (merge f7997e3682 ao/config-api-doc later to maint).
484 (merge ee930754d8 jk/apply-p-doc later to maint).
485 (merge 011b648646 nd/pack-format-doc later to maint).
486 (merge 87a6bb701a sg/t5310-jgit-bitmap-test later to maint).
487 (merge f6b82970aa sg/t5516-fixes later to maint).
488 (merge 4362da078e sg/t7005-spaces-in-filenames-cleanup later to maint).
489 (merge 7d0ee47c11 js/test-unset-prereq later to maint).
490 (merge 5356a3c354 ah/misc-doc-updates later to maint).
491 (merge 92c4a7a129 nd/completion-aliasfiletype-typofix later to maint).
492 (merge 58bd77b66a nd/pack-unreachable-objects-doc later to maint).
493 (merge 4ed79d5203 sg/t6500-no-redirect-of-stdin later to maint).