Fifth batch for post 2.8 cycle
[git.git] / Documentation / RelNotes / 2.9.0.txt
blob46bee4abac10a9209591e8fb042019009a6542ce
1 Git 2.9 Release Notes
2 =====================
4 Backward compatibility note
5 ---------------------------
7 The end-user facing Porcelain level commands in the "git diff" and
8 "git log" by default enables the rename detection; you can still use
9 "diff.renames" configuration variable to disable this.
11 Merging two branches that have no common ancestor with "git merge" is
12 by default forbidden now to prevent creating such an unusual merge by
13 mistake.
15 The output formats of "git log" that indents the commit log message by
16 4 spaces now expands HT in the log message by default.  You can use
17 the "--no-expand-tabs" option to disable this.
20 Updates since v2.8
21 ------------------
23 UI, Workflows & Features
25  * The end-user facing Porcelain level commands like "diff" and "log"
26    now enables the rename detection by default.
28  * The credential.helper configuration variable is cumulative and
29    there is no good way to override it from the command line.  As
30    a special case, giving an empty string as its value now serves
31    as the signal to clear the values specified in various files.
33  * A new "interactive.diffFilter" configuration can be used to
34    customize the diff shown in "git add -i" session.
36  * "git p4" now allows P4 author names to be mapped to Git author
37    names.
39  * "git rebase -x" can be used without passing "-i" option.
41  * "git -c credential.<var>=<value> submodule" can now be used to
42    propagate configuration variables related to credential helper
43    down to the submodules.
45  * "git tag" can create an annotated tag without explicitly given an
46    "-a" (or "-s") option (i.e. when a tag message is given).  A new
47    configuration variable, tag.forceSignAnnotated, can be used to tell
48    the command to create signed tag in such a situation.
50  * "git merge" used to allow merging two branches that have no common
51    base by default, which led to a brand new history of an existing
52    project created and then get pulled by an unsuspecting maintainer,
53    which allowed an unnecessary parallel history merged into the
54    existing project.  The command has been taught not to allow this by
55    default, with an escape hatch "--allow-unrelated-histories" option
56    to be used in a rare event that merges histories of two projects
57    that started their lives independently.
59  * "git apply -v" learned to report paths in the patch that were
60    skipped via --include/--exclude mechanism or being outside the
61    current working directory.
63  * Shell completion (in contrib/) updates.
65  * The commit object name reported when "rebase -i" stops has been
66    shortened.
68  * "git worktree add" can be given "--no-checkout" option to only
69    create an empty worktree without checking out the files.
71  * "git mergetools" learned to drive ExamDiff.
73  * "git pull --rebase" learned "--[no-]autostash" option, so that
74    the rebase.autostash configuration variable set to true can be
75    overridden from the command line.
77  * When "git log" shows the log message indented by 4-spaces, the
78    remainder of a line after a HT does not align in the way the author
79    originally intended.  The command now expands tabs by default in
80    such a case, and allows the users to override it with a new option,
81    "--no-expand-tabs".
84 Performance, Internal Implementation, Development Support etc.
86  * The embedded args argv-array in the child process is used to build
87    the command line to run pack-objects instead of using a separate
88    array of strings.
89    (merge 65a3629 mp/upload-pack-use-embedded-args later to maint).
91  * A test for tags has been restructured so that more parts of it can
92    easily be run on a platform without a working GnuPG.
94  * The startup_info data, which records if we are working inside a
95    repository (among other things), are now uniformly available to Git
96    subcommand implementations, and Git avoids attempting to touch
97    references when we are not in a repository.
98    (merge 11e6b3f jk/startup-info later to maint).
100  * The command line argument parser for "receive-pack" has been
101    rewritten to use parse-options.
103  * A major part of "git submodule update" has been ported to C to take
104    advantage of the recently added framework to run download tasks in
105    parallel.
107  * Rename bunch of tests on "git clone" for better organization.
108    (merge 8fbb03a sb/clone-t57-t56 later to maint).
110  * The tests that involve running httpd leaked the system-wide
111    configuration in /etc/gitconfig to the tested environment.
112    (merge 1fad503 jk/test-httpd-config-nosystem later to maint).
114  * Build updates for MSVC.
115    (merge 0ef60af ss/msvc later to maint).
117  * The repository set-up sequence has been streamlined (the biggest
118    change is that there is no longer git_config_early()), so that we
119    do not attempt to look into refs/* when we know we do not have a
120    Git repository.
121    (merge 274db84 jk/check-repository-format later to maint).
124 Also contains various documentation updates and code clean-ups.
127 Fixes since v2.8
128 ----------------
130 Unless otherwise noted, all the fixes since v2.8 in the maintenance
131 track are contained in this release (see the maintenance releases'
132 notes for details).
134  * "git config --get-urlmatch", unlike other variants of the "git
135    config --get" family, did not signal error with its exit status
136    when there was no matching configuration.
137    (merge 24990b2 jk/config-get-urlmatch later to maint).
139  * The "--local-env-vars" and "--resolve-git-dir" options of "git
140    rev-parse" failed to work outside a repository when the command's
141    option parsing was rewritten in 1.8.5 era.
142    (merge fc7d47f jk/rev-parse-local-env-vars later to maint).
144  * "git index-pack --keep[=<msg>] pack-$name.pack" simply did not work.
145    (merge 0e94242 jc/maint-index-pack-keep later to maint).
147  * Fetching of history by naming a commit object name directly didn't
148    work across remote-curl transport.
149    (merge 754ecb1 gf/fetch-pack-direct-object-fetch later to maint).
151  * A small memory leak in an error codepath has been plugged in xdiff
152    code.
153    (merge 87f1625 rj/xdiff-prepare-plug-leak-on-error-codepath later to maint).
155  * strbuf_getwholeline() did not NUL-terminate the buffer on certain
156    corner cases in its error codepath.
157    (merge b709043 jk/getwholeline-getdelim-empty later to maint).
159  * "git mergetool" did not work well with conflicts that both sides
160    deleted.
161    (merge a298604 da/mergetool-delete-delete-conflict later to maint).
163  * "git send-email" had trouble parsing alias file in mailrc format
164    when lines in it had trailing whitespaces on them.
165    (merge a277d1e jk/send-email-rtrim-mailrc-alias later to maint).
167  * When "git merge --squash" stopped due to conflict, the concluding
168    "git commit" failed to read in the SQUASH_MSG that shows the log
169    messages from all the squashed commits.
170    (merge b64c1e0 ss/commit-squash-msg later to maint).
172  * "git merge FETCH_HEAD" dereferenced NULL pointer when merging
173    nothing into an unborn history (which is arguably unusual usage,
174    which perhaps was the reason why nobody noticed it).
175    (merge b84e65d jv/merge-nothing-into-void later to maint).
177  * When "git worktree" feature is in use, "git branch -d" allowed
178    deletion of a branch that is checked out in another worktree,
179    which was wrong.
180    (merge f292244 ky/branch-d-worktree later to maint).
182  * When "git worktree" feature is in use, "git branch -m" renamed a
183    branch that is checked out in another worktree without adjusting
184    the HEAD symbolic ref for the worktree.
185    (merge 18eb3a9 ky/branch-m-worktree later to maint).
187  * "git diff -M" used to work better when two originally identical
188    files A and B got renamed to X/A and X/B by pairing A to X/A and B
189    to X/B, but this was broken in the 2.0 timeframe.
190    (merge ca4e3ca sg/diff-multiple-identical-renames later to maint).
192  * "git send-pack --all <there>" was broken when its command line
193    option parsing was written in the 2.6 timeframe.
194    (merge c677756 sk/send-pack-all-fix later to maint).
196  * "git format-patch --help" showed `-s` and `--no-patch` as if these
197    are valid options to the command.  We already hide `--patch` option
198    from the documentation, because format-patch is about showing the
199    diff, and the documentation now hides these options as well.
200    (merge b73a1bc es/format-patch-doc-hide-no-patch later to maint).
202  * When running "git blame $path" with unnormalized data in the index
203    for the path, the data in the working tree was blamed, even though
204    "git add" would not have changed what is already in the index, due
205    to "safe crlf" that disables the line-end conversion.  It has been
206    corrected.
207    (merge a08feb8 tb/blame-force-read-cache-to-workaround-safe-crlf later to maint).
209  * A change back in version 2.7 to "git branch" broke display of a
210    symbolic ref in a non-standard place in the refs/ hierarchy (we
211    expect symbolic refs to appear in refs/remotes/*/HEAD to point at
212    the primary branch the remote has, and as .git/HEAD to point at the
213    branch we locally checked out).
214    (merge 95c38fb jk/branch-shortening-funny-symrefs later to maint).
216  * Other minor clean-ups and documentation updates
217    (merge aed7480 mm/lockfile-error-message later to maint).
218    (merge bfee614 jc/index-pack later to maint).
219    (merge f870899 ss/exc-flag-is-a-collection-of-bits later to maint).
220    (merge dde7891 pb/t7502-drop-dup later to maint).
221    (merge 3bd1b51 cc/doc-recommend-performance-trace-to-file later to maint).
222    (merge 7d5e9c9 jk/credential-cache-comment-exit later to maint).
223    (merge 16a86d4 nd/apply-doc later to maint).
224    (merge c3f6b85 pb/opt-cmdmode-doc later to maint).
225    (merge 30211fb oa/doc-diff-check later to maint).
226    (merge 01d98e8 ak/use-hashmap-iter-first-in-submodule-config later to maint).
227    (merge 8b5a3e9 kn/for-each-tag-branch later to maint).
228    (merge 9c60d9f sb/misc-cleanups later to maint).
229    (merge 7a6a44c cc/apply later to maint).
230    (merge 8e9b208 js/mingw-tests-2.8 later to maint).
231    (merge d55de70 jc/makefile-redirection-stderr later to maint).
232    (merge 4232b21 ep/trace-doc-sample-fix later to maint).