Sync with master
[git] / Documentation / RelNotes / 2.13.0.txt
1 Git 2.13 Release Notes
2 ======================
3
4 Backward compatibility notes.
5
6  * Use of an empty string as a pathspec element that is used for
7    'everything matches' is still warned and Git asks users to use a
8    more explicit '.' for that instead.  The hope is that existing
9    users will not mind this change, and eventually the warning can be
10    turned into a hard error, upgrading the deprecation into removal of
11    this (mis)feature.  That is not scheduled to happen in the upcoming
12    release (yet).
13
14  * The historical argument order "git merge <msg> HEAD <commit>..."
15    has been deprecated for quite some time, and will be removed in a
16    future release.
17
18
19 Updates since v2.12
20 -------------------
21
22 UI, Workflows & Features
23
24  * "git describe" and "git name-rev" have been taught to take more
25    than one refname patterns to restrict the set of refs to base their
26    naming output on, and also learned to take negative patterns to
27    name refs not to be used for naming via their "--exclude" option.
28
29  * Deletion of a branch "foo/bar" could remove .git/refs/heads/foo
30    once there no longer is any other branch whose name begins with
31    "foo/", but we didn't do so so far.  Now we do.
32
33  * When "git merge" detects a path that is renamed in one history
34    while the other history deleted (or modified) it, it now reports
35    both paths to help the user understand what is going on in the two
36    histories being merged.
37
38  * The <url> part in "http.<url>.<variable>" configuration variable
39    can now be spelled with '*' that serves as wildcard.
40    E.g. "http.https://*.example.com.proxy" can be used to specify the
41    proxy used for https://a.example.com, https://b.example.com, etc.,
42    i.e. any host in the example.com domain.
43
44  * "git tag" did not leave useful message when adding a new entry to
45    reflog; this was left unnoticed for a long time because refs/tags/*
46    doesn't keep reflog by default.
47
48  * The "negative" pathspec feature was somewhat more cumbersome to use
49    than necessary in that its short-hand used "!" which needed to be
50    escaped from shells, and it required "exclude from what?" specified.
51
52  * The command line options for ssh invocation needs to be tweaked for
53    some implementations of SSH (e.g. PuTTY plink wants "-P <port>"
54    while OpenSSH wants "-p <port>" to specify port to connect to), and
55    the variant was guessed when GIT_SSH environment variable is used
56    to specify it.  The logic to guess now applies to the command
57    specified by the newer GIT_SSH_COMMAND and also core.sshcommand
58    configuration variable, and comes with an escape hatch for users to
59    deal with misdetected cases.
60
61  * The "--git-path", "--git-common-dir", and "--shared-index-path"
62    options of "git rev-parse" did not produce usable output.  They are
63    now updated to show the path to the correct file, relative to where
64    the caller is.
65
66  * "git diff -W" has been taught to handle the case where a new
67    function is added at the end of the file better.
68
69  * "git update-ref -d" and other operations to delete references did
70    not leave any entry in HEAD's reflog when the reference being
71    deleted was the current branch.  This is not a problem in practice
72    because you do not want to delete the branch you are currently on,
73    but caused renaming of the current branch to something else not to
74    be logged in a useful way.
75
76  * "Cc:" on the trailer part does not have to conform to RFC strictly,
77    unlike in the e-mail header.  "git send-email" has been updated to
78    ignore anything after '>' when picking addresses, to allow non-address
79    cruft like " # stable 4.4" after the address.
80    (merge 9d3343961b jh/send-email-one-cc later to maint).
81
82  * When "git submodule init" decides that the submodule in the working
83    tree is its upstream, it now gives a warning as it is not a very
84    common setup.
85    (merge d1b3b81aab sb/submodule-init-url-selection later to maint).
86
87  * "git stash save" takes a pathspec so that the local changes can be
88    stashed away only partially.
89    (merge 9e140909f6 tg/stash-push later to maint).
90
91
92 Performance, Internal Implementation, Development Support etc.
93
94  * The code to list branches in "git branch" has been consolidated
95    with the more generic ref-filter API.
96
97  * Resource usage while enumerating refs from alternate object store
98    has been optimized to help receiving end of "push" that hosts a
99    repository with many "forks".
100
101  * The gitattributes machinery is being taught to work better in a
102    multi-threaded environment.
103
104  * "git rebase -i" starts using the recently updated "sequencer" code.
105
106  * Code and design clean-up for the refs API.
107
108  * The preload-index code has been taught not to bother with the index
109    entries that are paths that are not checked out by "sparse checkout".
110
111  * Some warning() messages from "git clean" were updated to show the
112    errno from failed system calls.
113
114  * The "parse_config_key()" API function has been cleaned up.
115    (merge ad8c7cdadd jk/parse-config-key-cleanup later to maint).
116
117  * A test that creates a confusing branch whose name is HEAD has been
118    corrected not to do so.
119    (merge f0252ca23c jk/t6300-cleanup later to maint).
120
121  * The code that parses header fields in the commit object has been
122    updated for (micro)performance and code hygiene.
123    (merge b072504ce1 rs/commit-parsing-optim later to maint).
124
125  * An helper function to make it easier to append the result from
126    real_path() to a strbuf has been added.
127    (merge 33ad9ddd0b rs/strbuf-add-real-path later to maint).
128
129  * Reduce authentication round-trip over HTTP when the server supports
130    just a single authentication method.  This also improves the
131    behaviour when Git is misconfigured to enable http.emptyAuth
132    against a server that does not authenticate without a username
133    (i.e. not using Kerberos etc., which makes http.emptyAuth
134    pointless).
135    (merge 40a18fc77c jk/http-auth later to maint).
136
137
138 Also contains various documentation updates and code clean-ups.
139
140
141 Fixes since v2.12
142 -----------------
143
144 Unless otherwise noted, all the fixes since v2.9 in the maintenance
145 track are contained in this release (see the maintenance releases'
146 notes for details).
147
148  * "git repack --depth=<n>" for a long time busted the specified depth
149    when reusing delta from existing packs.  This has been corrected.
150    (merge 42b766d765 jk/delta-chain-limit later to maint).
151
152  * The code to parse the command line "git grep <patterns>... <rev>
153    [[--] <pathspec>...]" has been cleaned up, and a handful of bugs
154    have been fixed (e.g. we used to check "--" if it is a rev).
155    (merge 131f3c96d2 jk/grep-no-index-fix later to maint).
156
157  * "git ls-remote" and "git archive --remote" are designed to work
158    without being in a directory under Git's control.  However, recent
159    updates revealed that we randomly look into a directory called
160    .git/ without actually doing necessary set-up when working in a
161    repository.  Stop doing so.
162    (merge 4b0c3c7735 jn/remote-helpers-with-git-dir later to maint).
163
164  * "git show-branch" expected there were only very short branch names
165    in the repository and used a fixed-length buffer to hold them
166    without checking for overflow.
167    (merge d3cc5f4c44 jk/show-branch-lift-name-len-limit later to maint).
168
169  * A caller of tempfile API that uses stdio interface to write to
170    files may ignore errors while writing, which is detected when
171    tempfile is closed (with a call to ferror()).  By that time, the
172    original errno that may have told us what went wrong is likely to
173    be long gone and was overwritten by an irrelevant value.
174    close_tempfile() now resets errno to EIO to make errno at least
175    predictable.
176    (merge 7e8c9355b7 jk/tempfile-ferror-fclose-confusion later to maint).
177
178  * "git remote rm X", when a branch has remote X configured as the
179    value of its branch.*.remote, tried to remove branch.*.remote and
180    branch.*.merge and failed if either is unset.
181    (merge 20690b2139 rl/remote-allow-missing-branch-name-merge later to maint).
182
183  * A "gc.log" file left by a backgrounded "gc --auto" disables further
184    automatic gc; it has been taught to run at least once a day (by
185    default) by ignoring a stale "gc.log" file that is too old.
186    (merge a831c06a2b dt/gc-ignore-old-gc-logs later to maint).
187
188  * The code to parse "git -c VAR=VAL cmd" and set configuration
189    variable for the duration of cmd had two small bugs, which have
190    been fixed.
191    (merge 1274a155af jc/config-case-cmdline-take-2 later to maint).
192
193  * user.email that consists of only cruft chars should consistently
194    error out, but didn't.
195    (merge 94425552f3 jk/ident-empty later to maint).
196
197  * "git upload-pack", which is a counter-part of "git fetch", did not
198    report a request for a ref that was not advertised as invalid.
199    This is generally not a problem (because "git fetch" will stop
200    before making such a request), but is the right thing to do.
201    (merge bdb31eada7 jt/upload-pack-error-report later to maint).
202
203  * A leak in a codepath to read from a packed object in (rare) cases
204    has been plugged.
205    (merge 886ddf4777 rs/sha1-file-plug-fallback-base-leak later to maint).
206
207  * When a redirected http transport gets an error during the
208    redirected request, we ignored the error we got from the server,
209    and ended up giving a not-so-useful error message.
210    (merge 8e27391a5f jt/http-base-url-update-upon-redirect later to maint).
211
212  * Other minor doc, test and build updates and code cleanups.
213    (merge 2cfa83574c mm/two-more-xstrfmt later to maint).
214    (merge b803ae4427 ps/docs-diffcore later to maint).
215    (merge bcd886d897 ew/markdown-url-in-readme later to maint).
216    (merge b2d593a779 rj/remove-unused-mktemp later to maint).