many small typofixes
[alt-git.git] / Documentation / RelNotes / 1.8.4.txt
blobad58ac6dbd75d68c7ff800a5af79407c61c918eb
1 Git v1.8.4 Release Notes
2 ========================
4 Backward compatibility notes (for Git 2.0)
5 ------------------------------------------
7 When "git push [$there]" does not say what to push, we have used the
8 traditional "matching" semantics so far (all your branches were sent
9 to the remote as long as there already are branches of the same name
10 over there).  In Git 2.0, the default will change to the "simple"
11 semantics that pushes:
13  - only the current branch to the branch with the same name, and only
14    when the current branch is set to integrate with that remote
15    branch, if you are pushing to the same remote as you fetch from; or
17  - only the current branch to the branch with the same name, if you
18    are pushing to a remote that is not where you usually fetch from.
20 Use the user preference configuration variable "push.default" to
21 change this.  If you are an old-timer who is used to the "matching"
22 semantics, you can set the variable to "matching" to keep the
23 traditional behaviour.  If you want to live in the future early, you
24 can set it to "simple" today without waiting for Git 2.0.
26 When "git add -u" (and "git add -A") is run inside a subdirectory and
27 does not specify which paths to add on the command line, it
28 will operate on the entire tree in Git 2.0 for consistency
29 with "git commit -a" and other commands.  There will be no
30 mechanism to make plain "git add -u" behave like "git add -u .".
31 Current users of "git add -u" (without a pathspec) should start
32 training their fingers to explicitly say "git add -u ."
33 before Git 2.0 comes.  A warning is issued when these commands are
34 run without a pathspec and when you have local changes outside the
35 current directory, because the behaviour in Git 2.0 will be different
36 from today's version in such a situation.
38 In Git 2.0, "git add <path>" will behave as "git add -A <path>", so
39 that "git add dir/" will notice paths you removed from the directory
40 and record the removal.  Versions before Git 2.0, including this
41 release, will keep ignoring removals, but the users who rely on this
42 behaviour are encouraged to start using "git add --ignore-removal <path>"
43 now before 2.0 is released.
46 Updates since v1.8.3
47 --------------------
49 Foreign interfaces, subsystems and ports.
51  * "git rebase -i" now honors --strategy and -X options.
53  * Git-gui has been updated to its 0.18.0 version.
55  * MediaWiki remote helper (in contrib/) has been updated to use the
56    credential helper interface from Git.pm.
58  * Update build for Cygwin 1.[57].  Torsten Bögershausen reports that
59    this is fine with Cygwin 1.7 ($gmane/225824) so let's try moving it
60    ahead.
62  * The credential helper to talk to keychain on OS X (in contrib/) has
63    been updated to kick in not just when talking http/https but also
64    imap(s) and smtp.
66  * Remote transport helper has been updated to report errors and
67    maintain ref hierarchy used to keep track of its own state better.
69  * With "export" remote-helper protocol, (1) a push that tries to
70    update a remote ref whose name is different from the pushing side
71    does not work yet, and (2) the helper may not know how to do
72    --dry-run; these problematic cases are disabled for now.
74  * git-remote-hg/bzr (in contrib/) updates.
76  * git-remote-mw (in contrib/) hints users to check the certificate,
77    when https:// connection failed.
79  * git-remote-mw (in contrib/) adds a command to allow previewing the
80    contents locally before pushing it out, when working with a
81    MediaWiki remote.
84 UI, Workflows & Features
86  * "git clean" command learned an interactive mode.
88  * The "--head" option to "git show-ref" was only to add "HEAD" to the
89    list of candidate refs to be filtered by the usual rules
90    (e.g. "--heads" that only show refs under refs/heads).  The meaning
91    of the option has been changed to always show "HEAD" regardless of
92    what filtering will be applied to any other ref.
94    This is a backward incompatible change and might cause breakages to
95    people's existing scripts.
97  * "git show -s" was less discoverable than it should have been.  It
98    now has a natural synonym "git show --no-patch".
100  * "git check-mailmap" is a new command that lets you map usernames
101    and e-mail addresses through the mailmap mechanism, just like many
102    built-in commands do.
104  * "git name-rev" learned to name an annotated tag object back to its
105    tagname; "git name-rev $(git rev-parse v1.0.0)" gives "tags/v1.0.0",
106    for example.
108  * "git cat-file --batch-check=<format>" is added, primarily to allow
109    on-disk footprint of objects in packfiles (often they are a lot
110    smaller than their true size, when expressed as deltas) to be
111    reported.
113  * "git rebase [-i]" used to leave just "rebase" as its reflog messages
114    for some operations. They have been reworded to be more informative.
116  * In addition to the choice from "rebase, merge, or checkout-detach",
117    "submodule update" can allow a custom command to be used in to
118    update the working tree of submodules via the "submodule.*.update"
119    configuration variable.
121  * "git submodule update" can optionally clone the submodule
122    repositories shallowly.
124  * "git format-patch" learned "--from[=whom]" option, which sets the
125    "From: " header to the specified person (or the person who runs the
126    command, if "=whom" part is missing) and move the original author
127    information to an in-body From: header as necessary.
129  * The configuration variable "merge.ff" was cleary a tri-state to
130    choose one from "favor fast-forward when possible", "always create
131    a merge even when the history could fast-forward" and "do not
132    create any merge, only update when the history fast-forwards", but
133    the command line parser did not implement the usual convention of
134    "last one wins, and command line overrides the configuration"
135    correctly.
137  * "gitweb" learned to optionally place extra links that point at the
138    levels higher than the Gitweb pages themselves in the breadcrumbs,
139    so that it can be used as part of a larger installation.
141  * "git log --format=" now honors i18n.logoutputencoding configuration
142    variable.
144  * The "push.default=simple" mode of "git push" has been updated to
145    behave like "current" without requiring a remote tracking
146    information, when you push to a remote that is different from where
147    you fetch from (i.e. a triangular workflow).
149  * Having multiple "fixup!" on a line in the rebase instruction sheet
150    did not work very well with "git rebase -i --autosquash".
152  * "git log" learned the "--author-date-order" option, with which the
153    output is topologically sorted and commits in parallel histories
154    are shown intermixed together based on the author timestamp.
156  * Various subcommands of "git submodule" refused to run from anywhere
157    other than the top of the working tree of the superproject, but
158    they have been taught to let you run from a subdirectory.
160  * "git diff" learned a mode that ignores hunks whose change consists
161    only of additions and removals of blank lines, which is the same as
162    "diff -B" (ignore blank lines) of GNU diff.
164  * "git rm" gives a single message followed by list of paths to report
165    multiple paths that cannot be removed.
167  * "git rebase" can be told with ":/look for this string" syntax commits
168    to replay the changes onto and where the work to be replayed begins.
170  * Many tutorials teach users to set "color.ui" to "auto" as the first
171    thing after you set "user.name/email" to introduce yourselves to
172    Git.  Now the variable defaults to "auto".
174  * On Cygwin, "cygstart" is now recognised as a possible way to start
175    a web browser (used in "help -w" and "instaweb" among others).
177  * "git status" learned status.branch and status.short configuration
178    variables to use --branch and --short options by default (override
179    with --no-branch and --no-short options from the command line).
181  * "git cmd <name>", when <name> happens to be a 40-hex string,
182    directly uses the 40-hex string as an object name, even if a ref
183    "refs/<some hierarchy>/<name>" exists.  This disambiguation order
184    is unlikely to change, but we should warn about the ambiguity just
185    like we warn when more than one refs/ hierachies share the same
186    name.
188  * "git rebase" learned "--[no-]autostash" option to save local
189    changes instead of refusing to run (to which people's normal
190    response was to stash them and re-run).  This introduced a corner
191    case breakage to "git am --abort" but it has been fixed.
193  * Instead of typing four capital letters "HEAD", you can say "@" now,
194    e.g. "git log @".
196  * "check-ignore" (new feature since 1.8.2) has been updated to work
197    more like "check-attr" over bidi-pipes.
199  * "git describe" learned "--first-parent" option to limit its closest
200    tagged commit search to the first-parent chain.
202  * "git merge foo" that might have meant "git merge origin/foo" is
203    diagnosed with a more informative error message.
205  * "git log -L<line>,<range>:<filename>" has been added.  This may
206    still have leaks and rough edges, though.
208  * We used the approxidate() parser for "--expire=<timestamp>" options
209    of various commands, but it is better to treat --expire=all and
210    --expire=now a bit more specially than using the current timestamp.
211    "git gc" and "git reflog" have been updated with a new parsing
212    function for expiry dates.
214  * Updates to completion (both bash and zsh) helpers.
216  * The behaviour of the "--chain-reply-to" option of "git send-email"
217    have changed at 1.7.0, and we added a warning/advice message to
218    help users adjust to the new behaviour back then, but we kept it
219    around for too long.  The message has finally been removed.
221  * "git fetch origin master" unlike "git fetch origin" or "git fetch"
222    did not update "refs/remotes/origin/master"; this was an early
223    design decision to keep the update of remote tracking branches
224    predictable, but in practice it turns out that people find it more
225    convenient to opportunistically update them whenever we have a
226    chance, and we have been updating them when we run "git push" which
227    already breaks the original "predictability" anyway.
229  * The configuration variable core.checkstat was advertised in the
230    documentation but the code expected core.statinfo instead.
231    For now, we accept both core.checkstat and core.statinfo, but the
232    latter will be removed in the longer term.
235 Performance, Internal Implementation, etc.
237  * The function attributes extensions are used to catch mistakes in
238    use of our own variadic functions that use NULL sentinel at the end
239    (i.e. like execl(3)) and format strings (i.e. like printf(3)).
241  * The code to allow configuration data to be read from in-tree blob
242    objects is in.  This may help working in a bare repository and
243    submodule updates.
245  * Fetching between repositories with many refs employed O(n^2)
246    algorithm to match up the common objects, which has been corrected.
248  * The original way to specify remote repository using .git/branches/
249    used to have a nifty feature.  The code to support the feature was
250    still in a function but the caller was changed not to call it 5
251    years ago, breaking that feature and leaving the supporting code
252    unreachable.  The dead code has been removed.
254  * "git pack-refs" that races with new ref creation or deletion have
255    been susceptible to lossage of refs under right conditions, which
256    has been tightened up.
258  * We read loose and packed rerferences in two steps, but after
259    deciding to read a loose ref but before actually opening it to read
260    it, another process racing with us can unlink it, which would cause
261    us to barf.  The codepath has been updated to retry when such a
262    race is detected, instead of outright failing.
264  * Uses of the platform fnmatch(3) function (many places in the code,
265    matching pathspec, .gitignore and .gitattributes to name a few)
266    have been replaced with wildmatch, allowing "foo/**/bar" that would
267    match foo/bar, foo/a/bar, foo/a/b/bar, etc.
269  * Memory ownership and lifetime rules for what for-each-ref feeds to
270    its callbacks have been clarified (in short, "you do not own it, so
271    make a copy if you want to keep it").
273  * The revision traversal logic to improve culling of irrelevant
274    parents while traversing a mergy history has been updated.
276  * Some leaks in unpack-trees (used in merge, cherry-pick and other
277    codepaths) have been plugged.
279  * The codepath to read from marks files in fast-import/export did not
280    have to accept anything but 40-hex representation of the object
281    name.  Further, fast-export did not need full in-core object
282    representation to have parsed wen reading from them.  These
283    codepaths have been optimized by taking advantage of these access
284    patterns.
286  * Object lookup logic, when the object hashtable starts to become
287    crowded, has been optimized.
289  * When TEST_OUTPUT_DIRECTORY setting is used, it was handled somewhat
290    inconsistently between the test framework and t/Makefile, and logic
291    to summarize the results looked at a wrong place.
293  * "git clone" uses a lighter-weight implementation when making sure
294    that the history behind refs are complete.
296  * Many warnings from sparse source checker in compat/ area has been
297    squelched.
299  * The code to reading and updating packed-refs file has been updated,
300    correcting corner case bugs.
303 Also contains various documentation updates and code clean-ups.
306 Fixes since v1.8.3
307 ------------------
309 Unless otherwise noted, all the fixes since v1.8.3 in the maintenance
310 track are contained in this release (see release notes to them for
311 details).
313  * Newer Net::SMTP::SSL module does not want the user programs to use
314    the default behaviour to let server certificate go without
315    verification, so by default enable the verification with a
316    mechanism to turn it off if needed.
317    (merge 35035bb rr/send-email-ssl-verify later to maint).
319  * When "git" is spawned in such a way that any of the low 3 file
320    descriptors is closed, our first open() may yield file descriptor 2,
321    and writing error message to it would screw things up in a big way.
322    (merge a11c396 tr/protect-low-3-fds later to maint).
324  * The mailmap mechanism unnecessarily downcased the e-mail addresses
325    in the output, and also ignored the human name when it is a single
326    character name.
327    (merge bd23794 jc/mailmap-case-insensitivity later to maint).
329  * In two places we did not check return value (expected to be a file
330    descriptor) correctly.
331    (merge a77f106 tr/fd-gotcha-fixes later to maint).
333  * Logic to auto-detect character encodings in the commit log message
334    did not reject overlong and invalid UTF-8 characters.
335    (merge 81050ac bc/commit-invalid-utf8 later to maint).
337  * Pass port number as a separate argument when "send-email" initializes
338    Net::SMTP, instead of as a part of the hostname, i.e. host:port.
339    This allows GSSAPI codepath to match with the hostname given.
340    (merge 1a741bf bc/send-email-use-port-as-separate-param later to maint).
342  * "git diff" refused to even show difference when core.safecrlf is
343    set to true (i.e. error out) and there are offending lines in the
344    working tree files.
345    (merge 5430bb2 jc/maint-diff-core-safecrlf later to maint).
347  * A test that should have failed but didn't revealed a bug that needs
348    to be corrected.
349    (merge 94d75d1 jc/t1512-fix later to maint).
351  * An overlong path to a .git directory may have overflown the
352    temporary path buffer used to create a name for lockfiles.
353    (merge 2fbd4f9 mh/maint-lockfile-overflow later to maint).
355  * Invocations of "git checkout" used internally by "git rebase" were
356    counted as "checkout", and affected later "git checkout -" to the
357    the user to an unexpected place.
358    (merge 3bed291 rr/rebase-checkout-reflog later to maint).
360  * "git stash save", when your local change turns a tracked file into
361    a directory, has to remove files in that directory in order to
362    revert your working tree to a pristine state.  This will lose
363    untracked files in such a directory, and the command now requires
364    you to "--force" it.
366  * The configuration variable column.ui was poorly documented.
367    (merge 5e62cc1 rr/column-doc later to maint).
369  * "git name-rev --refs=tags/v*" were forbidden, which was a bit
370    inconvenient (you had to give a pattern to match refs fully, like
371    --refs=refs/tags/v*).
372    (merge 98c5c4a nk/name-rev-abbreviated-refs later to maint).
374  * "git apply" parsed patches that add new files, generated by
375    programs other than Git, incorrectly.  This is an old breakage in
376    v1.7.11 and will need to be merged down to the maintanance tracks.
378  * Older cURL wanted piece of memory we call it with to be stable, but
379    we updated the auth material after handing it to a call.
381  * "git pull" into nothing trashed "local changes" that were in the
382    index, and this avoids it.
384  * Many "git submodule" operations do not work on a submodule at a
385    path whose name is not in ASCII.
387  * "cherry-pick" had a small leak in an error codepath.
389  * Logic used by git-send-email to suppress cc mishandled names like
390    "A U. Thor" <author@example.xz>, where the human readable part
391    needs to be quoted (the user input may not have the double quotes
392    around the name, and comparison was done between quoted and
393    unquoted strings).  It also mishandled names that need RFC2047
394    quoting.
396  * Call to discard_cache/discard_index (used when we use different
397    contents of the index in-core, in many operations like commit,
398    apply, and merge) used to leak memory that held the array of index
399    entries, which has been plugged.
400    (merge a0fc4db rs/discard-index-discard-array later to maint).
402  * "gitweb" forgot to clear a global variable $search_regexp upon each
403    request, mistakenly carrying over the previous search to a new one
404    when used as a persistent CGI.
406  * The wildmatch engine did not honor WM_CASEFOLD option correctly.
408  * "git log -c --follow $path" segfaulted upon hitting the commit that
409    renamed the $path being followed.
411  * When a reflog notation is used for implicit "current branch", we
412    did not say which branch and worse said "branch ''".
414  * "difftool --dir-diff" did not copy back changes made by the
415    end-user in the diff tool backend to the working tree in some
416    cases.
418  * "git push $there HEAD:branch" did not resolve HEAD early enough, so
419    it was easy to flip it around while push is still going on and push
420    out a branch that the user did not originally intended when the
421    command was started.
423  * The bash prompt code (in contrib/) displayed the name of the branch
424    being rebased when "rebase -i/-m/-p" modes are in use, but not the
425    plain vanilla "rebase".
427  * Handling of negative exclude pattern for directories "!dir" was
428    broken in the update to v1.8.3.
430  * zsh prompt script that borrowed from bash prompt script did not
431    work due to slight differences in array variable notation between
432    these two shells.
434  * An entry for "file://" scheme in the enumeration of URL types Git
435    can take in the HTML documentation was made into a clickable link
436    by mistake.
438  * "git push --[no-]verify" was not documented.
440  * Stop installing the git-remote-testpy script that is only used for
441    testing.
443  * "git commit --allow-empty-message -m ''" should not start an
444    editor.
446  * "git merge @{-1}~22" was rewritten to "git merge frotz@{1}~22"
447    incorrectly when your previous branch was "frotz" (it should be
448    rewritten to "git merge frotz~22" instead).
450  * "git diff -c -p" was not showing a deleted line from a hunk when
451    another hunk immediately begins where the earlier one ends.
453  * "git log --ancestry-path A...B" did not work as expected, as it did
454    not pay attention to the fact that the merge base between A and B
455    was the bottom of the range being specified.
457  * Mac OS X does not like to write(2) more than INT_MAX number of
458    bytes; work it around by chopping write(2) into smaller pieces.
460  * Newer MacOS X encourages the programs to compile and link with
461    their CommonCrypto, not with OpenSSL.
463  * "git clone foo/bar:baz" cannot be a request to clone from a remote
464    over git-over-ssh specified in the scp style.  This case is now
465    detected and clones from a local repository at "foo/bar:baz".
467  * When $HOME is misconfigured to point at an unreadable directory, we
468    used to complain and die. Loosen the check.
470  * "git subtree" (in contrib/) had one codepath with loose error
471    checks to lose data at the remote side.
473  * "git fetch" into a shallow repository from a repository that does
474    not know about the shallow boundary commits (e.g. a different fork
475    from the repository the current shallow repository was cloned from)
476    did not work correctly.
478  * "git checkout foo" DWIMs the intended "upstream" and turns it into
479    "git checkout -t -b foo remotes/origin/foo". This codepath has been
480    updated to correctly take existing remote definitions into account.