Merge branch 'sb/submodule-update-try-harder'
[git/git.git] / Documentation / RelNotes / 2.18.0.txt
CommitLineData
69d71ec4
JH
1Git 2.18 Release Notes
2======================
3
4Updates since v2.17
5-------------------
6
7UI, 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
26e47e26
JH
21 * When built with more recent cURL, GIT_SSL_VERSION can now specify
22 "tlsv1.3" as its value.
69d71ec4 23
1f1cddd5
JH
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
ccdcbd54
JH
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
e144d126
JH
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
69d71ec4
JH
107
108Performance, Internal Implementation, Development Support etc.
109
110 * A "git fetch" from a repository with insane number of refs into a
111 repository that is already up-to-date still wasted too many cycles
112 making many lstat(2) calls to see if these objects at the tips
113 exist as loose objects locally. These lstat(2) calls are optimized
114 away by enumerating all loose objects beforehand.
115 It is unknown if the new strategy negatively affects existing use
116 cases, fetching into a repository with many loose objects from a
117 repository with small number of refs.
118
119 * Git can be built to use either v1 or v2 of the PCRE library, and so
120 far, the build-time configuration USE_LIBPCRE=YesPlease instructed
121 the build procedure to use v1, but now it means v2. USE_LIBPCRE1
122 and USE_LIBPCRE2 can be used to explicitly choose which version to
123 use, as before.
124
125 * The build procedure learned to optionally use symbolic links
126 (instead of hardlinks and copies) to install "git-foo" for built-in
127 commands, whose binaries are all identical.
128
129 * Conversion from uchar[20] to struct object_id continues.
130
131 * The way "git worktree prune" worked internally has been simplified,
132 by assuming how "git worktree move" moves an existing worktree to a
133 different place.
134
0b0cc9f8
JH
135 * Code clean-up for the "repository" abstraction.
136 (merge 00a3da2a13 nd/remove-ignore-env-field later to maint).
137
138 * Code to find the length to uniquely abbreviate object names based
139 on packfile content, which is a relatively recent addtion, has been
140 optimized to use the same fan-out table.
141
142 * The mechanism to use parse-options API to automate the command line
143 completion continues to get extended and polished.
144
26e47e26
JH
145 * Copies of old scripted Porcelain commands in contrib/examples/ have
146 been removed.
147
148 * Some tests that rely on the exact hardcoded values of object names
149 have been updated in preparation for hash function migration.
150
151 * Perf-test update.
152
153 * Test helper update.
154
155 * The effort continues to refactor the internal global data structure
156 to make it possible to open multiple repositories, work with and
157 then close them,
158
159 * Small test-helper programs have been consolidated into a single
160 binary.
161
1f1cddd5
JH
162 * API clean-up around ref-filter code.
163
164 * Shell completion (in contrib) that gives list of paths have been
165 optimized somewhat.
166
167 * The index file is updated to record the fsmonitor section after a
168 full scan was made, to avoid wasting the effort that has already
169 spent.
170
171 * Performance measuring framework in t/perf learned to help bisecting
172 performance regressions.
173
174 * Some multi-word source filenames are being renamed to separate
175 words with dashes instead of underscores.
176
177 * An reusable "memory pool" implementation has been extracted from
178 fast-import.c, which in turn has become the first user of the
179 mem-pool API.
180
ccdcbd54
JH
181 * A build-time option has been added to allow Git to be told to refer
182 to its associated files relative to the main binary, in the same
183 way that has been possible on Windows for quite some time, for
184 Linux, BSDs and Darwin.
185
186 * Precompute and store information necessary for ancestry traversal
187 in a separate file to optimize graph walking.
188
189 * The effort to pass the repository in-core structure throughout the
190 API continues. This round deals with the code that implements the
191 refs/replace/ mechanism.
192
193 * The build procedure "make DEVELOPER=YesPlease" learned to enable a
194 bit more warning options depending on the compiler used to help
195 developers more. There also is "make DEVOPTS=tokens" knob
196 available now, for those who want to help fixing warnings we
197 usually ignore, for example.
198
199 * A new version of the transport protocol is being worked on.
200
201 * The code to interface to GPG has been restructured somewhat to make
202 it cleaner to integrate with other types of signature systems later.
203
e144d126
JH
204 * The code has been taught to use the duplicated information stored
205 in the commit-graph file to learn the tree object name for a commit
206 to avoid opening and parsing the commit object when it makes sense
207 to do so.
208
209 * "git gc" in a large repository takes a lot of time as it considers
210 to repack all objects into one pack by default. The command has
211 been taught to pretend as if the largest existing packfile is
212 marked with ".keep" so that it is left untouched while objects in
213 other packs and loose ones are repacked.
214
215 * The transport protocol v2 is getting updated further.
216
217 * The codepath around object-info API has been taught to take the
218 repository object (which in turn tells the API which object store
219 the objects are to be located).
220
221 * Rename detection logic in "diff" family that is used in "merge" has
222 learned to guess when all of x/a, x/b and x/c have moved to z/a,
223 z/b and z/c, it is likely that x/d added in the meantime would also
224 want to move to z/d by taking the hint that the entire directory
225 'x' moved to 'z'. A bug causing dirty files involved in a rename
226 to be overwritten during merge has also been fixed as part of this
227 work. Incidentally, this also avoids updating a file in the
228 working tree after a (non-trivial) merge whose result matches what
229 our side originally had.
230
231 * "git pack-objects" needs to allocate tons of "struct object_entry"
232 while doing its work, and shrinking its size helps the performance
233 quite a bit.
234
ccdcbd54 235
69d71ec4
JH
236Also contains various documentation updates and code clean-ups.
237
238
239Fixes since v2.17
240-----------------
241
242 * "git shortlog cruft" aborted with a BUG message when run outside a
243 Git repository. The command has been taught to complain about
244 extra and unwanted arguments on its command line instead in such a
245 case.
246 (merge 4aa0161e83 ma/shortlog-revparse later to maint).
247
248 * "git stash push -u -- <pathspec>" gave an unnecessary and confusing
249 error message when there was no tracked files that match the
250 <pathspec>, which has been fixed.
251 (merge 353278687e tg/stash-untracked-with-pathspec-fix later to maint).
252
0b0cc9f8
JH
253 * "git tag --contains no-such-commit" gave a full list of options
254 after giving an error message.
255 (merge 3bb0923f06 ps/contains-id-error-message later to maint).
256
257 * "diff-highlight" filter (in contrib/) learned to undertand "git log
258 --graph" output better.
259 (merge 4551fbba14 jk/diff-highlight-graph-fix later to maint).
260
261 * when refs that do not point at committish are given, "git
262 filter-branch" gave a misleading error messages. This has been
263 corrected.
264 (merge f78ab355e7 yk/filter-branch-non-committish-refs later to maint).
265
26e47e26
JH
266 * "git submodule status" misbehaved on a submodule that has been
267 removed from the working tree.
268 (merge 74b6bda32f rs/status-with-removed-submodule later to maint).
269
270 * When credential helper exits very quickly without reading its
271 input, it used to cause Git to die with SIGPIPE, which has been
272 fixed.
273 (merge a0d51e8d0e eb/cred-helper-ignore-sigpipe later to maint).
274
1f1cddd5
JH
275 * "git rebase --keep-empty" still removed an empty commit if the
276 other side contained an empty commit (due to the "does an
277 equivalent patch exist already?" check), which has been corrected.
278 (merge 3d946165e1 pw/rebase-keep-empty-fixes later to maint).
279
280 * Some codepaths, including the refs API, get and keep relative
281 paths, that go out of sync when the process does chdir(2). The
282 chdir-notify API is introduced to let these codepaths adjust these
283 cached paths to the new current directory.
284 (merge fb9c2d2703 jk/relative-directory-fix later to maint).
285
286 * "cd sub/dir && git commit ../path" ought to record the changes to
287 the file "sub/path", but this regressed long time ago.
288 (merge 86238e07ef bw/commit-partial-from-subdirectory-fix later to maint).
289
290 * Recent introduction of "--log-destination" option to "git daemon"
291 did not work well when the daemon was run under "--inetd" mode.
292 (merge e67d906d73 lw/daemon-log-destination later to maint).
293
294 * Small fix to the autoconf build procedure.
295 (merge 249482daf0 es/fread-reads-dir-autoconf-fix later to maint).
296
297 * Fix an unexploitable (because the oversized contents are not under
298 attacker's control) buffer overflow.
299 (merge d8579accfa bp/fsmonitor-bufsize-fix later to maint).
300
ccdcbd54
JH
301 * Recent simplification of build procedure forgot a bit of tweak to
302 the build procedure of contrib/mw-to-git/
303 (merge d8698987f3 ab/simplify-perl-makefile later to maint).
304
305 * Moving a submodule that itself has submodule in it with "git mv"
306 forgot to make necessary adjustment to the nested sub-submodules;
307 now the codepath learned to recurse into the submodules.
308
309 * "git config --unset a.b", when "a.b" is the last variable in an
310 otherwise empty section "a", left an empty section "a" behind, and
311 worse yet, a subsequent "git config a.c value" did not reuse that
312 empty shell and instead created a new one. These have been
313 (partially) corrected.
314 (merge c71d8bb38a js/empty-config-section-fix later to maint).
315
316 * "git worktree remove" learned that "-f" is a shorthand for
317 "--force" option, just like for "git worktree add".
318 (merge d228eea514 sb/worktree-remove-opt-force later to maint).
319
320 * The completion script (in contrib/) learned to clear cached list of
321 command line options upon dot-sourcing it again in a more efficient
322 way.
323 (merge 94408dc71c sg/completion-clear-cached later to maint).
324
325 * "git svn" had a minor thinko/typo which has been fixed.
326 (merge 51db271587 ab/git-svn-get-record-typofix later to maint).
327
328 * During a "rebase -i" session, the code could give older timestamp
329 to commits created by later "pick" than an earlier "reword", which
330 has been corrected.
331 (merge 12f7babd6b js/ident-date-fix later to maint).
332
333 * "git submodule status" did not check the symbolic revision name it
334 computed for the submodule HEAD is not the NULL, and threw it at
335 printf routines, which has been corrected.
336 (merge 0b5e2ea7cf nd/submodule-status-fix later to maint).
337
338 * When fed input that already has In-Reply-To: and/or References:
339 headers and told to add the same information, "git send-email"
340 added these headers separately, instead of appending to an existing
341 one, which is a violation of the RFC. This has been corrected.
342 (merge 256be1d3f0 sa/send-email-dedup-some-headers later to maint).
343
344 * "git fast-export" had a regression in v2.15.0 era where it skipped
345 some merge commits in certain cases, which has been corrected.
346 (merge be011bbe00 ma/fast-export-skip-merge-fix later to maint).
347
e144d126
JH
348 * The code did not propagate the terminal width to subprocesses via
349 COLUMNS environment variable, which it now does. This caused
350 trouble to "git column" helper subprocess when "git tag --column=row"
351 tried to list the existing tags on a display with non-default width.
352 (merge b5d5a567fb nd/term-columns later to maint).
353
354 * We learned that our source files with ".pl" and ".py" extensions
355 are Perl and Python files respectively and changes to them are
356 better viewed as such with appropriate diff drivers.
357 (merge 7818b619e2 ab/perl-python-attrs later to maint).
358
359 * "git rebase -i" sometimes left intermediate "# This is a
360 combination of N commits" message meant for the human consumption
361 inside an editor in the final result in certain corner cases, which
362 has been fixed.
363 (merge 15ef69314d js/rebase-i-clean-msg-after-fixup-continue later to maint).
364
365 * A test to see if the filesystem normalizes UTF-8 filename has been
366 updated to check what we need to know in a more direct way, i.e. a
367 path created in NFC form can be accessed with NFD form (or vice
368 versa) to cope with APFS as well as HFS.
369 (merge 742ae10e35 tb/test-apfs-utf8-normalization later to maint).
370
371 * "git format-patch --cover --attach" created a broken MIME multipart
372 message for the cover letter, which has been fixed by keeping the
373 cover letter as plain text file.
374 (merge 50cd54ef4e bc/format-patch-cover-no-attach later to maint).
375
376 * The split-index feature had a long-standing and dormant bug in
377 certain use of the in-core merge machinery, which has been fixed.
378 (merge 7db118303a en/unpack-trees-split-index-fix later to maint).
379
380 * Asciidoctor gives a reasonable imitation for AsciiDoc, but does not
381 render illustration in a literal block correctly when indented with
382 HT by default. The problem is fixed by forcing 8-space tabs.
383 (merge 379805051d bc/asciidoctor-tab-width later to maint).
384
69d71ec4 385 * Other minor doc, test and build updates and code cleanups.
0b0cc9f8
JH
386 (merge 248f66ed8e nd/trace-with-env later to maint).
387 (merge 14ced5562c ys/bisect-object-id-missing-conversion-fix later to maint).
26e47e26
JH
388 (merge 5988eb631a ab/doc-hash-brokenness later to maint).
389 (merge a4d4e32a70 pk/test-avoid-pipe-hiding-exit-status later to maint).
1f1cddd5
JH
390 (merge 05e293c1ac jk/flockfile-stdio later to maint).
391 (merge e9184b0789 jk/t5561-missing-curl later to maint).
392 (merge b1801b85a3 nd/worktree-move later to maint).
393 (merge bbd374dd20 ak/bisect-doc-typofix later to maint).
394 (merge 4855f06fb3 mn/send-email-credential-doc later to maint).
395 (merge 8523b1e355 en/doc-typoes later to maint).
396 (merge 43b44ccfe7 js/t5404-path-fix later to maint).
397 (merge decf711fc1 ps/test-chmtime-get later to maint).
398 (merge 22d11a6e8e es/worktree-docs later to maint).
399 (merge 92a5dbbc22 tg/use-git-contacts later to maint).
ccdcbd54
JH
400 (merge adc887221f tq/t1510 later to maint).
401 (merge bed21a8ad6 sg/doc-gc-quote-mismatch-fix later to maint).
402 (merge 73364e4f10 tz/doc-git-urls-reference later to maint).
e144d126
JH
403 (merge cd1e606bad bc/mailmap-self later to maint).
404 (merge f7997e3682 ao/config-api-doc later to maint).
405 (merge ee930754d8 jk/apply-p-doc later to maint).
406 (merge 011b648646 nd/pack-format-doc later to maint).
407 (merge 87a6bb701a sg/t5310-jgit-bitmap-test later to maint).
408 (merge f6b82970aa sg/t5516-fixes later to maint).
409 (merge 4362da078e sg/t7005-spaces-in-filenames-cleanup later to maint).
410 (merge 7d0ee47c11 js/test-unset-prereq later to maint).
411 (merge 5356a3c354 ah/misc-doc-updates later to maint).
412 (merge 92c4a7a129 nd/completion-aliasfiletype-typofix later to maint).
413 (merge 58bd77b66a nd/pack-unreachable-objects-doc later to maint).