Merge branch 'ce/https-public-key-pinning'
[alt-git.git] / Documentation / RelNotes / 2.8.0.txt
blobdd540d032738eb372ef4c774b4e767f2c09da6ad
1 Git 2.8 Release Notes
2 =====================
4 Backward compatibility note
5 ---------------------------
7 The rsync:// transport has been removed.
10 Updates since v2.7
11 ------------------
13 UI, Workflows & Features
15  * It turns out "git clone" over rsync transport has been broken when
16    the source repository has packed references for a long time, and
17    nobody noticed nor complained about it.
19  * "branch --delete" has "branch -d" but "push --delete" does not.
21  * "git blame" learned to produce the progress eye-candy when it takes
22    too much time before emitting the first line of the result.
24  * "git grep" can now be configured (or told from the command line)
25    how many threads to use when searching in the working tree files.
27  * Some "git notes" operations, e.g. "git log --notes=<note>", should
28    be able to read notes from any tree-ish that is shaped like a notes
29    tree, but the notes infrastructure required that the argument must
30    be a ref under refs/notes/.  Loosen it to require a valid ref only
31    when the operation would update the notes (in which case we must
32    have a place to store the updated notes tree, iow, a ref).
34  * "git grep" by default does not fall back to its "--no-index"
35    behaviour outside a directory under Git's control (otherwise the
36    user may by mistake end up running a huge recursive search); with a
37    new configuration (set in $HOME/.gitconfig--by definition this
38    cannot be set in the config file per project), this safety can be
39    disabled.
41  * "git pull --rebase" has been extended to allow invoking
42    "rebase -i".
44  * "git p4" learned to cope with the type of a file getting changed.
46  * "git format-patch" learned to notice format.outputDirectory
47    configuration variable.  This allows "-o <dir>" option to be
48    omitted on the command line if you always use the same directory in
49    your workflow.
51  * "interpret-trailers" has been taught to optionally update a file in
52    place, instead of always writing the result to the standard output.
54  * Many commands that read files that are expected to contain text
55    that is generated (or can be edited) by the end user to control
56    their behaviour (e.g. "git grep -f <filename>") have been updated
57    to be more tolerant to lines that are terminated with CRLF (they
58    used to treat such a line to contain payload that ends with CR,
59    which is usually not what the users expect).
61  * "git notes merge" used to limit the source of the merged notes tree
62    to somewhere under refs/notes/ hierarchy, which was too limiting
63    when inventing a workflow to exchange notes with remote
64    repositories using remote-tracking notes trees (located in e.g.
65    refs/remote-notes/ or somesuch).
67  * "git ls-files" learned a new "--eol" option to help diagnose
68    end-of-line problems.
70  * "ls-remote" learned an option to show which branch the remote
71    repository advertises as its primary by pointing its HEAD at.
73  * New http.proxyAuthMethod configuration variable can be used to
74    specify what authentication method to use, as a way to work around
75    proxies that do not give error response expected by libcurl when
76    CURLAUTH_ANY is used.  Also, the codepath for proxy authentication
77    has been taught to use credential API to store the authentication
78    material in user's keyrings.
80  * Update the untracked cache subsystem and change its primary UI from
81    "git update-index" to "git config".
83  * There were a few "now I am doing this thing" progress messages in
84    the TCP connection code that can be triggered by setting a verbose
85    option internally in the code, but "git fetch -v" and friends never
86    passed the verbose option down to that codepath.
88  * Clean/smudge filters defined in a configuration file of lower
89    precedence can now be overridden to be a pass-through no-op by
90    setting the variable to an empty string.
92  * A new "<branch>^{/!-<pattern>}" notation can be used to name a
93    commit that is reachable from <branch> that does not match the
94    given <pattern>.
96  * The "user.useConfigOnly" configuration variable can be used to
97    force the user to always set user.email & user.name configuration
98    variables, serving as a reminder for those who work on multiple
99    projects and do not want to put these in their $HOME/.gitconfig.
102 Performance, Internal Implementation, Development Support etc.
104  * Add a framework to spawn a group of processes in parallel, and use
105    it to run "git fetch --recurse-submodules" in parallel.
107  * A slight update to the Makefile to mark "phoney" targets
108    as such correctly.
110  * In-core storage of the reverse index for .pack files (which lets
111    you go from a pack offset to an object name) has been streamlined.
113  * d95138e6 (setup: set env $GIT_WORK_TREE when work tree is set, like
114    $GIT_DIR, 2015-06-26) attempted to work around a glitch in alias
115    handling by overwriting GIT_WORK_TREE environment variable to
116    affect subprocesses when set_git_work_tree() gets called, which
117    resulted in a rather unpleasant regression to "clone" and "init".
118    Try to address the same issue by always restoring the environment
119    and respawning the real underlying command when handling alias.
121  * The low-level code that is used to create symbolic references has
122    been updated to share more code with the code that deals with
123    normal references.
125  * strbuf_getline() and friends have been redefined to make it easier
126    to identify which callsite of (new) strbuf_getline_lf() should
127    allow and silently ignore carriage-return at the end of the line to
128    help users on DOSsy systems.
130  * "git shortlog" used to accumulate various pieces of information
131    regardless of what was asked to be shown in the final output.  It
132    has been optimized by noticing what need not to be collected
133    (e.g. there is no need to collect the log messages when showing
134    only the number of changes).
136  * "git checkout $branch" (and other operations that share the same
137    underlying machinery) has been optimized.
139  * Automated tests in Travis CI environment has been optimized by
140    persisting runtime statistics of previous "prove" run, executing
141    tests that take longer before other ones; this reduces the total
142    wallclock time.
144  * Test scripts have been updated to remove assumptions that are not
145    portable between Git for POSIX and Git for Windows, or to skip ones
146    with expectations that are not satisfiable on Git for Windows.
148  * Some calls to strcpy(3) triggers a false warning from static
149    analysers that are less intelligent than humans, and reducing the
150    number of these false hits helps us notice real issues.  A few
151    calls to strcpy(3) in test-path-utils that are already safe has
152    been rewritten to avoid false wanings.
154  * Some calls to strcpy(3) triggers a false warning from static
155    analysers that are less intelligent than humans, and reducing the
156    number of these false hits helps us notice real issues.  A few
157    calls to strcpy(3) in "git rerere" that are already safe has been
158    rewritten to avoid false wanings.
160 Also contains various documentation updates and code clean-ups.
163 Fixes since v2.7
164 ----------------
166 Unless otherwise noted, all the fixes since v2.7 in the maintenance
167 track are contained in this release (see the maintenance releases'
168 notes for details).
170  * An earlier change in 2.5.x-era broke users' hooks and aliases by
171    exporting GIT_WORK_TREE to point at the root of the working tree,
172    interfering when they tried to use a different working tree without
173    setting GIT_WORK_TREE environment themselves.
174    (merge df1e6ea nd/stop-setenv-work-tree later to maint).
176  * The "exclude_list" structure has the usual "alloc, nr" pair of
177    fields to be used by ALLOC_GROW(), but clear_exclude_list() forgot
178    to reset 'alloc' to 0 when it cleared 'nr' to discard the managed
179    array.
180    (merge 2653a8c nd/dir-exclude-cleanup later to maint).
182  * Paths that have been told the index about with "add -N" are not
183    quite yet in the index, but a few commands behaved as if they
184    already are in a harmful way.
185    (merge 4d55200 nd/ita-cleanup later to maint).
187  * "git send-email" was confused by escaped quotes stored in the alias
188    files saved by "mutt", which has been corrected.
189    (merge 2c510f2 ew/send-email-mutt-alias-fix later to maint).
191  * A few unportable C construct have been spotted by clang compiler
192    and have been fixed.
193    (merge a0df2e5 jk/clang-pedantic later to maint).
195  * The documentation has been updated to hint the connection between
196    the '--signoff' option and DCO.
197    (merge b2c150d dw/signoff-doc later to maint).
199  * "git reflog" incorrectly assumed that all objects that used to be
200    at the tip of a ref must be commits, which caused it to segfault.
201    (merge aecad37 dk/reflog-walk-with-non-commit later to maint).
203  * The ignore mechanism saw a few regressions around untracked file
204    listing and sparse checkout selection areas in 2.7.0; the change
205    that is responsible for the regression has been reverted.
206    (merge 8c72236 nd/exclusion-regression-fix later to maint).
208  * Some codepaths used fopen(3) when opening a fixed path in $GIT_DIR
209    (e.g. COMMIT_EDITMSG) that is meant to be left after the command is
210    done.  This however did not work well if the repository is set to
211    be shared with core.sharedRepository and the umask of the previous
212    user is tighter.  They have been made to work better by calling
213    unlink(2) and retrying after fopen(3) fails with EPERM.
214    (merge ea56518 js/fopen-harder later to maint).
216  * Asking gitweb for a nonexistent commit left a warning in the server
217    log.
219    Somebody may want to follow this up with an additional test, perhaps?
220    IIRC, we do test that no Perl warnings are given to the server log,
221    so this should have been caught if our test coverage were good.
222    (merge a9eb90a ho/gitweb-squelch-undef-warning later to maint).
224  * "git rebase", unlike all other callers of "gc --auto", did not
225    ignore the exit code from "gc --auto".
226    (merge 8c24f5b jk/ok-to-fail-gc-auto-in-rebase later to maint).
228  * Many codepaths that run "gc --auto" before exiting kept packfiles
229    mapped and left the file descriptors to them open, which was not
230    friendly to systems that cannot remove files that are open.  They
231    now close the packs before doing so.
232    (merge d562102 js/close-packs-before-gc later to maint).
234  * A recent optimization to filter-branch in v2.7.0 introduced a
235    regression when --prune-empty filter is used, which has been
236    corrected.
237    (merge 1dc413e jk/filter-branch-no-index later to maint).
239  * The description for SANITY prerequisite the test suite uses has
240    been clarified both in the comment and in the implementation.
241    (merge 719c3da jk/sanity later to maint).
243  * "git tag" started listing a tag "foo" as "tags/foo" when a branch
244    named "foo" exists in the same repository; remove this unnecessary
245    disambiguation, which is a regression introduced in v2.7.0.
246    (merge 0571979 jk/list-tag-2.7-regression later to maint).
248  * The way "git svn" uses auth parameter was broken by Subversion
249    1.9.0 and later.
250    (merge 0b66415 ew/svn-1.9.0-auth later to maint).
252  * The "split" subcommand of "git subtree" (in contrib/) incorrectly
253    skipped merges when it shouldn't, which was corrected.
254    (merge 933cfeb dw/subtree-split-do-not-drop-merge later to maint).
256  * A few options of "git diff" did not work well when the command was
257    run from a subdirectory.
258    (merge a97262c nd/diff-with-path-params later to maint).
260  * The command line completion learned a handful of additional options
261    and command specific syntax.
262    (merge fa4b5e3 jk/completion-rebase later to maint).
263    (merge f7c2e1a pw/completion-show-branch later to maint).
264    (merge d7d4ca8 pw/completion-stash later to maint).
265    (merge e6414b4 tb/complete-word-diff-regex later to maint).
267  * dirname() emulation has been added, as Msys2 lacks it.
268    (merge e7d5ce8 js/dirname-basename later to maint).
270  * The underlying machinery used by "ls-files -o" and other commands
271    have been taught not to create empty submodule ref cache for a
272    directory that is not a submodule.  This removes a ton of wasted
273    CPU cycles.
274    (merge a2d5156 jk/ref-cache-non-repository-optim later to maint).
276  * "git worktree" had a broken code that attempted to auto-fix
277    possible inconsistency that results from end-users moving a
278    worktree to different places without telling Git (the original
279    repository needs to maintain backpointers to its worktrees, but
280    "mv" run by end-users who are not familiar with that fact will
281    obviously not adjust them), which actually made things worse
282    when triggered.
283    (merge 618244e nd/do-not-move-worktree-manually later to maint).
285  * The low-level merge machinery has been taught to use CRLF line
286    termination when inserting conflict markers to merged contents that
287    are themselves CRLF line-terminated.
288    (merge 15980de js/xmerge-marker-eol later to maint).
290  * "git push --force-with-lease" has been taught to report if the push
291    needed to force (or fast-forwarded).
292    (merge b2e93f8 aw/push-force-with-lease-reporting later to maint).
294  * The emulated "yes" command used in our test scripts has been
295    tweaked not to spend too much time generating unnecessary output
296    that is not used, to help those who test on Windows where it would
297    not stop until it fills the pipe buffer due to lack of SIGPIPE.
298    (merge 6129c93 js/test-lib-windows-emulated-yes later to maint).
300  * The documentation for "git clean" has been corrected; it mentioned
301    that .git/modules/* are removed by giving two "-f", which has never
302    been the case.
303    (merge 31e3c2d mm/clean-doc-fix later to maint).
305  * The vimdiff backend for "git mergetool" has been tweaked to arrange
306    and number buffers in the order that would match the expectation of
307    majority of people who read left to right, then top down and assign
308    buffers 1 2 3 4 "mentally" to local base remote merge windows based
309    on that order.
310    (merge 2300328 dw/mergetool-vim-window-shuffle later to maint).
312  * Other minor clean-ups and documentation updates
313    (merge 99487cf ss/user-manual later to maint).
314    (merge e914ef0 ew/for-each-ref-doc later to maint).
315    (merge 36fc7d8 sg/t6050-failing-editor-test-fix later to maint).
316    (merge 60253a6 ss/clone-depth-single-doc later to maint).
317    (merge bd02e97 lv/add-doc-working-tree later to maint).
318    (merge f562d7d ah/stripspace-optstring later to maint).