Merge branch 'ea/checkout-progress'
[git/git.git] / Documentation / RelNotes / 2.7.0.txt
CommitLineData
24a00ef6
JH
1Git 2.7 Release Notes
2=====================
3
4Updates since v2.6
5------------------
6
7UI, Workflows & Features
8
9 * "git remote" learned "get-url" subcommand to show the URL for a
10 given remote name used for fetching and pushing.
11
12 * There was no way to defeat a configured rebase.autostash variable
13 from the command line, as "git rebase --no-autostash" was missing.
14
15 * "git log --date=local" used to only show the normal (default)
16 format in the local timezone. The command learned to take 'local'
17 as an instruction to use the local timezone with other formats,
18
19 * The refs used during a "git bisect" session is now per-worktree so
20 that independent bisect sessions can be done in different worktrees
21 created with "git worktree add".
22
23 * Users who are too busy to type three extra keystrokes to ask for
24 "git stash show -p" can now set stash.showPatch configuration
25 varible to true to always see the actual patch, not just the list
26 of paths affected with feel for the extent of damage via diffstat.
27
28 * "quiltimport" allows to specify the series file by honoring the
29 $QUILT_SERIES environment and also --series command line option.
30
31 * The use of 'good/bad' in "git bisect" made it confusing to use when
32 hunting for a state change that is not a regression (e.g. bugfix).
33 The command learned 'old/new' and then allows the end user to
906c32b9 34 say e.g. "bisect start --term-old=fast --term-new=slow" to find a
24a00ef6
JH
35 performance regression.
36
37 * "git interpret-trailers" can now run outside of a Git repository.
38
f5b60798
JH
39 * "git p4" learned to reencode the pathname it uses to communicate
40 with the p4 depot with a new option.
41
42 * Give progress meter to "git filter-branch".
43
44 * Allow a later "!/abc/def" to override an earlier "/abc" that
45 appears in the same .gitignore file to make it easier to express
46 "everything in /abc directory is ignored, except for ...".
47
a838ae9d
JH
48 * Teach "git p4" to send large blobs outside the repository by
49 talking to Git LFS.
50
37023ba3
JH
51 * Prepare for Git on-disk repository representation to undergo
52 backward incompatible changes by introducing a new repository
53 format version "1", with an extension mechanism.
54 (merge 067fbd4 jk/repository-extension later to maint).
55
56 * "git worktree" learned a "list" subcommand.
57
2635c2b8
JH
58 * "git clone --dissociate" learned that it can be used even when
59 "--reference" was not used at the same time.
60
c29024e5
JH
61 * "git blame" learnt to take "--first-parent" and "--reverse" at the
62 same time when it makes sense.
63
24a00ef6
JH
64
65Performance, Internal Implementation, Development Support etc.
66
67 * The infrastructure to rewrite "git submodule" in C is being built
68 incrementally. Let's polish these early parts well enough and make
69 them graduate to 'next' and 'master', so that the more involved
70 follow-up can start cooking on a solid ground.
71
72 * Some features from "git tag -l" and "git branch -l" have been made
73 available to "git for-each-ref" so that eventually the unified
37023ba3
JH
74 implementation can be shared across all three. The version merged
75 to the 'master' branch earlier had a performance regression in "tag
76 --contains", which has since been corrected.
24a00ef6
JH
77
78 * Because "test_when_finished" in our test framework queues the
79 clean-up tasks to be done in a shell variable, it should not be
80 used inside a subshell. Add a mechanism to allow 'bash' to catch
81 such uses, and fix the ones that were found.
82 (merge 0968f12 jk/test-lint-forbid-when-finished-in-subshell later to maint).
83
84 * The debugging infrastructure for pkt-line based communication has
85 been improved to mark the side-band communication specifically.
86 (merge fd89433 jk/async-pkt-line later to maint).
87
a838ae9d
JH
88 * Update "git branch" that list existing branches, using the
89 ref-filter API that is shared with "git tag" and "git
90 for-each-ref".
91
bca92e88
JH
92 * The test for various line-ending conversions has been enhanced.
93
94 * A few test scripts around "git p4" have been improved for
95 portability.
96
97 * Many allocations that is manually counted (correctly) that are
98 followed by strcpy/sprintf have been replaced with a less error
99 prone constructs such as xstrfmt.
100
37023ba3
JH
101 * The internal stripspace() function has been moved to where it
102 logically belongs to, i.e. strbuf API, and the command line parser
103 of "git stripspace" has been updated to use the parse_options API.
104 (merge bed4452 tk/stripspace later to maint).
105
80980a1d
JH
106 * "git am" used to spawn "git mailinfo" via run_command() API once
107 per each patch, but learned to make a direct call to mailinfo()
108 instead.
109
110 * The implementation of "git mailinfo" was refactored so that a
111 mailinfo() function can be directly called from inside a process.
112
c29024e5
JH
113 * With a "debug" helper, debugging of a single "git" invocation in
114 our test scripts has become a lot easier.
115
24a00ef6
JH
116
117Also contains various documentation updates and code clean-ups.
118
119
120Fixes since v2.6
121----------------
122
123Unless otherwise noted, all the fixes since v2.6 in the maintenance
124track are contained in this release (see the maintenance releases'
125notes for details).
126
127 * Very small number of options take a parameter that is optional
128 (which is not a great UI element as they can only appear at the end
129 of the command line). Add notice to documentation of each and
130 every one of them.
131 (merge 2b594bf mm/keyid-docs later to maint).
132
133 * "git blame --first-parent v1.0..v2.0" was not rejected but did not
134 limit the blame to commits on the first parent chain.
135 (merge 95a4fb0 jk/blame-first-parent later to maint).
136
137 * "git subtree" (in contrib/) now can take whitespaces in the
138 pathnames, not only in the in-tree pathname but the name of the
139 directory that the repository is in. (merge 5b6ab38
140 as/subtree-with-spaces later to maint).
141
142 * The ssh transport, just like any other transport over the network,
143 did not clear GIT_* environment variables, but it is possible to
144 use SendEnv and AcceptEnv to leak them to the remote invocation of
145 Git, which is not a good idea at all. Explicitly clear them just
146 like we do for the local transport.
147 (merge a48b409 jk/connect-clear-env later to maint).
148
149 * Correct "git p4 --detect-labels" so that it does not fail to create
150 a tag that points at a commit that is also being imported.
151 (merge b43702a ld/p4-import-labels later to maint).
152
153 * The Makefile always runs the library archiver with hardcoded "crs"
154 options, which was inconvenient for exotic platforms on which
155 people want to use programs with totally different set of command
156 line options.
157 (merge ac179b4 jw/make-arflags-customizable later to maint).
158
159 * Customization to change the behaviour with "make -w" and "make -s"
160 in our Makefile was broken when they were used together.
161 (merge ef49e05 jk/make-findstring-makeflags-fix later to maint).
162
f5b60798
JH
163 * Allocation related functions and stdio are unsafe things to call
164 inside a signal handler, and indeed killing the pager can cause
165 glibc to deadlock waiting on allocation mutex as our signal handler
166 tries to free() some data structures in wait_for_pager(). Reduce
167 these unsafe calls.
168 (merge 507d780 ti/glibc-stdio-mutex-from-signal-handler later to maint).
169
b27dacc1
JH
170 * The way how --ref/--notes to specify the notes tree reference are
171 DWIMmed was not clearly documented.
172 (merge e14c92e jk/notes-dwim-doc later to maint).
173
a838ae9d
JH
174 * "git gc" used to barf when a symbolic ref has gone dangling
175 (e.g. the branch that used to be your upstream's default when you
176 cloned from it is now gone, and you did "fetch --prune").
177 (merge 14886b4 js/gc-with-stale-symref later to maint).
178
179 * "git clone --dissociate" runs a big "git repack" process at the
180 end, and it helps to close file descriptors that are open on the
181 packs and their idx files before doing so on filesystems that
182 cannot remove a file that is still open.
183 (merge 786b150 js/clone-dissociate later to maint).
184
185 * Description of the "log.follow" configuration variable in "git log"
186 documentation is now also copied to "git config" documentation.
187 (merge fd8d07e dt/log-follow-config later to maint).
188
189 * "git rebase -i" had a minor regression recently, which stopped
190 considering a line that begins with an indented '#' in its insn
2635c2b8
JH
191 sheet not a comment. Further, the code was still too picky on
192 Windows where CRLF left by the editor is turned into a trailing CR
193 on the line read via the "read" built-in command of bash. Both of
194 these issues are now fixed.
195 (merge 39743cf gr/rebase-i-drop-warn later to maint).
a838ae9d
JH
196
197 * After "git checkout --detach", "git status" reported a fairly
198 useless "HEAD detached at HEAD", instead of saying at which exact
199 commit.
200 (merge 0eb8548 mm/detach-at-HEAD-reflog later to maint).
201
202 * When "git send-email" wanted to talk over Net::SMTP::SSL,
203 Net::Cmd::datasend() did not like to be fed too many bytes at the
204 same time and failed to send messages. Send the payload one line
205 at a time to work around the problem.
206 (merge f60c483 sa/send-email-smtp-batch-data-limit later to maint).
207
208 * When "git am" was rewritten as a built-in, it stopped paying
209 attention to user.signingkey, which was fixed.
210 (merge 434c64d pt/am-builtin later to maint).
211
212 * It was not possible to use a repository-lookalike created by "git
213 worktree add" as a local source of "git clone".
214 (merge d78db84 nd/clone-linked-checkout later to maint).
215
216 * On a case insensitive filesystems, setting GIT_WORK_TREE variable
217 using a random cases that does not agree with what the filesystem
218 thinks confused Git that it wasn't inside the working tree.
219 (merge 63ec5e1 js/icase-wt-detection later to maint).
220
221 * Performance-measurement tests did not work without an installed Git.
222 (merge 31cd128 sb/perf-without-installed-git later to maint).
223
224 * A test script for the HTTP service had a timing dependent bug,
225 which was fixed.
226 (merge 362d8b6 sb/http-flaky-test-fix later to maint).
227
228 * There were some classes of errors that "git fsck" diagnosed to its
229 standard error that did not cause it to exit with non-zero status.
230 (merge 122f76f jc/fsck-dropped-errors later to maint).
231
232 * Work around "git p4" failing when the P4 depot records the contents
233 in UTF-16 without UTF-16 BOM.
234 (merge 1f5f390 ls/p4-translation-failure later to maint).
235
236 * When "git gc --auto" is backgrounded, its diagnosis message is
237 lost. Save it to a file in $GIT_DIR and show it next time the "gc
238 --auto" is run.
239 (merge 329e6e8 nd/gc-auto-background-fix later to maint).
240
241 * The submodule code has been taught to work better with separate
242 work trees created via "git worktree add".
243 (merge 11f9dd7 mk/submodule-gitdir-path later to maint).
244
906c32b9
JH
245 * "git gc" is safe to run anytime only because it has the built-in
246 grace period to protect young objects. In order to run with no
247 grace period, the user must make sure that the repository is
248 quiescent.
249 (merge fae1a90 jc/doc-gc-prune-now later to maint).
250
251 * A recent "filter-branch --msg-filter" broke skipping of the commit
252 object header, which is fixed.
253 (merge a5a4b3f jk/filter-branch-use-of-sed-on-incomplete-line later to maint).
254
255 * The normalize_ceiling_entry() function does not muck with the end
256 of the path it accepts, and the real world callers do rely on that,
257 but a test insisted that the function drops a trailing slash.
258 (merge b2a7123 rd/test-path-utils later to maint).
259
37023ba3
JH
260 * A test for interaction between untracked cache and sparse checkout
261 added in Git 2.5 days were flaky.
262 (merge 9b680fb dt/t7063-fix-flaky-test later to maint).
263
264 * A couple of commands still showed "[options]" in their usage string
265 to note where options should come on their command line, but we
266 spell that "[<options>]" in most places these days.
267 (merge d96a031 rt/placeholder-in-usage later to maint).
268
269 * The synopsis text and the usage string of subcommands that read
270 list of things from the standard input are often shown as if they
271 only take input from a file on a filesystem, which was misleading.
272 (merge 33e8fc8 jc/usage-stdin later to maint).
273
274 * "git am -3" had a small regression where it is aborted in its error
275 handling codepath when underlying merge-recursive failed in certain
276 ways, as it assumed that the internal call to merge-recursive will
277 never die, which is not the case (yet).
278 (merge c63d4b2 jc/am-3-fallback-regression-fix later to maint).
279
80980a1d
JH
280 * The linkage order of libraries was wrong in places around libcurl.
281 (merge 7e91e8d rp/link-curl-before-ssl later to maint).
282
283 * The name-hash subsystem that is used to cope with case insensitive
284 filesystems keeps track of directories and their on-filesystem
285 cases for all the paths in the index by holding a pointer to a
286 randomly chosen cache entry that is inside the directory (for its
287 ce->ce_name component). This pointer was not updated even when the
288 cache entry was removed from the index, leading to use after free.
289 This was fixed by recording the path for each directory instead of
290 borrowing cache entries and restructuring the API somewhat.
291 (merge 41284eb dt/name-hash-dir-entry-fix later to maint).
292
2635c2b8
JH
293 * "git merge-file" tried to signal how many conflicts it found, which
294 obviously would not work well when there are too many of them.
295 (merge e34f802 jk/merge-file-exit-code later to maint).
296
297 * The error message from "git blame --contents --reverse" incorrectly
298 talked about "--contents --children".
299 (merge 9526197 mk/blame-error-message later to maint).
300
301 * "git imap-send" did not compile well with older version of cURL library.
302 (merge 71d9257 js/imap-send-curl-compilation-fix later to maint).
303
304 * Merging a branch that removes a path and another that changes the
305 mode bits on the same path should have conflicted at the path, but
306 it didn't and silently favoured the removal.
307 (merge 72fac66 jk/delete-modechange-conflict later to maint).
308
309 * "git --literal-pathspecs add -u/-A" without any command line
310 argument misbehaved ever since Git 2.0.
311 (merge 29abb33 jc/add-u-A-default-to-top later to maint).
312
c29024e5
JH
313 * "git daemon" uses "run_command()" without "finish_command()", so it
314 needs to release resources itself, which it forgot to do.
315 (merge b1b49ff rs/daemon-plug-child-leak later to maint).
316
317 * "git status --branch --short" accessed beyond the constant string
318 "HEAD", which has been corrected.
319 (merge c72b49d rs/wt-status-detached-branch-fix later to maint).
320
321 * We peek objects from submodule's object store by linking it to the
322 list of alternate object databases, but the code to do so forgot to
323 correctly initialize the list.
324 (merge 9a6e4f0 jk/initialization-fix-to-add-submodule-odb later to maint).
325
326 * The code to prepare the working tree side of temporary directory
327 for the "dir-diff" feature forgot that symbolic links need not be
328 copied (or symlinked) to the temporary area, as the code already
329 special cases and overwrites them. Besides, it was wrong to try
330 computing the object name of the target of symbolic link, which may
331 not even exist or may be a directory.
332 (merge cfe2d4b da/difftool later to maint).
333
80980a1d 334 * Code clean-up, minor fixes etc.
24a00ef6 335 (merge 15ed07d jc/rerere later to maint).
bca92e88 336 (merge e7a7401 pt/pull-builtin later to maint).
b27dacc1
JH
337 (merge 29bc480 nd/ls-remote-does-not-have-u-option later to maint).
338 (merge be510e0 jk/asciidoctor-section-heading-markup-fix later to maint).
339 (merge 83e6bda tk/typofix-connect-unknown-proto-error later to maint).
a838ae9d
JH
340 (merge a43eb67 tk/doc-interpret-trailers-grammo later to maint).
341 (merge ba128e2 es/worktree-add-cleanup later to maint).
342 (merge 44cd91e cc/quote-comments later to maint).
906c32b9 343 (merge 147875f sb/submodule-config-parse later to maint).
37023ba3 344 (merge ae9f274 es/worktree-add later to maint).
80980a1d
JH
345 (merge 3b19dba jc/em-dash-in-doc later to maint).
346 (merge f3f38c7 jc/everyday-markup later to maint).
347 (merge 77d5f71 xf/user-manual-markup later to maint).
2635c2b8
JH
348 (merge b2af482 xf/user-manual-ff later to maint).
349 (merge e510ab8 rs/pop-commit later to maint).
350 (merge fdcdb77 js/misc-fixes later to maint).
c29024e5 351 (merge c949b00 rs/show-branch-argv-array later to maint).