Merge branch 'jk/tag-sort'
[git.git] / Documentation / RelNotes / 2.1.0.txt
1 Git v2.1 Release Notes
2 ======================
4 Backward compatibility notes
5 ----------------------------
7  * The default value we give to the environment variable LESS has been
8    changed from "FRSX" to "FRX", losing "S" (chop long lines instead
9    of wrapping).  Existing users who prefer not to see line-wrapped
10    output may want to set
12      $ git config core.pager "less -S"
14    to restore the traditional behaviour.  It is expected that people
15    find output from the most subcommands easier to read with the new
16    default, except for "blame" which tends to produce really long
17    lines.  To override the new default only for "git blame", you can
18    do this:
20      $ git config pager.blame "less -S"
22  * A few disused directories in contrib/ have been retired.
25 Updates since v2.0
26 ------------------
28 UI, Workflows & Features
30  * Since the very beginning of Git, we gave the LESS environment a
31    default value "FRSX" when we spawn "less" as the pager.  "S" (chop
32    long lines instead of wrapping) has been removed from this default
33    set of options, because it is more or less a personal taste thing,
34    as opposed to others that have good justifications (i.e. "R" is
35    very much justified because many kinds of output we produce are
36    colored and "FX" is justified because output we produce is often
37    shorter than a page).
39  * The logic and data used to compute the display width needed for
40    UTF-8 strings have been updated to match Unicode 7.0 better.
42  * HTTP-based transports learned to propagate the error messages from
43    the webserver better to the client coming over the HTTP transport.
45  * The completion script for bash (in contrib/) has been updated to
46    handle aliases that define complex sequence of commands better.
48  * The "core.preloadindex" configuration variable is by default
49    enabled, allowing modern platforms to take advantage of the
50    multiple cores they have.
52  * "git commit --date=<date>" option learned to read from more
53    timestamp formats, including "--date=now".
55  * The `core.commentChar` configuration variable is used to specify a
56    custom comment character other than the default "#" to be used in
57    the commit log editor.  This can be set to `auto` to attempt to
58    choose a different character that does not conflict with what
59    already starts a line in the message being edited for cases like
60    "git commit --amend".
62  * "git format-patch" learned --signature-file=<file> to take the mail
63    signature from.
65  * "git grep" learned grep.fullname configuration variable to force
66    "--full-name" to be default.  This may cause regressions on
67    scripted users that do not expect this new behaviour.
69  * "git imap-send" learned to ask the credential helper for auth
70    material.
72  * "git log" and friends now understand the value "auto" set to the
73    "log.decorate" configuration variable to enable the "--decorate"
74    option automatically when the output is sent to tty.
76  * "git merge" without argument, even when there is an upstream
77    defined for the current branch, refused to run until
78    merge.defaultToUpstream is set to true.  Flip the default of that
79    configuration variable to true.
81  * "git mergetool" learned to drive the vimdiff3 backend.
83  * mergetool.prompt used to default to 'true', always asking "do you
84    really want to run the tool on this path?".  Among the two
85    purposes this prompt serves, ignore the use case to confirm that
86    the user wants to view particular path with the named tool, and
87    redefine the meaning of the prompt only to confirm the choice of
88    the tool made by the autodetection (for those who configured the
89    tool explicitly, the prompt shown for the latter purpose is
90    simply annoying).
92    Strictly speaking, this is a backward incompatible change and the
93    users need to explicitly set the variable to 'true' if they want
94    to resurrect the now-ignored use case.
96  * "git replace" learned the "--edit" subcommand to create a
97    replacement by editing an existing object.
99  * "git send-email" learned "--to-cover" and "--cc-cover" options, to
100    tell it to copy To: and Cc: headers found in the first input file
101    when emitting later input files.
103  * "git svn" learned to cope with malformed timestamps with only one
104    digit in the hour part, e.g. 2014-01-07T5:01:02.048176Z, emitted
105    by some broken subversion server implementations.
107  * "git tag" when editing the tag message shows the name of the tag
108    being edited as a comment in the editor.
110  * "git verify-commit" command to check GPG signature in signed
111    commits, in a way similar to "git verify-tag" is used to check
112    signed tags, was added.
115 Performance, Internal Implementation, etc.
117  * Build procedure for 'subtree' (in contrib/) has been cleaned up.
119  * The support for the profile-feedback build, which has been left
120    bit-rotten for quite a while, has been updated.
122  * An experimental format to use two files (the base file and
123    incremental changes relative to it) to represent the index has been
124    introduced; this may reduce I/O cost of rewriting a large index
125    when only small part of the working tree changes.
127  * Effort to shrink the size of patches Windows folks maintain on top
128    by upstreaming them continues.
130  * Patches maintained by msysgit folks for Windows port are being
131    upstreamed here a bit by bit.
133  * The leaf function to check validity of a refname format has been
134    micro-optimized, using SSE2 instructions when available.  A few
135    breakages during its development have been caught and fixed already
136    but there might remain some more still; please test and report if
137    you find any.
139  * The `core.deltabasecachelimit` used to default to 16 MiB , but this
140    proved to be too small, and has been bumped to 96 MiB.
142  * "git blame" has been optimized greatly by reorganising the data
143    structure that is used to keep track of the work to be done.
145  * "git diff" that compares 3-or-more trees (e.g. parents and the
146    result of a merge) have been optimized.
148  * The API to update/delete references are being converted to handle
149    updates to multiple references in a transactional way.  As an
150    example, "update-ref --stdin [-z]" has been updated to use this
151    API.
153  * skip_prefix() and strip_suffix() API functions are used a lot more
154    widely throughout the codebase now.
156  * Parts of the test scripts can be skipped by using a range notation,
157    e.g. "sh --run='1-4 6 8-'" to omit test piece 5 and 7
158    and run everything else.
161 Also contains various documentation updates and code clean-ups.
164 Fixes since v2.0
165 ----------------
167 Unless otherwise noted, all the fixes since v2.0 in the maintenance
168 track are contained in this release (see the maintenance releases'
169 notes for details).
171  * We used to unconditionally disable the pager in the pager process
172    we spawn to feed out output, but that prevented people who want to
173    run "less" within "less" from doing so.
174    (merge c0459ca je/pager-do-not-recurse later to maint).
176  * Tools that read diagnostic output in our standard error stream do
177    not want to see terminal control sequence (e.g. erase-to-eol).
178    Detect them by checking if the standard error stream is connected
179    to a tty.
180    (merge 38de156 mn/sideband-no-ansi later to maint).
182  * Mishandling of patterns in .gitignore that has trailing SPs quoted
183    with backslashes (e.g. ones that end with "\ ") have been
184    corrected.
185    (merge 97c1364be6b pb/trim-trailing-spaces later to maint).
187  * Reworded the error message given upon a failure to open an existing
188    loose object file due to e.g. permission issues; it was reported as
189    the object being corrupt, but that is not quite true.
190    (merge d6c8a05 jk/report-fail-to-read-objects-better later to maint).
192  * "git log -2master" is a common typo that shows two commits starting
193    from whichever random branch that is not 'master' that happens to
194    be checked out currently.
195    (merge e3fa568 jc/revision-dash-count-parsing later to maint).
197  * Code to avoid adding the same alternate object store twice was
198    subtly broken for a long time, but nobody seems to have noticed.
199    (merge 80b4785 rs/fix-alt-odb-path-comparison later to maint).
200    (merge 539e750 ek/alt-odb-entry-fix later to maint).
202  * The "%<(10,trunc)%s" pretty format specifier in the log family of
203    commands is used to truncate the string to a given length (e.g. 10
204    in the example) with padding to column-align the output, but did
205    not take into account that number of bytes and number of display
206    columns are different.
207    (merge 7d50987 as/pretty-truncate later to maint).
209  * "%G" (nothing after G) is an invalid pretty format specifier, but
210    the parser did not notice it as garbage.
211    (merge 958b2eb jk/pretty-G-format-fixes later to maint).
213  * A handful of code paths had to read the commit object more than
214    once when showing header fields that are usually not parsed.  The
215    internal data structure to keep track of the contents of the commit
216    object has been updated to reduce the need for this double-reading,
217    and to allow the caller find the length of the object.
218    (merge 218aa3a jk/commit-buffer-length later to maint).
220  * The "mailmap.file" configuration option did not support the tilde
221    expansion (i.e. ~user/path and ~/path).
222    (merge 9352fd5 ow/config-mailmap-pathname later to maint).
224  * The completion scripts (in contrib/) did not know about quite a few
225    options that are common between "git merge" and "git pull", and a
226    couple of options unique to "git merge".
227    (merge 8fee872 jk/complete-merge-pull later to maint).
229  * An ancient rewrite passed a wrong pointer to a curl library
230    function in a rarely used code path.
231    (merge 479eaa8 ah/fix-http-push later to maint).
233  * "--ignore-space-change" option of "git apply" ignored the spaces
234    at the beginning of line too aggressively, which is inconsistent
235    with the option of the same name "diff" and "git diff" have.
236    (merge 14d3bb4 jc/apply-ignore-whitespace later to maint).
238  * "git blame" miscounted number of columns needed to show localized
239    timestamps, resulting in jaggy left-side-edge of the source code
240    lines in its output.
241    (merge dd75553 jx/blame-align-relative-time later to maint).
243  * "git blame" assigned the blame to the copy in the working-tree if
244    the repository is set to core.autocrlf=input and the file used CRLF
245    line endings.
246    (merge 4d4813a bc/blame-crlf-test later to maint).
248  * "git clone -b brefs/tags/bar" would have mistakenly thought we were
249    following a single tag, even though it was a name of the branch,
250    because it incorrectly used strstr().
251    (merge 60a5f5f jc/fix-clone-single-starting-at-a-tag later to maint).
253  * "git commit --allow-empty-messag -C $commit" did not work when the
254    commit did not have any log message.
255    (merge 076cbd6 jk/commit-C-pick-empty later to maint).
257  * "git diff --find-copies-harder" sometimes pretended as if the mode
258    bits have changed for paths that are marked with assume-unchanged
259    bit.
260    (merge 5304810 jk/diff-files-assume-unchanged later to maint).
262  * "filter-branch" left an empty single-parent commit that results when
263    all parents of a merge commit gets mapped to the same commit, even
264    under "--prune-empty".
265    (merge 79bc4ef cb/filter-branch-prune-empty-degenerate-merges later to maint).
267  * "git format-patch" did not enforce the rule that the "--follow"
268    option from the log/diff family of commands must be used with
269    exactly one pathspec.
270    (merge dd63f16 jk/diff-follow-must-take-one-pathspec later to maint).
272  * "git gc --auto" was recently changed to run in the background to
273    give control back early to the end-user sitting in front of the
274    terminal, but it forgot that housekeeping involving reflogs should
275    be done without other processes competing for accesses to the refs.
276    (merge 62aad18 nd/daemonize-gc later to maint).
278  * "git grep -O" to show the lines that hit in the pager did not work
279    well with case insensitive search.  We now spawn "less" with its
280    "-I" option when it is used as the pager (which is the default).
281    (merge f7febbe sk/spawn-less-case-insensitively-from-grep-O-i later to maint).
283  * We used to disable threaded "git index-pack" on platforms without
284    thread-safe pread(); use a different workaround for such
285    platforms to allow threaded "git index-pack".
286    (merge 3953949 nd/index-pack-one-fd-per-thread later to maint).
288  * The error reporting from "git index-pack" has been improved to
289    distinguish missing objects from type errors.
290    (merge 77583e7 jk/index-pack-report-missing later to maint).
292  * "log --show-signature" incorrectly decided the color to paint a
293    mergetag that was and was not correctly validated.
294    (merge 42c55ce mg/fix-log-mergetag-color later to maint).
296  * "log --show-signature" did not pay attention to "--graph" option.
297    (merge cf3983d zk/log-graph-showsig later to maint).
299  * "git mailinfo" used to read beyond the end of header string while
300    parsing an incoming e-mail message to extract the patch.
301    (merge b1a013d rs/mailinfo-header-cmp later to maint).
303  * On a case insensitive filesystem, merge-recursive incorrectly
304    deleted the file that is to be renamed to a name that is the same
305    except for case differences.
306    (merge baa37bf dt/merge-recursive-case-insensitive later to maint).
308  * Merging changes into a file that ends in an incomplete line made the
309    last line into a complete one, even when the other branch did not
310    change anything around the end of file.
311    (merge ba31180 mk/merge-incomplete-files later to maint).
313  * "git pack-objects" unnecessarily copied the previous contents when
314    extending the hashtable, even though it will populate the table
315    from scratch anyway.
316    (merge fb79947 rs/pack-objects-no-unnecessary-realloc later to maint).
318  * Recent updates to "git repack" started to duplicate objects that
319    are in packfiles marked with .keep flag into the new packfile by
320    mistake.
321    (merge d078d85 jk/repack-pack-keep-objects later to maint).
323  * "git rerere forget" did not work well when merge.conflictstyle
324    was set to a non-default value.
325    (merge de3d8bb fc/rerere-conflict-style later to maint).
327  * "git remote rm" and "git remote prune" can involve removing many
328    refs at once, which is not a very efficient thing to do when very
329    many refs exist in the packed-refs file.
330    (merge e6bea66 jl/remote-rm-prune later to maint).
332  * "git log --exclude=<glob> --all | git shortlog" worked as expected,
333    but "git shortlog --exclude=<glob> --all", which is supposed to be
334    identical to the above pipeline, was not accepted at the command
335    line argument parser level.
336    (merge eb07774 jc/shortlog-ref-exclude later to maint).
338  * The autostash mode of "git rebase -i" did not restore the dirty
339    working tree state if the user aborted the interactive rebase by
340    emptying the insn sheet.
341    (merge ddb5432 rr/rebase-autostash-fix later to maint).
343  * During "git rebase --merge", a conflicted patch could not be
344    skipped with "--skip" if the next one also conflicted.
345    (merge 95104c7 bc/fix-rebase-merge-skip later to maint).
347  * "git show -s" (i.e. show log message only) used to incorrectly emit
348    an extra blank line after a merge commit.
349    (merge ad2f725 mk/show-s-no-extra-blank-line-for-merges later to maint).
351  * "git status", even though it is a read-only operation, tries to
352    update the index with refreshed lstat(2) info to optimize future
353    accesses to the working tree opportunistically, but this could
354    race with a "read-write" operation that modify the index while it
355    is running.  Detect such a race and avoid overwriting the index.
356    (merge 426ddee ym/fix-opportunistic-index-update-race later to maint).
358  * "git status" (and "git commit") behaved as if changes in a modified
359    submodule are not there if submodule.*.ignore configuration is set,
360    which was misleading.  The configuration is only to unclutter diff
361    output during the course of development, and should not to hide
362    changes in the "status" output to cause the users forget to commit
363    them.
364    (merge c215d3d jl/status-added-submodule-is-never-ignored later to maint).
366  * Documentation for "git submodule sync" forgot to say that the subcommand
367    can take the "--recursive" option.
368    (merge 9393ae7 mc/doc-submodule-sync-recurse later to maint).
370  * "git update-index --cacheinfo" in 2.0 release crashed on a
371    malformed command line.
372    (merge c8e1ee4 jc/rev-parse-argh-dashed-multi-words later to maint).
374  * The mode to run tests with HTTP server tests disabled was broken.
375    (merge afa53fe na/no-http-test-in-the-middle later to maint).