Update draft release notes to 1.8.3
[git/git.git] / Documentation / RelNotes / 1.8.3.txt
CommitLineData
048d4d98
JH
1Git v1.8.3 Release Notes
2========================
3
4Backward compatibility notes (for Git 2.0)
5------------------------------------------
6
7When "git push [$there]" does not say what to push, we have used the
8traditional "matching" semantics so far (all your branches were sent
9to the remote as long as there already are branches of the same name
10over there). In Git 2.0, the default will change to the "simple"
e7a3c902
MB
11semantics that pushes only the current branch to the branch with the same
12name, and only when the current branch is set to integrate with that
13remote branch. Use the user preference configuration variable
048d4d98 14"push.default" to change this. If you are an old-timer who is used
e7a3c902
MB
15to the "matching" semantics, you can set the variable to "matching"
16to keep the traditional behaviour. If you want to live in the future
17early, you can set it to "simple" today without waiting for Git 2.0.
18
19When "git add -u" (and "git add -A") is run inside a subdirectory and
20does not specify which paths to add on the command line, it
21will operate on the entire tree in Git 2.0 for consistency
22with "git commit -a" and other commands. There will be no
23mechanism to make plain "git add -u" behave like "git add -u .".
24Current users of "git add -u" (without a pathspec) should start
25training their fingers to explicitly say "git add -u ."
26before Git 2.0 comes. A warning is issued when these commands are
d2949c7b
JH
27run without a pathspec and when you have local changes outside the
28current directory, because the behaviour in Git 2.0 will be different
29from today's version in such a situation.
048d4d98 30
b75cdfaa
JH
31In Git 2.0, "git add <path>" will behave as "git add -A <path>", so
32that "git add dir/" will notice paths you removed from the directory
33and record the removal. Versions before Git 2.0, including this
34release, will keep ignoring removals, but the users who rely on this
e7a3c902
MB
35behaviour are encouraged to start using "git add --ignore-removal <path>"
36now before 2.0 is released.
b75cdfaa 37
048d4d98
JH
38
39Updates since v1.8.2
40--------------------
41
3d88f83d
JH
42Foreign interface
43
b75cdfaa 44 * remote-hg and remote-bzr helpers (in contrib/) have been updated.
3d88f83d
JH
45
46
048d4d98
JH
47UI, Workflows & Features
48
de0977d5
JH
49 * The prompt string generator (in contrib/completion/) learned to
50 show how many changes there are in total and how many have been
51 replayed during a "git rebase" session.
52
d2949c7b
JH
53 * "git branch --vv" learned to paint the name of the branch it
54 integrates with in a different color (color.branch.upstream,
55 which defaults to blue).
56
3d88f83d
JH
57 * In a sparsely populated working tree, "git checkout <pathspec>" no
58 longer unmarks paths that match the given pathspec that were
59 originally ignored with "--sparse" (use --ignore-skip-worktree-bits
60 option to resurrect these paths out of the index if you really want
61 to).
62
562af5b0
JH
63 * "git log --format" specifier learned %C(auto) token that tells Git
64 to use color when interpolating %d (decoration), %h (short commit
65 object name), etc. for terminal output.
66
3d88f83d
JH
67 * "git bisect" leaves the final outcome as a comment in its bisect
68 log file.
69
70 * "git clone --reference" can now refer to a gitfile "textual symlink"
71 that points at the real location of the repository.
72
d2949c7b
JH
73 * "git count-objects" learned "--human-readable" aka "-H" option to
74 show various large numbers in Ki/Mi/GiB scaled as necessary.
75
76 * "git cherry-pick $blob" and "git cherry-pick $tree" are nonsense,
77 and a more readable error message e.g. "can't cherry-pick a tree"
78 is given (we used to say "expected exactly one commit").
79
1468a583
JH
80 * The "--annotate" option to "git send-email" can be turned on (or
81 off) by default with sendemail.annotate configuration variable (you
82 can use --no-annotate from the command line to override it).
83
84 * The "--cover-letter" option to "git format-patch" can be turned on
85 (or off) by default with format.coverLetter configuration
86 variable. By setting it to 'auto', you can turn it on only for a
87 series with two or more patches.
88
89 * The bash completion support (in contrib/) learned that cherry-pick
90 takes a few more options than it already knew about.
91
7ece7ee6
JH
92 * "git help" learned "-g" option to show the list of guides just like
93 list of commands are given with "-a".
94
c17b651f
JH
95 * A triangular "pull from one place, push to another place" workflow
96 is supported better by new remote.pushdefault (overrides the
97 "origin" thing) and branch.*.pushremote (overrides the
98 branch.*.remote) configuration variables.
99
100 * "git status" learned to report that you are in the middle of a
101 revert session, just like it does for a cherry-pick and a bisect
102 session.
103
7ece7ee6
JH
104 * The handling by "git branch --set-upstream-to" against various forms
105 of erroneous inputs was suboptimal and has been improved.
c17b651f 106
7b592fad 107 * When the interactive access to git-shell is not enabled, it issues
7ece7ee6 108 a message meant to help the system administrator to enable it.
7b592fad
JH
109 An explicit way to help the end users who connect to the service by
110 issuing custom messages to refuse such an access has been added.
111
cc3e4eba
JH
112 * In addition to the case where the user edits the log message with
113 the "e)dit" option of "am -i", replace the "Applying: this patch"
114 message with the final log message contents after applymsg hook
115 munges it.
116
117 * "git status" suggests users to look into using --untracked=no option
7b592fad
JH
118 when it takes too long.
119
e7a3c902 120 * "git status" shows a bit more information during a
cc3e4eba
JH
121 rebase/bisect session.
122
7b592fad
JH
123 * "git fetch" learned to fetch a commit at the tip of an unadvertised
124 ref by specifying a raw object name from the command line when the
125 server side supports this feature.
126
aec3f779
JH
127 * Output from "git log --graph" works better with submodule log
128 output now.
129
7b592fad
JH
130 * "git count-objects -v" learned to report leftover temporary
131 packfiles and other garbage in the object store.
132
133 * A new read-only credential helper (in contrib/) to interact with
134 the .netrc/.authinfo files has been added.
135
136 * "git send-email" can be used with the credential helper system.
048d4d98 137
7632cd27
JH
138 * There was no Porcelain way to say "I no longer am interested in
139 this submodule", once you express your interest in a submodule with
140 "submodule init". "submodule deinit" is the way to do so.
141
142 * "git pull --rebase" learned to pass "-v/-q" options to underlying
143 "git rebase".
144
145 * The new "--follow-tags" option tells "git push" to push relevant
146 annotated tags when pushing branches out.
147
21ccebec
JH
148 * "git merge" and "git pull" can optionally be told to inspect and
149 reject when merging a commit that does not carry a trusted GPG
150 signature.
151
2bba2f0e
JH
152 * "git mergetool" now feeds files to the "p4merge" backend in the
153 order that matches the p4 convention, where "theirs" is usually
e7a3c902
MB
154 shown on the left side, which is the opposite from what other backends
155 expect.
048d4d98 156
961c5129
JH
157 * "show/log" now honors gpg.program configuration just like other
158 parts of the code that use GnuPG.
159
160 * "git log" that shows the difference between the parent and the
161 child has been optimized somewhat.
162
8d994db4
JH
163 * "git difftool" allows the user to write into the temporary files
164 being shown; if the user makes changes to the working tree at the
de0977d5
JH
165 same time, it now refrains from overwriting the copy in the working
166 tree and leaves the temporary file so that changes can be merged
167 manually.
8d994db4
JH
168
169 * There was no good way to ask "I have a random string that came from
170 outside world. I want to turn it into a 40-hex object name while
171 making sure such an object exists". A new peeling suffix ^{object}
172 can be used for that purpose, together with "rev-parse --verify".
173
048d4d98
JH
174
175Performance, Internal Implementation, etc.
176
7b9a4198 177 * Updates for building under msvc.
048d4d98 178
e7a3c902 179 * A handful of issues in the code that traverses the working tree to find
562af5b0
JH
180 untracked and/or ignored files have been fixed, and the general
181 codepath involved in "status -u" and "clean" have been cleaned up
182 and optimized.
183
1468a583
JH
184 * The stack footprint of some codepaths that access an object from a
185 pack has been shrunk.
186
7ece7ee6 187 * The logic to coalesce the same lines removed from the parents in
e7a3c902 188 the output from "diff -c/--cc" has been updated, but with O(n^2)
7ece7ee6
JH
189 complexity, so this might turn out to be undesirable.
190
c17b651f 191 * The code to enforce permission bits on files in $GIT_DIR/ for
e7a3c902 192 shared repositories has been simplified.
c17b651f 193
e7a3c902
MB
194 * A few codepaths know how much data they need to put in the
195 hashtables they use when they start, but still began with small tables
196 and repeatedly grew and rehashed them.
7b592fad 197
2bba2f0e
JH
198 * The API to walk reflog entries from the latest to older, which was
199 necessary for operations such as "git checkout -", was cumbersome
200 to use correctly and also inefficient.
201
cc3e4eba
JH
202 * Codepaths that inspect log-message-to-be and decide when to add a
203 new Signed-off-by line in various commands have been consolidated.
204
205 * The pkt-line API, implementation and its callers have been cleaned
206 up to make them more robust.
207
e7a3c902 208 * The Cygwin port has a faster-but-lying lstat(2) emulation whose
961c5129 209 incorrectness does not matter in practice except for a few
e7a3c902 210 codepaths, and setting permission bits on directories is a codepath
961c5129
JH
211 that needs to use a more correct one.
212
8d994db4
JH
213 * "git checkout" had repeated pathspec matches on the same paths,
214 which have been consolidated. Also a bug in "git checkout dir/"
215 that is started from an unmerged index has been fixed.
216
7ece7ee6
JH
217 * A few bugfixes to "git rerere" working on corner case merge
218 conflicts have been applied.
219
048d4d98 220
1468a583 221Also contains various documentation updates and code clean-ups.
048d4d98
JH
222
223
224Fixes since v1.8.2
225------------------
226
227Unless otherwise noted, all the fixes since v1.8.2 in the maintenance
228track are contained in this release (see release notes to them for
229details).
7b9a4198 230
de0977d5
JH
231 * Recent versions of File::Temp (used by "git svn") started blowing
232 up when its tempfile sub is called as a class method; updated the
233 callsite to call it as a plain vanilla function to fix it.
234 (merge eafc2dd hb/git-pm-tempfile later to maint).
235
236 * Various subcommands of "git remote" simply ignored extraneous
237 command line arguments instead of diagnosing them as errors.
238 (merge b17dd3f tr/remote-tighten-commandline-parsing later to maint).
239
e7a3c902 240 * When receive-pack detects an error in the pack header it received in
562af5b0 241 order to decide which of unpack-objects or index-pack to run, it
e7a3c902 242 returned without closing the error stream, which led to a hung
562af5b0 243 sideband thread.
562af5b0 244
e7a3c902 245 * Zsh completion forgot that the '%' character used to signal untracked
562af5b0 246 files needs to be escaped with another '%'.
562af5b0 247
3d88f83d 248 * A commit object whose author or committer ident are malformed
e7a3c902 249 crashed some code that trusted that a name, an email and a
3d88f83d 250 timestamp can always be found in it.
3d88f83d 251
d2949c7b 252 * When "upload-pack" fails while generating a pack in response to
e7a3c902
MB
253 "git fetch" (or "git clone"), the receiving side had
254 a programming error that triggered the die handler
d2949c7b 255 recursively.
d2949c7b 256
e7a3c902
MB
257 * "rev-list --stdin" and friends kept bogus pointers into the input
258 buffer around as human readable object names. This was not a huge
d2949c7b
JH
259 problem but was exposed by a new change that uses these names in
260 error output.
261 (merge 70d26c6 tr/copy-revisions-from-stdin later to maint).
262
1468a583 263 * Smart-capable HTTP servers were not restricted via the
e7a3c902
MB
264 GIT_NAMESPACE mechanism when talking with commit-walking clients,
265 like they are when talking with smart HTTP clients.
1468a583
JH
266 (merge 6130f86 jk/http-dumb-namespaces later to maint).
267
268 * "git merge-tree" did not omit a merge result that is identical to
e7a3c902 269 the "our" side in certain cases.
1468a583
JH
270 (merge aacecc3 jk/merge-tree-added-identically later to maint).
271
e7a3c902 272 * Perl scripts like "git-svn" closed (instead of redirecting to /dev/null)
aec3f779 273 the standard error stream, which is not a very smart thing to do.
e7a3c902
MB
274 A later open may return file descriptor #2 for an unrelated purpose, and
275 error reporting code may write into it.
aec3f779
JH
276
277 * "git show-branch" was not prepared to show a very long run of
278 ancestor operators e.g. foobar^2~2^2^2^2...^2~4 correctly.
aec3f779
JH
279
280 * "git diff --diff-algorithm algo" is also understood as "git diff
281 --diff-algorithm=algo".
aec3f779 282
e7a3c902 283 * The new core.commentchar configuration was not applied in a few
aec3f779 284 places.
aec3f779 285
e7a3c902
MB
286 * "git bundle" erroneously bailed out when parsing a valid bundle
287 containing a prerequisite commit without a commit message.
aec3f779 288
7ece7ee6 289 * "git log -S/-G" started paying attention to textconv filter, but
e7a3c902 290 there was no way to disable this. Make it honor the --no-textconv
7ece7ee6 291 option.
7ece7ee6 292
e7a3c902 293 * When used with the "-d temporary-directory" option, "git filter-branch"
c17b651f
JH
294 failed to come back to the original working tree to perform the
295 final clean-up procedure.
c17b651f 296
21ccebec
JH
297 * "git merge $(git rev-parse v1.8.2)" behaved quite differently from
298 "git merge v1.8.2", as if v1.8.2 were written as v1.8.2^0 and did
299 not pay much attention to the annotated tag payload. Make the code
300 notice the type of the tag object, in addition to the dwim_ref()
301 based classification the current code uses (i.e. the name appears
e7a3c902 302 in refs/tags/) to decide when to special-case tag merging.
21ccebec 303
e7a3c902 304 * Fix a 1.8.1.x regression that stopped matching "dir" (without a
8d994db4
JH
305 trailing slash) to a directory "dir".
306 (merge efa5f82 jc/directory-attrs-regression-fix later to maint-1.8.1).
307
308 * "git apply --whitespace=fix" was not prepared to see a line getting
309 longer after fixing whitespaces (e.g. tab-in-indent aka Python).
310 (merge 329b26e jc/apply-ws-fix-tab-in-indent later to maint-1.8.1).
311
312 * The prompt string generator (in contrib/completion/) did not notice
313 when we are in a middle of a "git revert" session.
8d994db4 314
e7a3c902 315 * "submodule summary --summary-limit" option did not support the
8d994db4 316 "--option=value" form.
8d994db4 317
7ece7ee6 318 * "index-pack --fix-thin" used an uninitialized value to compute
e7a3c902 319 the delta depths of objects it appends to the resulting pack.
cc3e4eba 320
e7a3c902
MB
321 * "index-pack --verify-stat" used a few counters outside the protection
322 of a mutex, possibly showing incorrect numbers.
cc3e4eba
JH
323
324 * The code to keep track of what directory names are known to Git on
e7a3c902
MB
325 platforms with case insensitive filesystems could get confused upon a
326 hash collision between these pathnames and would loop forever.
cc3e4eba 327
e7a3c902
MB
328 * Annotated tags outside the refs/tags/ hierarchy were not advertised
329 correctly to ls-remote and fetch with recent versions of Git.
7632cd27 330
e7a3c902 331 * Recent optimizations broke shallow clones.
7632cd27
JH
332
333 * "git cmd -- ':(top'" was not diagnosed as an invalid syntax, and
334 instead the parser kept reading beyond the end of the string.
7632cd27
JH
335
336 * "git tag -f <tag>" always said "Updated tag '<tag>'" even when
e7a3c902 337 creating a new tag (i.e. neither overwriting nor updating).
7632cd27
JH
338
339 * "git p4" did not behave well when the path to the root of the P4
340 client was not its real path.
341 (merge bbd8486 pw/p4-symlinked-root later to maint).
342
e7a3c902
MB
343 * "git archive" reported a failure when asked to create an archive out
344 of an empty tree. It is more intuitive to give an empty
7632cd27 345 archive back in such a case.
7632cd27 346
e7a3c902 347 * When "format-patch" quoted a non-ascii string in header files,
7632cd27 348 it incorrectly applied rfc2047 and chopped a single character in
e7a3c902 349 the middle of the string.
7632cd27
JH
350
351 * An aliased command spawned from a bare repository that does not say
e7a3c902 352 it is bare with "core.bare = yes" was treated as non-bare by mistake.
7632cd27 353
e7a3c902 354 * In "git reflog expire", the REACHABLE bit was not cleared from the
7632cd27 355 correct objects.
7632cd27
JH
356
357 * The logic used by "git diff -M --stat" to shorten the names of
358 files before and after a rename did not work correctly when the
359 common prefix and suffix between the two filenames overlapped.
7632cd27
JH
360
361 * The "--match=<pattern>" option of "git describe", when used with
e7a3c902 362 "--all" to allow refs that are not annotated tags to be a
7632cd27 363 base of description, did not restrict the output from the command
e7a3c902 364 to those refs that match the given pattern.
7632cd27 365
7b592fad
JH
366 * Clarify in the documentation "what" gets pushed to "where" when the
367 command line to "git push" does not say these explicitly.
7b592fad 368
7b9a4198
JH
369 * The "--color=<when>" argument to the commands in the diff family
370 was described poorly.
7b9a4198 371
e7a3c902 372 * The arguments given to the pre-rebase hook were not documented.
7b9a4198
JH
373
374 * The v4 index format was not documented.
7b9a4198
JH
375
376 * The "--match=<pattern>" argument "git describe" takes uses glob
377 pattern but it wasn't obvious from the documentation.
7b9a4198
JH
378
379 * Some sources failed to compile on systems that lack NI_MAXHOST in
380 their system header (e.g. z/OS).
7b9a4198
JH
381
382 * Add an example use of "--env-filter" in "filter-branch"
383 documentation.
7b9a4198
JH
384
385 * "git bundle verify" did not say "records a complete history" for a
386 bundle that does not have any prerequisites.
7b9a4198
JH
387
388 * In the v1.8.0 era, we changed symbols that do not have to be global
389 to file scope static, but a few functions in graph.c were used by
e7a3c902 390 CGit sideways, bypassing the entry points of the API the
7b9a4198 391 in-tree users use.
7b592fad
JH
392
393 * "git update-index -h" did not do the usual "-h(elp)" thing.
394
395 * "git index-pack" had a buffer-overflow while preparing an
396 informational message when the translated version of it was too
397 long.
7b592fad
JH
398
399 * 'git commit -m "$msg"' used to add an extra newline even when
400 $msg already ended with one.
7b592fad
JH
401
402 * The SSL peer verification done by "git imap-send" did not ask for
e7a3c902 403 Server Name Indication (RFC 4366), failing to connect to SSL/TLS
7b592fad 404 sites that serve multiple hostnames on a single IP.
7b592fad
JH
405
406 * perl/Git.pm::cat_blob slurped everything in core only to write it
407 out to a file descriptor, which was not a very smart thing to do.
7b592fad
JH
408
409 * "git branch" did not bother to check nonsense command line
e7a3c902 410 parameters. It now issues errors in many cases.
7b592fad 411
e7a3c902 412 * Verification of signed tags was not done correctly when not in C
7b592fad 413 or en/US locale.
7b592fad
JH
414
415 * Some platforms and users spell UTF-8 differently; retry with the
416 most official "UTF-8" when the system does not understand the
e7a3c902
MB
417 user-supplied encoding name that is a common alternative
418 spelling of UTF-8.
7b592fad 419
e7a3c902 420 * When export-subst is used, "zip" output recorded an incorrect
7b592fad 421 size of the file.
7b592fad
JH
422
423 * "git am $maildir/" applied messages in an unexpected order; sort
424 filenames read from the maildir/ in a way that is more likely to
e7a3c902
MB
425 sort the messages in the order the writing MUA meant to, by sorting
426 numeric segments in numeric order and non-numeric segments in
7b592fad 427 alphabetical order.
7b592fad
JH
428
429 * "git submodule update", when recursed into sub-submodules, did not
7ece7ee6 430 accumulate the prefix paths.