Merge branch 'tb/conversion'
[alt-git.git] / Documentation / RelNotes / 2.8.0.txt
blob3df3a98f70c852490868014e1748d3fbedef2925
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.
101  * "git fetch" and friends that make network connections can now be
102    told to only use ipv4 (or ipv6).
104  * Some authentication methods do not need username or password, but
105    libcurl needs some hint that it needs to perform authentication.
106    Supplying an empty username and password string is a valid way to
107    do so, but you can set the http.[<url>.]emptyAuth configuration
108    variable to achieve the same, if you find it cleaner.
110  * You can now set http.[<url>.]pinnedpubkey to specify the pinned
111    public key when building with recent enough versions of libcURL.
114 Performance, Internal Implementation, Development Support etc.
116  * Add a framework to spawn a group of processes in parallel, and use
117    it to run "git fetch --recurse-submodules" in parallel.
119  * A slight update to the Makefile to mark "phoney" targets
120    as such correctly.
122  * In-core storage of the reverse index for .pack files (which lets
123    you go from a pack offset to an object name) has been streamlined.
125  * d95138e6 (setup: set env $GIT_WORK_TREE when work tree is set, like
126    $GIT_DIR, 2015-06-26) attempted to work around a glitch in alias
127    handling by overwriting GIT_WORK_TREE environment variable to
128    affect subprocesses when set_git_work_tree() gets called, which
129    resulted in a rather unpleasant regression to "clone" and "init".
130    Try to address the same issue by always restoring the environment
131    and respawning the real underlying command when handling alias.
133  * The low-level code that is used to create symbolic references has
134    been updated to share more code with the code that deals with
135    normal references.
137  * strbuf_getline() and friends have been redefined to make it easier
138    to identify which callsite of (new) strbuf_getline_lf() should
139    allow and silently ignore carriage-return at the end of the line to
140    help users on DOSsy systems.
142  * "git shortlog" used to accumulate various pieces of information
143    regardless of what was asked to be shown in the final output.  It
144    has been optimized by noticing what need not to be collected
145    (e.g. there is no need to collect the log messages when showing
146    only the number of changes).
148  * "git checkout $branch" (and other operations that share the same
149    underlying machinery) has been optimized.
151  * Automated tests in Travis CI environment has been optimized by
152    persisting runtime statistics of previous "prove" run, executing
153    tests that take longer before other ones; this reduces the total
154    wallclock time.
156  * Test scripts have been updated to remove assumptions that are not
157    portable between Git for POSIX and Git for Windows, or to skip ones
158    with expectations that are not satisfiable on Git for Windows.
160  * Some calls to strcpy(3) triggers a false warning from static
161    analysers that are less intelligent than humans, and reducing the
162    number of these false hits helps us notice real issues.  A few
163    calls to strcpy(3) in test-path-utils that are already safe has
164    been rewritten to avoid false wanings.
166  * Some calls to strcpy(3) triggers a false warning from static
167    analysers that are less intelligent than humans, and reducing the
168    number of these false hits helps us notice real issues.  A few
169    calls to strcpy(3) in "git rerere" that are already safe has been
170    rewritten to avoid false wanings.
172  * The "name_path" API was an attempt to reduce the need to construct
173    the full path out of a series of path components while walking a
174    tree hierarchy, but over time made less efficient because the path
175    needs to be flattened, e.g. to be compared with another path that
176    is already flat.  The API has been removed and its users have been
177    rewritten to simplify the overall code complexity.
179  * Help those who debug http(s) part of the system.
180    (merge 0054045 sp/remote-curl-ssl-strerror later to maint).
182 Also contains various documentation updates and code clean-ups.
185 Fixes since v2.7
186 ----------------
188 Unless otherwise noted, all the fixes since v2.7 in the maintenance
189 track are contained in this release (see the maintenance releases'
190 notes for details).
192  * An earlier change in 2.5.x-era broke users' hooks and aliases by
193    exporting GIT_WORK_TREE to point at the root of the working tree,
194    interfering when they tried to use a different working tree without
195    setting GIT_WORK_TREE environment themselves.
197  * The "exclude_list" structure has the usual "alloc, nr" pair of
198    fields to be used by ALLOC_GROW(), but clear_exclude_list() forgot
199    to reset 'alloc' to 0 when it cleared 'nr' to discard the managed
200    array.
202  * Paths that have been told the index about with "add -N" are not
203    quite yet in the index, but a few commands behaved as if they
204    already are in a harmful way.
206  * "git send-email" was confused by escaped quotes stored in the alias
207    files saved by "mutt", which has been corrected.
209  * A few unportable C construct have been spotted by clang compiler
210    and have been fixed.
212  * The documentation has been updated to hint the connection between
213    the '--signoff' option and DCO.
215  * "git reflog" incorrectly assumed that all objects that used to be
216    at the tip of a ref must be commits, which caused it to segfault.
218  * The ignore mechanism saw a few regressions around untracked file
219    listing and sparse checkout selection areas in 2.7.0; the change
220    that is responsible for the regression has been reverted.
222  * Some codepaths used fopen(3) when opening a fixed path in $GIT_DIR
223    (e.g. COMMIT_EDITMSG) that is meant to be left after the command is
224    done.  This however did not work well if the repository is set to
225    be shared with core.sharedRepository and the umask of the previous
226    user is tighter.  They have been made to work better by calling
227    unlink(2) and retrying after fopen(3) fails with EPERM.
229  * Asking gitweb for a nonexistent commit left a warning in the server
230    log.
232    Somebody may want to follow this up with an additional test, perhaps?
233    IIRC, we do test that no Perl warnings are given to the server log,
234    so this should have been caught if our test coverage were good.
236  * "git rebase", unlike all other callers of "gc --auto", did not
237    ignore the exit code from "gc --auto".
239  * Many codepaths that run "gc --auto" before exiting kept packfiles
240    mapped and left the file descriptors to them open, which was not
241    friendly to systems that cannot remove files that are open.  They
242    now close the packs before doing so.
244  * A recent optimization to filter-branch in v2.7.0 introduced a
245    regression when --prune-empty filter is used, which has been
246    corrected.
248  * The description for SANITY prerequisite the test suite uses has
249    been clarified both in the comment and in the implementation.
251  * "git tag" started listing a tag "foo" as "tags/foo" when a branch
252    named "foo" exists in the same repository; remove this unnecessary
253    disambiguation, which is a regression introduced in v2.7.0.
255  * The way "git svn" uses auth parameter was broken by Subversion
256    1.9.0 and later.
258  * The "split" subcommand of "git subtree" (in contrib/) incorrectly
259    skipped merges when it shouldn't, which was corrected.
261  * A few options of "git diff" did not work well when the command was
262    run from a subdirectory.
264  * The command line completion learned a handful of additional options
265    and command specific syntax.
267  * dirname() emulation has been added, as Msys2 lacks it.
269  * The underlying machinery used by "ls-files -o" and other commands
270    have been taught not to create empty submodule ref cache for a
271    directory that is not a submodule.  This removes a ton of wasted
272    CPU cycles.
274  * "git worktree" had a broken code that attempted to auto-fix
275    possible inconsistency that results from end-users moving a
276    worktree to different places without telling Git (the original
277    repository needs to maintain backpointers to its worktrees, but
278    "mv" run by end-users who are not familiar with that fact will
279    obviously not adjust them), which actually made things worse
280    when triggered.
282  * The low-level merge machinery has been taught to use CRLF line
283    termination when inserting conflict markers to merged contents that
284    are themselves CRLF line-terminated.
286  * "git push --force-with-lease" has been taught to report if the push
287    needed to force (or fast-forwarded).
289  * The emulated "yes" command used in our test scripts has been
290    tweaked not to spend too much time generating unnecessary output
291    that is not used, to help those who test on Windows where it would
292    not stop until it fills the pipe buffer due to lack of SIGPIPE.
294  * The documentation for "git clean" has been corrected; it mentioned
295    that .git/modules/* are removed by giving two "-f", which has never
296    been the case.
298  * The vimdiff backend for "git mergetool" has been tweaked to arrange
299    and number buffers in the order that would match the expectation of
300    majority of people who read left to right, then top down and assign
301    buffers 1 2 3 4 "mentally" to local base remote merge windows based
302    on that order.
304  * "git show 'HEAD:Foo[BAR]Baz'" did not interpret the argument as a
305    rev, i.e. the object named by the the pathname with wildcard
306    characters in a tree object.
307    (merge aac4fac nd/dwim-wildcards-as-pathspecs later to maint).
309  * "git rev-parse --git-common-dir" used in the worktree feature
310    misbehaved when run from a subdirectory.
311    (merge 17f1365 nd/git-common-dir-fix later to maint).
313  * Another try to add support to the ignore mechanism that lets you
314    say "this is excluded" and then later say "oh, no, this part (that
315    is a subset of the previous part) is not excluded".
317  * "git worktree add -B <branchname>" did not work.
319  * The "v(iew)" subcommand of the interactive "git am -i" command was
320    broken in 2.6.0 timeframe when the command was rewritten in C.
321    (merge 708b8cc jc/am-i-v-fix later to maint).
323  * Other minor clean-ups and documentation updates