asciidoctor: fix user-manual to be built by `asciidoctor`
[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 the
15    upcoming 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
65 Performance, Internal Implementation, Development Support etc.
66
67  * Commands that operate on a log message and add lines to the trailer
68    blocks, such as "format-patch -s", "cherry-pick (-x|-s)", and
69    "commit -s", have been taught to use the logic of and share the
70    code with "git interpret-trailer".
71
72  * The default Travis-CI configuration specifies newer P4 and GitLFS.
73    (merge 5f703e8f02 ls/travis-update-p4-and-lfs later to maint).
74
75  * The "fast hash" that had disastrous performance issues in some
76    corner cases has been retired from the internal diff.
77
78  * The character width table has been updated to match Unicode 9.0
79    (merge 9e6e9aefdf bb/unicode-9.0 later to maint).
80
81  * Update the procedure to generate "tags" for developer support.
82    (merge 046e4c1c09 jk/make-tags-find-sources-tweak later to maint).
83
84
85
86 Also contains various documentation updates and code clean-ups.
87
88 Fixes since v2.10
89 -----------------
90
91 Unless otherwise noted, all the fixes since v2.9 in the maintenance
92 track are contained in this release (see the maintenance releases'
93 notes for details).
94
95  * We often decide if a session is interactive by checking if the
96    standard I/O streams are connected to a TTY, but isatty() that
97    comes with Windows incorrectly returned true if it is used on NUL
98    (i.e. an equivalent to /dev/null).  This has been fixed.
99    (merge cbb3f3c9b1 js/mingw-isatty later to maint).
100
101  * "git svn" did not work well with path components that are "0", and
102    some configuration variable it uses were not documented.
103    (merge ea9a93dcc2 ew/svn-fixes later to maint).
104
105  * "git rev-parse --symbolic" failed with a more recent notation like
106    "HEAD^-1" and "HEAD^!".
107    (merge a2e7b04c44 jk/rev-parse-symbolic-parents-fix later to maint).
108
109  * An empty directory in a working tree that can simply be nuked used
110    to interfere while merging or cherry-picking a change to create a
111    submodule directory there, which has been fixed..
112    (merge 5423d2e700 dt/empty-submodule-in-merge later to maint).
113
114  * The code in "git push" to compute if any commit being pushed in the
115    superproject binds a commit in a submodule that hasn't been pushed
116    out was overly inefficient, making it unusable even for a small
117    project that does not have any submodule but have a reasonable
118    number of refs.
119    (merge 250ab24ab3 hv/submodule-not-yet-pushed-fix later to maint).
120
121  * "git push --dry-run --recurse-submodule=on-demand" wasn't
122    "--dry-run" in the submodules.
123    (merge 0301c821c5 bw/push-dry-run later to maint).
124
125  * The output from "git worktree list" was made in readdir() order,
126    and was unstable.
127    (merge 4df1d4d466 nd/worktree-list-fixup later to maint).
128
129  * mergetool.<tool>.trustExitCode configuration variable did not apply
130    to built-in tools, but now it does.
131    (merge 2967284456 da/mergetool-trust-exit-code later to maint).
132
133  * "git p4" LFS support was broken when LFS stores an empty blob.
134    (merge d5eb3cf5e7 ls/p4-empty-file-on-lfs later to maint).
135
136  * A corner case in merge-recursive regression that crept in
137    during 2.10 development cycle has been fixed.
138    (merge 1c25d2d8ed jc/renormalize-merge-kill-safer-crlf later to maint).
139
140  * Transport with dumb http can be fooled into following foreign URLs
141    that the end user does not intend to, especially with the server
142    side redirects and http-alternates mechanism, which can lead to
143    security issues.  Tighten the redirection and make it more obvious
144    to the end user when it happens.
145    (merge cb4d2d35c4 jk/http-walker-limit-redirect-2.9 later to maint).
146
147  * Update the error messages from the dumb-http client when it fails
148    to obtain loose objects; we used to give sensible error message
149    only upon 404 but we now forbid unexpected redirects that needs to
150    be reported with something sensible.
151    (merge 3680f16f9d jk/http-walker-limit-redirect later to maint).
152
153  * When diff.renames configuration is on (and with Git 2.9 and later,
154    it is enabled by default, which made it worse), "git stash"
155    misbehaved if a file is removed and another file with a very
156    similar content is added.
157    (merge 9d4e28ead5 jk/stash-disable-renames-internally later to maint).
158
159  * "git diff --no-index" did not take "--no-abbrev" option.
160    (merge 43d1948b7b jb/diff-no-index-no-abbrev later to maint).
161
162  * "git difftool --dir-diff" had a minor regression when started from
163    a subdirectory, which has been fixed.
164    (merge 853e10c197 da/difftool-dir-diff-fix later to maint).
165
166  * "git commit --allow-empty --only" (no pathspec) with dirty index
167    ought to be an acceptable way to create a new commit that does not
168    change any paths, but it was forbidden, perhaps because nobody
169    needed it so far.
170    (merge beb635ca9c ak/commit-only-allow-empty later to maint).
171
172  * Git 2.11 had a minor regression in "merge --ff-only" that competed
173    with another process that simultanously attempted to update the
174    index. We used to explain what went wrong with an error message,
175    but the new code silently failed.  The error message has been
176    resurrected.
177
178  * A pathname that begins with "//" or "\\" on Windows is special but
179    path normalization logic was unaware of it.
180    (merge 7814fbe3f1 js/normalize-path-copy-ceil later to maint).
181
182  * "git pull --rebase", when there is no new commits on our side since
183    we forked from the upstream, should be able to fast-forward without
184    invoking "git rebase", but it didn't.
185    (merge 33b842a1e9 jc/pull-rebase-ff later to maint).
186
187  * The way to specify hotkeys to "xxdiff" that is used by "git
188    mergetool" has been modernized to match recent versions of xxdiff.
189    (merge 6cf5f6cef7 da/mergetool-xxdiff-hotkey later to maint).
190
191  * Unlike "git am --abort", "git cherry-pick --abort" moved HEAD back
192    to where cherry-pick started while picking multiple changes, when
193    the cherry-pick stopped to ask for help from the user, and the user
194    did "git reset --hard" to a different commit in order to re-attempt
195    the operation.
196    (merge ce73bb22d8 sb/sequencer-abort-safety later to maint).
197
198  * Code cleanup in shallow boundary computation.
199    (merge 649b0c316a nd/shallow-fixup later to maint).
200
201  * A recent update to receive-pack to make it easier to drop garbage
202    objects made it clear that GIT_ALTERNATE_OBJECT_DIRECTORIES cannot
203    have a pathname with a colon in it (no surprise!), and this in turn
204    made it impossible to push into a repository at such a path.  This
205    has been fixed by introducing a quoting mechanism used when
206    appending such a path to the colon-separated list.
207    (merge 5e74824fac jk/quote-env-path-list-component later to maint).
208
209  * The function usage_msg_opt() has been updated to say "fatal:"
210    before the custom message programs give, when they want to die
211    with a message about wrong command line options followed by the
212    standard usage string.
213    (merge 87433261a4 jk/parseopt-usage-msg-opt later to maint).
214
215  * "git index-pack --stdin" needs an access to an existing repository,
216    but "git index-pack file.pack" to generate an .idx file that
217    corresponds to a packfile does not.
218    (merge 29401e1575 jk/index-pack-wo-repo-from-stdin later to maint).
219
220  * Fix for NDEBUG builds.
221    (merge 08414938a2 jt/mailinfo-fold-in-body-headers later to maint).
222
223  * A lazy "git push" without refspec did not internally use a fully
224    specified refspec to perform 'current', 'simple', or 'upstream'
225    push, causing unnecessary "ambiguous ref" errors.
226    (merge b284495e93 jc/push-default-explicit later to maint).
227
228  * "git p4" misbehaved when swapping a directory and a symbolic link.
229    (merge df8a9e86db ld/p4-compare-dir-vs-symlink later to maint).
230
231  * Even though an fix was attempted in Git 2.9.3 days, but running
232    "git difftool --dir-diff" from a subdirectory never worked. This
233    has been fixed.
234    (merge ce6926974e jk/difftool-in-subdir later to maint).
235
236  * "git p4" that tracks multile p4 paths imported a single changelist
237    that touches files in these multiple paths as one commit, followed
238    by many empty commits.  This has been fixed.
239    (merge 9943e5b979 gv/p4-multi-path-commit-fix later to maint).
240
241  * A potential but unlikely buffer overflow in Windows port has been
242    fixed.
243    (merge c46458e82f mk/mingw-winansi-ttyname-termination-fix later to maint).
244
245  * Other minor doc, test and build updates and code cleanups.
246    (merge fa6ca11105 nd/qsort-in-merge-recursive later to maint).
247    (merge fa3142c919 ak/lazy-prereq-mktemp later to maint).
248    (merge 9c48b4fb23 ls/t0021-fixup later to maint).
249    (merge 584f99c87b sb/unpack-trees-grammofix later to maint).
250    (merge 54471fdcc3 jk/readme-gmane-is-no-more later to maint).
251    (merge 9e189f1a5c sb/t3600-cleanup later to maint).
252    (merge e2c20be57c lr/doc-fix-cet later to maint).
253    (merge 47437fd3bd kh/tutorial-grammofix later to maint).
254    (merge f2627d9b19 sb/submodule-config-cleanup later to maint).
255    (merge 7eeda8b821 ls/filter-process later to maint).