Merge branch 'jk/die-on-bogus-worktree-late'
[git.git] / Documentation / RelNotes / 2.5.0.txt
blobe33b0ac18106e9af38bff0d791375ea50aa56a73
1 Git 2.5 Release Notes
2 =====================
4 Updates since v2.4
5 ------------------
7 Ports
10 UI, Workflows & Features
12  * The bash completion script (in contrib/) learned a few options that
13    "git revert" takes.
15  * Whitespace breakages in deleted and context lines can also be
16    painted in the output of "git diff" and friends with the new
17    --ws-error-highlight option.
19  * List of commands shown by "git help" are grouped along the workflow
20    elements to help early learners.
22  * "git p4" now detects the filetype (e.g. binary) correctly even when
23    the files are opened exclusively.
25  * git p4 attempts to better handle branches in Perforce.
27  * "git p4" learned "--changes-block-size <n>" to read the changes in
28    chunks from Perforce, instead of making one call to "p4 changes"
29    that may trigger "too many rows scanned" error from Perforce.
31  * Unlike "$EDITOR" and "$GIT_EDITOR" that can hold the path to the
32    command and initial options (e.g. "/path/to/emacs -nw"), 'git p4'
33    did not let the shell interpolate the contents of the environment
34    variable that name the editor "$P4EDITOR" (and "$EDITOR", too).
35    This release makes it in line with the rest of Git, as well as with
36    Perforce.
38  * A new short-hand <branch>@{push} denotes the remote-tracking branch
39    that tracks the branch at the remote the <branch> would be pushed
40    to.
42  * "git show-branch --topics HEAD" (with no other arguments) did not
43    do anything interesting.  Instead, contrast the given revision
44    against all the local branches by default.
46  * A replacement for contrib/workdir/git-new-workdir that does not
47    rely on symbolic links and make sharing of objects and refs safer
48    by making the borrowee and borrowers aware of each other.
50  * Tweak the sample "store" backend of the credential helper to honor
51    XDG configuration file locations when specified.
53  * A heuristic to help the "git <cmd> <revs> <pathspec>" command line
54    convention to catch mistyped paths is to make sure all the non-rev
55    parameters in the later part of the command line are names of the
56    files in the working tree, but that means "git grep $str -- \*.c"
57    must always be disambiguated with "--", because nobody sane will
58    create a file whose name literally is asterisk-dot-see.  Loosen the
59    heuristic to declare that with a wildcard string the user likely
60    meant to give us a pathspec.
62  * "git merge FETCH_HEAD" learned that the previous "git fetch" could
63    be to create an Octopus merge, i.e. recording multiple branches
64    that are not marked as "not-for-merge"; this allows us to lose an
65    old style invocation "git merge <msg> HEAD $commits..." in the
66    implementation of "git pull" script; the old style syntax can now
67    be deprecated.
69  * Help us to find broken test script that splits the body part of the
70    test by mistaken use of wrong kind of quotes.
71    (merge d93d5d5 jc/test-prereq-validate later to maint).
73  * Developer support to automatically detect broken &&-chain in the
74    test scripts is now turned on by default.
75    (merge 92b269f jk/test-chain-lint later to maint).
77  * Filter scripts were run with SIGPIPE disabled on the Git side,
78    expecting that they may not read what Git feeds them to filter.
79    We however treated a filter that does not read its input fully
80    before exiting as an error.
82    This changes semantics, but arguably in a good way.  If a filter
83    can produce its output without consuming its input using whatever
84    magic, we now let it do so, instead of diagnosing it as a
85    programming error.
87  * Instead of dying immediately upon failing to obtain a lock, the
88    locking (of refs etc) retries after a short while with backoff.
90  * Introduce http.<url>.SSLCipherList configuration variable to tweak
91    the list of cipher suite to be used with libcURL when talking with
92    https:// sites.
94  * "git subtree" script (in contrib/) used "echo -n" to produce
95    progress messages in a non-portable way.
97  * "git subtree" script (in contrib/) does not have --squash option
98    when pushing, but the documentation and help text pretended as if
99    it did.
101  * The Git subcommand completion (in contrib/) listed credential
102    helpers among candidates, which is not something the end user would
103    invoke interactively.
105  * The index file can be taught with "update-index --untracked-cache"
106    to optionally remember already seen untracked files, in order to
107    speed up "git status" in a working tree with tons of cruft.
109  * "git mergetool" learned to drive WinMerge as a backend.
111  * "git upload-pack" that serves "git fetch" can be told to serve
112    commits that are not at the tip of any ref, as long as they are
113    reachable from a ref, with uploadpack.allowReachableSHA1InWant
114    configuration variable.
116  * "git cat-file --batch(-check)" learned the "--follow-symlinks"
117    option that follows an in-tree symbolic link when asked about an
118    object via extended SHA-1 syntax, e.g. HEAD:RelNotes that points at
119    Documentation/RelNotes/2.5.0.txt.  With the new option, the command
120    behaves as if HEAD:Documentation/RelNotes/2.5.0.txt was given as
121    input instead.
124 Performance, Internal Implementation, Development Support etc.
126  * "unsigned char [20]" used throughout the code to represent object
127    names are being converted into a semi-opaque "struct object_id".
128    This effort is expected to interfere with other topics in flight,
129    but hopefully will give us one extra level of abstraction in the
130    end, when completed.
132  * Catch a programmer mistake to feed a pointer not an array to
133    ARRAY_SIZE() macro, by using a couple of GCC extensions.
134    (merge 89c855e ep/do-not-feed-a-pointer-to-array-size later to maint).
136  * Some error messages in "git config" were emitted without calling
137    the usual error() facility.
139  * When "add--interactive" splits a hunk into two overlapping hunks
140    and then let the user choose only one, it sometimes feeds an
141    incorrect patch text to "git apply".  Add tests to demonstrate
142    this.
144    I have a slight suspicion that this may be $gmane/87202 coming back
145    and biting us (I seem to have said "let's run with this and see
146    what happens" back then).
148  * More line-ending tests.
150  * An earlier rewrite to use strbuf_getwholeline() instead of fgets(3)
151    to read packed-refs file revealed that the former is unacceptably
152    inefficient.
154  * The refs API uses ref_lock struct which had its own "int fd", even
155    though the same file descriptor was in the lock struct it contains.
156    Clean-up the code to lose this redundant field.
158  * Add the "--allow-unknown-type" option to "cat-file" to allow
159    inspecting loose objects of an experimental or a broken type.
161  * Many long-running operations show progress eye-candy, even when
162    they are later backgrounded.  Hide the eye-candy when the process
163    is sent to the background instead.
164    (merge 9a9a41d lm/squelch-bg-progress later to maint).
166  * There was a dead code that used to handle "git pull --tags" and
167    show special-cased error message, which was made irrelevant when
168    the semantics of the option changed back in Git 1.9 days.
169    (merge 19d122b pt/pull-tags-error-diag later to maint).
171  * for_each_ref() callback functions were taught to name the objects
172    not with "unsigned char sha1[20]" but with "struct object_id".
174  * Error reporting mechanism used in "refs" API has been made more
175    consistent.
177  * "git pull" has more test coverage now.
180 Also contains various documentation updates and code clean-ups.
183 Fixes since v2.4
184 ----------------
186 Unless otherwise noted, all the fixes since v2.4 in the maintenance
187 track are contained in this release (see the maintenance releases'
188 notes for details).
190  * Git 2.4 broke setting verbosity and progress levels on "git clone"
191    with native transports.
192    (merge 822f0c4 mh/clone-verbosity-fix later to maint).
194  * "git add -e" did not allow the user to abort the operation by
195    killing the editor.
196    (merge cb64800 jk/add-e-kill-editor later to maint).
198  * Memory usage of "git index-pack" has been trimmed by tens of
199    per-cent.
200    (merge c6458e6 nd/slim-index-pack-memory-usage later to maint).
202  * "git rev-list --objects $old --not --all" to see if everything that
203    is reachable from $old is already connected to the existing refs
204    was very inefficient.
205    (merge b6e8a3b jk/still-interesting later to maint).
207  * "hash-object --literally" introduced in v2.2 was not prepared to
208    take a really long object type name.
209    (merge 1427a7f jc/hash-object later to maint).
211  * "git rebase --quiet" was not quite quiet when there is nothing to
212    do.
213    (merge 22946a9 jk/rebase-quiet-noop later to maint).
215  * The completion for "log --decorate=" parameter value was incorrect.
216    (merge af16bda sg/complete-decorate-full-not-long later to maint).
218  * "filter-branch" corrupted commit log message that ends with an
219    incomplete line on platforms with some "sed" implementations that
220    munge such a line.  Work it around by avoiding to use "sed".
221    (merge df06201 jk/filter-branch-use-of-sed-on-incomplete-line later to maint).
223  * "git daemon" fails to build from the source under NO_IPV6
224    configuration (regression in 2.4).
225    (merge d358f77 jc/daemon-no-ipv6-for-2.4.1 later to maint).
227  * Some time ago, "git blame" (incorrectly) lost the convert_to_git()
228    call when synthesizing a fake "tip" commit that represents the
229    state in the working tree, which broke folks who record the history
230    with LF line ending to make their project portable across platforms
231    while terminating lines in their working tree files with CRLF for
232    their platform.
233    (merge 4bf256d tb/blame-resurrect-convert-to-git later to maint).
235  * We avoid setting core.worktree when the repository location is the
236    ".git" directory directly at the top level of the working tree, but
237    the code misdetected the case in which the working tree is at the
238    root level of the filesystem (which arguably is a silly thing to
239    do, but still valid).
240    (merge 84ccad8 jk/init-core-worktree-at-root later to maint).
242  * "git commit --date=now" or anything that relies on approxidate lost
243    the daylight-saving-time offset.
244    (merge f6e6362 jc/epochtime-wo-tz later to maint).
246  * Access to objects in repositories that borrow from another one on a
247    slow NFS server unnecessarily got more expensive due to recent code
248    becoming more cautious in a naive way not to lose objects to pruning.
249    (merge ee1c6c3 jk/prune-mtime later to maint).
251  * The codepaths that read .gitignore and .gitattributes files have been
252    taught that these files encoded in UTF-8 may have UTF-8 BOM marker at
253    the beginning; this makes it in line with what we do for configuration
254    files already.
255    (merge 27547e5 cn/bom-in-gitignore later to maint).
257  * a few helper scripts in the test suite did not report errors
258    correctly.
259    (merge de248e9 ep/fix-test-lib-functions-report later to maint).
261  * The default $HOME/.gitconfig file created upon "git config --global"
262    that edits it had incorrectly spelled user.name and user.email
263    entries in it.
264    (merge 7e11052 oh/fix-config-default-user-name-section later to maint).
266  * "git cat-file bl $blob" failed to barf even though there is no
267    object type that is "bl".
268    (merge b7994af jk/type-from-string-gently later to maint).
270  * The usual "git diff" when seeing a file turning into a directory
271    showed a patchset to remove the file and create all files in the
272    directory, but "git diff --no-index" simply refused to work.  Also,
273    when asked to compare a file and a directory, imitate POSIX "diff"
274    and compare the file with the file with the same name in the
275    directory, instead of refusing to run.
276    (merge 0615173 jc/diff-no-index-d-f later to maint).
278  * "git rebase -i" moved the "current" command from "todo" to "done" a
279    bit too prematurely, losing a step when a "pick" did not even start.
280    (merge 8cbc57c ph/rebase-i-redo later to maint).
282  * The connection initiation code for "ssh" transport tried to absorb
283    differences between the stock "ssh" and Putty-supplied "plink" and
284    its derivatives, but the logic to tell that we are using "plink"
285    variants were too loose and falsely triggered when "plink" appeared
286    anywhere in the path (e.g. "/home/me/bin/uplink/ssh").
287    (merge baaf233 bc/connect-plink later to maint).
289  * "git stash pop/apply" forgot to make sure that not just the working
290    tree is clean but also the index is clean. The latter is important
291    as a stash application can conflict and the index will be used for
292    conflict resolution.
293    (merge ed178ef jk/stash-require-clean-index later to maint).
295  * We have prepended $GIT_EXEC_PATH and the path "git" is installed in
296    (typically "/usr/bin") to $PATH when invoking subprograms and hooks
297    for almost eternity, but the original use case the latter tried to
298    support was semi-bogus (i.e. install git to /opt/foo/git and run it
299    without having /opt/foo on $PATH), and more importantly it has
300    become less and less relevant as Git grew more mainstream (i.e. the
301    users would _want_ to have it on their $PATH).  Stop prepending the
302    path in which "git" is installed to users' $PATH, as that would
303    interfere the command search order people depend on (e.g. they may
304    not like versions of programs that are unrelated to Git in /usr/bin
305    and want to override them by having different ones in /usr/local/bin
306    and have the latter directory earlier in their $PATH).
307    (merge a0b4507 jk/git-no-more-argv0-path-munging later to maint).
309  * core.excludesfile (defaulting to $XDG_HOME/git/ignore) is supposed
310    to be overridden by repository-specific .git/info/exclude file, but
311    the order was swapped from the beginning. This belatedly fixes it.
312    (merge 099d2d8 jc/gitignore-precedence later to maint).
314  * After "git add -N", the path appeared in output of "git diff HEAD"
315    and "git diff --cached HEAD", leading "git status" to classify it
316    as "Changes to be committed".  Such a path, however, is not yet to
317    be scheduled to be committed.  "git diff" showed the change to the
318    path as modification, not as a "new file", in the header of its
319    output.
321    Treat such paths as "yet to be added to the index but Git already
322    know about them"; "git diff HEAD" and "git diff --cached HEAD"
323    should not talk about them, and "git diff" should show them as new
324    files yet to be added to the index.
325    (merge d95d728 nd/diff-i-t-a later to maint).
327  * There was a commented-out (instead of being marked to expect
328    failure) test that documented a breakage that was fixed since the
329    test was written; turn it into a proper test.
330    (merge 66d2e04 sb/t1020-cleanup later to maint).
332  * The "log --decorate" enhancement in Git 2.4 that shows the commit
333    at the tip of the current branch e.g. "HEAD -> master", did not
334    work with --decorate=full.
335    (merge 429ad20 mg/log-decorate-HEAD later to maint).
337  * The ref API did not handle cases where 'refs/heads/xyzzy/frotz' is
338    removed at the same time as 'refs/heads/xyzzy' is added (or vice
339    versa) very well.
340    (merge c628edf mh/ref-directory-file later to maint).
342  * Multi-ref transaction support we merged a few releases ago
343    unnecessarily kept many file descriptors open, risking to fail with
344    resource exhaustion.  This is for 2.4.x track.
345    (merge 185ce3a mh/write-refs-sooner-2.4 later to maint).
347  * "git bundle verify" did not diagnose extra parameters on the
348    command line.
349    (merge 7886cfa ps/bundle-verify-arg later to maint).
351  * Various documentation mark-up fixes to make the output more
352    consistent in general and also make AsciiDoctor (an alternative
353    formatter) happier.
354    (merge d0258b9 jk/asciidoc-markup-fix later to maint).
355    (merge ad3967a jk/stripspace-asciidoctor-fix later to maint).
356    (merge 975e382 ja/tutorial-asciidoctor-fix later to maint).
358  * The code to read pack-bitmap wanted to allocate a few hundred
359    pointers to a structure, but by mistake allocated and leaked memory
360    enough to hold that many actual structures.  Correct the allocation
361    size and also have it on stack, as it is small enough.
362    (merge 599dc76 rs/plug-leak-in-pack-bitmaps later to maint).
364  * The pull.ff configuration was supposed to override the merge.ff
365    configuration, but it didn't.
366    (merge db9bb28 pt/pull-ff-vs-merge-ff later to maint).
368  * "git pull --log" and "git pull --no-log" worked as expected, but
369    "git pull --log=20" did not.
370    (merge 5061a44 pt/pull-log-n later to maint).
372  * "git rerere forget" in a repository without rerere enabled gave a
373    cryptic error message; it should be a silent no-op instead.
374    (merge 0544574 jk/rerere-forget-check-enabled later to maint).
376  * "git rebase -i" fired post-rewrite hook when it shouldn't (namely,
377    when it was told to stop sequencing with 'exec' insn).
378    (merge 141ff8f mm/rebase-i-post-rewrite-exec later to maint).
380  * Clarify that "log --raw" and "log --format=raw" are unrelated
381    concepts.
382    (merge 92de921 mm/log-format-raw-doc later to maint).
384  * Make "git stash something --help" error out, so that users can
385    safely say "git stash drop --help".
386    (merge 5ba2831 jk/stash-options later to maint).
388  * The clean/smudge interface did not work well when filtering an
389    empty contents (failed and then passed the empty input through).
390    It can be argued that a filter that produces anything but empty for
391    an empty input is nonsense, but if the user wants to do strange
392    things, then why not?
393    (merge f6a1e1e jh/filter-empty-contents later to maint).
395  * Communication between the HTTP server and http_backend process can
396    lead to a dead-lock when relaying a large ref negotiation request.
397    Diagnose the situation better, and mitigate it by reading such a
398    request first into core (to a reasonable limit).
399    (merge 636614f jk/http-backend-deadlock later to maint).
401  * "git clean pathspec..." tried to lstat(2) and complain even for
402    paths outside the given pathspec.
403    (merge 838d6a9 dt/clean-pathspec-filter-then-lstat later to maint).
405  * Recent "git prune" traverses young unreachable objects to safekeep
406    old objects in the reachability chain from them, which sometimes
407    caused error messages that are unnecessarily alarming.
408    (merge ce4e7b2 jk/squelch-missing-link-warning-for-unreachable later to maint).
410  * The configuration reader/writer uses mmap(2) interface to access
411    the files; when we find a directory, it barfed with "Out of memory?".
412    (merge 9ca0aaf jk/diagnose-config-mmap-failure later to maint).
414  * "color.diff.plain" was a misnomer; give it 'color.diff.context' as
415    a more logical synonym.
416    (merge 8dbf3eb jk/color-diff-plain-is-context later to maint).
418  * Code cleanups and documentation updates.
419    (merge 0269f96 mm/usage-log-l-can-take-regex later to maint).
420    (merge 64f2589 nd/t1509-chroot-test later to maint).
421    (merge d201a1e sb/test-bitmap-free-at-end later to maint).
422    (merge 05bfc7d sb/line-log-plug-pairdiff-leak later to maint).
423    (merge 846e5df pt/xdg-config-path later to maint).
424    (merge 1154aa4 jc/plug-fmt-merge-msg-leak later to maint).
425    (merge 319b678 jk/sha1-file-reduce-useless-warnings later to maint).
426    (merge 9a35c14 fg/document-commit-message-stripping later to maint).
427    (merge bbf431c ps/doc-packfile-vs-pack-file later to maint).
428    (merge 309a9e3 jk/skip-http-tests-under-no-curl later to maint).
429    (merge ccd593c dl/branch-error-message later to maint).
430    (merge 22570b6 rs/janitorial later to maint).
431    (merge 5c2a581 mc/commit-doc-grammofix later to maint).
432    (merge ce41720 ah/usage-strings later to maint).
433    (merge e6a268c sb/glossary-submodule later to maint).
434    (merge ec48a76 sb/submodule-doc-intro later to maint).
435    (merge 14f8b9b jk/clone-dissociate later to maint).