Merge branch 'pl/complete-diff-submodule-diff'
[git] / Documentation / RelNotes / 2.12.0.txt
1 Git 2.12 Release Notes
2 ======================
3
4 Backward compatibility notes.
5
6  * Use of an empty string that is used for 'everything matches' is
7    still warned and Git asks users to use a more explicit '.' for that
8    instead.  The hope is that existing users will not mind this
9    change, and eventually the warning can be turned into a hard error,
10    upgrading the deprecation into removal of this (mis)feature.  That
11    is not scheduled to happen in the upcoming release (yet).
12
13  * The historical argument order "git merge <msg> HEAD <commit>..."
14    has been deprecated for quite some time, and will be removed in a
15    future release.
16
17  * An ancient script "git relink" has been removed.
18
19
20 Updates since v2.11
21 -------------------
22
23 UI, Workflows & Features
24
25  * Various updates to "git p4".
26
27  * "git p4" didn't interact with the internal of .git directory
28    correctly in the modern "git-worktree"-enabled world.
29
30  * "git branch --list" and friends learned "--ignore-case" option to
31    optionally sort branches and tags case insensitively.
32
33  * In addition to %(subject), %(body), "log --pretty=format:..."
34    learned a new placeholder %(trailers).
35
36  * "git rebase" learned "--quit" option, which allows a user to
37    remove the metadata left by an earlier "git rebase" that was
38    manually aborted without using "git rebase --abort".
39
40  * "git clone --reference $there --recurse-submodules $super" has been
41    taught to guess repositories usable as references for submodules of
42    $super that are embedded in $there while making a clone of the
43    superproject borrow objects from $there; extend the mechanism to
44    also allow submodules of these submodules to borrow repositories
45    embedded in these clones of the submodules embedded in the clone of
46    the superproject.
47
48  * Porcelain scripts written in Perl are getting internationalized.
49
50  * "git merge --continue" has been added as a synonym to "git commit"
51    to conclude a merge that has stopped due to conflicts.
52
53  * Finer-grained control of what protocols are allowed for transports
54    during clone/fetch/push have been enabled via a new configuration
55    mechanism.
56
57  * "git shortlog" learned "--committer" option to group commits by
58    committer, instead of author.
59
60  * GitLFS integration with "git p4" has been updated.
61
62  * The isatty() emulation for Windows has been updated to eradicate
63    the previous hack that depended on internals of (older) MSVC
64    runtime.
65
66  * Some platforms no longer understand "latin-1" that is still seen in
67    the wild in e-mail headers; replace them with "iso-8859-1" that is
68    more widely known when conversion fails from/to it.
69
70  * "git grep" has been taught to optionally recurse into submodules.
71
72  * "git rm" used to refuse to remove a submodule when it has its own
73    git repository embedded in its working tree.  It learned to move
74    the repository away to $GIT_DIR/modules/ of the superproject
75    instead, and allow the submodule to be deleted (as long as there
76    will be no loss of local modifications, that is).
77
78  * A recent updates to "git p4" was not usable for older p4 but it
79    could be made to work with minimum changes.  Do so.
80
81  * "git diff" learned diff.interHunkContext configuration variable
82    that gives the default value for its --inter-hunk-context option.
83
84  * The prereleaseSuffix feature of version comparison that is used in
85    "git tag -l" did not correctly when two or more prereleases for the
86    same release were present (e.g. when 2.0, 2.0-beta1, and 2.0-beta2
87    are there and the code needs to compare 2.0-beta1 and 2.0-beta2).
88
89  * "git submodule push" learned "--recurse-submodules=only option to
90    push submodules out without pushing the top-level superproject.
91
92  * "git tag" and "git verify-tag" learned to put GPG verification
93    status in their "--format=<placeholders>" output format.
94
95  * An ancient repository conversion tool left in contrib/ has been
96    removed.
97
98  * "git show-ref HEAD" used with "--verify" because the user is not
99    interested in seeing refs/remotes/origin/HEAD, and used with
100    "--head" because the user does not want HEAD to be filtered out,
101    i.e. "git show-ref --head --verify HEAD", did not work as expected.
102
103  * "git submodule add" used to be confused and refused to add a
104    locally created repository; users can now use "--force" option
105    to add them.
106    (merge 619acfc78c sb/submodule-add-force later to maint).
107
108  * Some people feel the default set of colors used by "git log --graph"
109    rather limiting.  A mechanism to customize the set of colors has
110    been introduced.
111    (merge 512aba261a nd/log-graph-configurable-colors later to maint).
112
113
114 Performance, Internal Implementation, Development Support etc.
115
116  * Commands that operate on a log message and add lines to the trailer
117    blocks, such as "format-patch -s", "cherry-pick (-x|-s)", and
118    "commit -s", have been taught to use the logic of and share the
119    code with "git interpret-trailer".
120
121  * The default Travis-CI configuration specifies newer P4 and GitLFS.
122
123  * The "fast hash" that had disastrous performance issues in some
124    corner cases has been retired from the internal diff.
125
126  * The character width table has been updated to match Unicode 9.0
127
128  * Update the procedure to generate "tags" for developer support.
129
130  * The codeflow of setting NOATIME and CLOEXEC on file descriptors Git
131    opens has been simplified.
132    (merge b4d065df03 jc/git-open-cloexec later to maint).
133
134  * "git diff" and its family had two experimental heuristics to shift
135    the contents of a hunk to make the patch easier to read.  One of
136    them turns out to be better than the other, so leave only the
137    "--indent-heuristic" option and remove the other one.
138    (merge 3cde4e02ee jc/retire-compaction-heuristics later to maint).
139
140  * A new submodule helper "git submodule embedgitdirs" to make it
141    easier to move embedded .git/ directory for submodules in a
142    superproject to .git/modules/ (and point the latter with the former
143    that is turned into a "gitdir:" file) has been added.
144
145  * "git push \\server\share\dir" has recently regressed and then
146    fixed.  A test has retroactively been added for this breakage.
147
148  * Build updates for Cygwin.
149
150  * The implementation of "real_path()" was to go there with chdir(2)
151    and call getcwd(3), but this obviously wouldn't be usable in a
152    threaded environment.  Rewrite it to manually resolve relative
153    paths including symbolic links in path components.
154
155  * Adjust documentation to help AsciiDoctor render better while not
156    breaking the rendering done by AsciiDoc.
157
158  * The sequencer machinery has been further enhanced so that a later
159    set of patches can start using it to reimplement "rebase -i".
160
161  * Update the definition of the MacOSX test environment used by
162    TravisCI.
163
164  * Rewrite a scripted porcelain "git difftool" in C.
165    (merge 94d3997ecc js/difftool-builtin later to maint).
166
167
168 Also contains various documentation updates and code clean-ups.
169
170 Fixes since v2.10
171 -----------------
172
173 Unless otherwise noted, all the fixes since v2.9 in the maintenance
174 track are contained in this release (see the maintenance releases'
175 notes for details).
176
177  * We often decide if a session is interactive by checking if the
178    standard I/O streams are connected to a TTY, but isatty() that
179    comes with Windows incorrectly returned true if it is used on NUL
180    (i.e. an equivalent to /dev/null).  This has been fixed.
181
182  * "git svn" did not work well with path components that are "0", and
183    some configuration variable it uses were not documented.
184
185  * "git rev-parse --symbolic" failed with a more recent notation like
186    "HEAD^-1" and "HEAD^!".
187
188  * An empty directory in a working tree that can simply be nuked used
189    to interfere while merging or cherry-picking a change to create a
190    submodule directory there, which has been fixed..
191
192  * The code in "git push" to compute if any commit being pushed in the
193    superproject binds a commit in a submodule that hasn't been pushed
194    out was overly inefficient, making it unusable even for a small
195    project that does not have any submodule but have a reasonable
196    number of refs.
197
198  * "git push --dry-run --recurse-submodule=on-demand" wasn't
199    "--dry-run" in the submodules.
200
201  * The output from "git worktree list" was made in readdir() order,
202    and was unstable.
203
204  * mergetool.<tool>.trustExitCode configuration variable did not apply
205    to built-in tools, but now it does.
206
207  * "git p4" LFS support was broken when LFS stores an empty blob.
208
209  * A corner case in merge-recursive regression that crept in
210    during 2.10 development cycle has been fixed.
211
212  * Transport with dumb http can be fooled into following foreign URLs
213    that the end user does not intend to, especially with the server
214    side redirects and http-alternates mechanism, which can lead to
215    security issues.  Tighten the redirection and make it more obvious
216    to the end user when it happens.
217
218  * Update the error messages from the dumb-http client when it fails
219    to obtain loose objects; we used to give sensible error message
220    only upon 404 but we now forbid unexpected redirects that needs to
221    be reported with something sensible.
222
223  * When diff.renames configuration is on (and with Git 2.9 and later,
224    it is enabled by default, which made it worse), "git stash"
225    misbehaved if a file is removed and another file with a very
226    similar content is added.
227
228  * "git diff --no-index" did not take "--no-abbrev" option.
229
230  * "git difftool --dir-diff" had a minor regression when started from
231    a subdirectory, which has been fixed.
232
233  * "git commit --allow-empty --only" (no pathspec) with dirty index
234    ought to be an acceptable way to create a new commit that does not
235    change any paths, but it was forbidden, perhaps because nobody
236    needed it so far.
237
238  * Git 2.11 had a minor regression in "merge --ff-only" that competed
239    with another process that simultanously attempted to update the
240    index. We used to explain what went wrong with an error message,
241    but the new code silently failed.  The error message has been
242    resurrected.
243
244  * A pathname that begins with "//" or "\\" on Windows is special but
245    path normalization logic was unaware of it.
246
247  * "git pull --rebase", when there is no new commits on our side since
248    we forked from the upstream, should be able to fast-forward without
249    invoking "git rebase", but it didn't.
250
251  * The way to specify hotkeys to "xxdiff" that is used by "git
252    mergetool" has been modernized to match recent versions of xxdiff.
253
254  * Unlike "git am --abort", "git cherry-pick --abort" moved HEAD back
255    to where cherry-pick started while picking multiple changes, when
256    the cherry-pick stopped to ask for help from the user, and the user
257    did "git reset --hard" to a different commit in order to re-attempt
258    the operation.
259
260  * Code cleanup in shallow boundary computation.
261
262  * A recent update to receive-pack to make it easier to drop garbage
263    objects made it clear that GIT_ALTERNATE_OBJECT_DIRECTORIES cannot
264    have a pathname with a colon in it (no surprise!), and this in turn
265    made it impossible to push into a repository at such a path.  This
266    has been fixed by introducing a quoting mechanism used when
267    appending such a path to the colon-separated list.
268
269  * The function usage_msg_opt() has been updated to say "fatal:"
270    before the custom message programs give, when they want to die
271    with a message about wrong command line options followed by the
272    standard usage string.
273
274  * "git index-pack --stdin" needs an access to an existing repository,
275    but "git index-pack file.pack" to generate an .idx file that
276    corresponds to a packfile does not.
277
278  * Fix for NDEBUG builds.
279
280  * A lazy "git push" without refspec did not internally use a fully
281    specified refspec to perform 'current', 'simple', or 'upstream'
282    push, causing unnecessary "ambiguous ref" errors.
283
284  * "git p4" misbehaved when swapping a directory and a symbolic link.
285
286  * Even though an fix was attempted in Git 2.9.3 days, but running
287    "git difftool --dir-diff" from a subdirectory never worked. This
288    has been fixed.
289
290  * "git p4" that tracks multile p4 paths imported a single changelist
291    that touches files in these multiple paths as one commit, followed
292    by many empty commits.  This has been fixed.
293
294  * A potential but unlikely buffer overflow in Windows port has been
295    fixed.
296
297  * When the http server gives an incomplete response to a smart-http
298    rpc call, it could lead to client waiting for a full response that
299    will never come.  Teach the client side to notice this condition
300    and abort the transfer.
301
302  * Compression setting for producing packfiles were spread across
303    three codepaths, one of which did not honor any configuration.
304    Unify these so that all of them honor core.compression and
305    pack.compression variables the same way.
306
307  * "git fast-import" sometimes mishandled while rebalancing notes
308    tree, which has been fixed.
309
310  * Recent update to the default abbreviation length that auto-scales
311    lacked documentation update, which has been corrected.
312
313  * Leakage of lockfiles in the config subsystem has been fixed.
314
315  * It is natural that "git gc --auto" may not attempt to pack
316    everything into a single pack, and there is no point in warning
317    when the user has configured the system to use the pack bitmap,
318    leading to disabling further "gc".
319
320  * "git archive" did not read the standard configuration files, and
321    failed to notice a file that is marked as binary via the userdiff
322    driver configuration.
323
324  * "git blame --porcelain" misidentified the "previous" <commit, path>
325    pair (aka "source") when contents came from two or more files.
326
327  * "git rebase -i" with a recent update started showing an incorrect
328    count when squashing more than 10 commits.
329
330  * "git <cmd> @{push}" on a detached HEAD used to segfault; it has
331    been corrected to error out with a message.
332
333  * Running "git add a/b" when "a" is a submodule correctly errored
334    out, but without a meaningful error message.
335    (merge 2d81c48fa7 sb/pathspec-errors later to maint).
336
337  * Typing ^C to pager, which usually does not kill it, killed Git and
338    took the pager down as a collateral damage in certain process-tree
339    structure.  This has been fixed.
340
341  * "git mergetool" without any pathspec on the command line that is
342    run from a subdirectory became no-op in Git v2.11 by mistake, which
343    has been fixed.
344
345  * Retire long unused/unmaintained gitview from the contrib/ area.
346    (merge 3120925c25 sb/remove-gitview later to maint).
347
348  * Tighten a test to avoid mistaking an extended ERE regexp engine as
349    a PRE regexp engine.
350
351  * An error message with an ASCII control character like '\r' in it
352    can alter the message to hide its early part, which is problematic
353    when a remote side gives such an error message that the local side
354    will relay with a "remote: " prefix.
355    (merge f290089879 jk/vreport-sanitize later to maint).
356
357  * "git fsck" inspects loose objects more carefully now.
358    (merge cce044df7f jk/loose-object-fsck later to maint).
359
360  * A crashing bug introduced in v2.11 timeframe has been found (it is
361    triggerable only in fast-import) and fixed.
362    (merge abd5a00268 jk/clear-delta-base-cache-fix later to maint).
363
364  * With an anticipatory tweak for remotes defined in ~/.gitconfig
365    (e.g. "remote.origin.prune" set to true, even though there may or
366    may not actually be "origin" remote defined in a particular Git
367    repository), "git remote rename" and other commands misinterpreted
368    and behaved as if such a non-existing remote actually existed.
369    (merge e459b073fb js/remote-rename-with-half-configured-remote later to maint).
370
371  * A few codepaths had to rely on a global variable when sorting
372    elements of an array because sort(3) API does not allow extra data
373    to be passed to the comparison function.  Use qsort_s() when
374    natively available, and a fallback implementation of it when not,
375    to eliminate the need, which is a prerequisite for making the
376    codepath reentrant.
377    (merge 83fc4d64fe rs/qsort-s later to maint).
378
379  * "git fsck --connectivity-check" was not working at all.
380    (merge a2b22854bd jk/fsck-connectivity-check-fix later to maint).
381
382  * After starting "git rebase -i", which first opens the user's editor
383    to edit the series of patches to apply, but before saving the
384    contents of that file, "git status" failed to show the current
385    state (i.e. you are in an interactive rebase session, but you have
386    applied no steps yet) correctly.
387    (merge df9ded4984 js/status-pre-rebase-i later to maint).
388
389  * Test tweak for FreeBSD where /usr/bin/unzip is unsuitable to run
390    our tests but /usr/local/bin/unzip is usable.
391    (merge d98b2c5fce js/unzip-in-usr-bin-workaround later to maint).
392
393  * "git p4" did not work well with multiple git-p4.mapUser entries on
394    Windows.
395    (merge c3c2b05776 gv/mingw-p4-mapuser later to maint).
396
397  * "git help" enumerates executable files in $PATH; the implementation
398    of "is this file executable?" on Windows has been optimized.
399    (merge c755015f79 hv/mingw-help-is-executable later to maint).
400
401  * Test tweaks for those who have default ACL in their git source tree
402    that interfere with the umask test.
403    (merge d549d21307 mm/reset-facl-before-umask-test later to maint).
404
405  * Names of the various hook scripts must be spelled exactly, but on
406    Windows, an .exe binary must be named with .exe suffix; notice
407    $GIT_DIR/hooks/<hookname>.exe as a valid <hookname> hook.
408    (merge 235be51fbe js/mingw-hooks-with-exe-suffix later to maint).
409
410  * Asciidoctor, an alternative reimplementation of AsciiDoc, still
411    needs some changes to work with documents meant to be formatted
412    with AsciiDoc.  "make USE_ASCIIDOCTOR=YesPlease" to use it out of
413    the box to document our pages is getting closer to reality.
414    (merge 55d2d812e4 bc/use-asciidoctor-opt later to maint).
415
416  * Other minor doc, test and build updates and code cleanups.
417    (merge f2627d9b19 sb/submodule-config-cleanup later to maint).
418    (merge 384f1a167b sb/unpack-trees-cleanup later to maint).
419    (merge 874444b704 rh/diff-orderfile-doc later to maint).
420    (merge eafd5d9483 cw/doc-sign-off later to maint).
421    (merge 0aaad415bc rs/absolute-pathdup later to maint).
422    (merge 4432dd6b5b rs/receive-pack-cleanup later to maint).
423    (merge 540a398e9c sg/mailmap-self later to maint).