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