| blob | d9ac291f5fb9c2b0193cf0086c4c3287a7b79a4d |
1 Git 2.10 Release Notes
2 ======================
4 Backward compatibility notes
5 ----------------------------
7 Updates since v2.9
8 ------------------
10 UI, Workflows & Features
12 * "git pull --rebase --verify-signature" learned to warn the user
13 that "--verify-signature" is a no-op when rebasing.
15 * An upstream project can make a recommendation to shallowly clone
16 some submodules in the .gitmodules file it ships.
18 * "git worktree add" learned that '-' can be used as a short-hand for
19 "@{-1}", the previous branch.
21 * Update the funcname definition to support css files.
23 * The completion script (in contrib/) learned to complete "git
24 status" options.
26 * Messages that are generated by auto gc during "git push" on the
27 receiving end are now passed back to the sending end in such a way
28 that they are shown with "remote: " prefix to avoid confusing the
29 users.
31 * "git add -i/-p" learned to honor diff.compactionHeuristic
32 experimental knob, so that the user can work on the same hunk split
33 as "git diff" output.
35 * "upload-pack" allows a custom "git pack-objects" replacement when
36 responding to "fetch/clone" via the uploadpack.packObjectsHook.
37 (merge b738396 jk/upload-pack-hook later to maint).
39 * Teach format-patch and mailsplit (hence "am") how a line that
40 happens to begin with "From " in the e-mail message is quoted with
41 ">", so that these lines can be restored to their original shape.
42 (merge d9925d1 ew/mboxrd-format-am later to maint).
44 * "git repack" learned the "--keep-unreachable" option, which sends
45 loose unreachable objects to a pack instead of leaving them loose.
46 This helps heuristics based on the number of loose objects
47 (e.g. "gc --auto").
48 (merge e26a8c4 jk/repack-keep-unreachable later to maint).
50 * "log --graph --format=" learned that "%>|(N)" specifies the width
51 relative to the terminal's left edge, not relative to the area to
52 draw text that is to the right of the ancestry-graph section. It
53 also now accepts negative N that means the column limit is relative
54 to the right border.
56 * A careless invocation of "git send-email directory/" after editing
57 0001-change.patch with an editor often ends up sending both
58 0001-change.patch and its backup file, 0001-change.patch~, causing
59 embarrassment and a minor confusion. Detect such an input and
60 offer to skip the backup files when sending the patches out.
61 (merge 531220b jc/send-email-skip-backup later to maint).
63 * "git submodule update" that drives many "git clone" could
64 eventually hit flaky servers/network conditions on one of the
65 submodules; the command learned to retry the attempt.
67 * The output coloring scheme learned two new attributes, italic and
68 strike, in addition to existing bold, reverse, etc.
70 * "git log" learns log.showSignature configuration variable, and a
71 command line option "--no-show-signature" to countermand it.
72 (merge fce04c3 mj/log-show-signature-conf later to maint).
74 * A couple of "git svn" updates.
76 * More markings of messages for i18n, with updates to various tests
77 to pass GETTEXT_POISON tests.
79 * "git archive" learned to handle files that are larger than 8GB and
80 commits far in the future than expressible by the traditional US-TAR
81 format.
82 (merge 5caeeb8 jk/big-and-future-archive-tar later to maint).
84 * A new configuration variable core.sshCommand has been added to
85 specify what value for GIT_SSH_COMMAND to use per repository.
87 * "git worktree prune" protected worktrees that are marked as
88 "locked" by creating a file in a known location. "git worktree"
89 command learned a dedicated command pair to create and remove such
90 a file, so that the users do not have to do this with editor.
92 * A handful of "git svn" updates.
94 * "git push" learned to accept and pass extra options to the
95 receiving end so that hooks can read and react to them.
97 * "git status" learned to suggest "merge --abort" during a conflicted
98 merge, just like it already suggests "rebase --abort" during a
99 conflicted rebase.
101 * "git jump" script (in contrib/) has been updated a bit.
102 (merge a91e692 jk/git-jump later to maint).
104 * "git push" and "git clone" learned to give better progress meters
105 to the end user who is waiting on the terminal.
107 * An entry "git log --decorate" for the tip of the current branch is
108 shown as "HEAD -> name" (where "name" is the name of the branch);
109 paint the arrow in the same color as "HEAD", not in the color for
110 commits.
112 * "git format-patch" learned format.from configuration variable to
113 specify the default settings for its "--from" option.
115 * "git am -3" calls "git merge-recursive" when it needs to fall back
116 to a three-way merge; this call has been turned into an internal
117 subroutine call instead of spawning a separate subprocess.
120 Performance, Internal Implementation, Development Support etc.
122 * "git fast-import" learned the same performance trick to avoid
123 creating too small a packfile as "git fetch" and "git push" have,
124 using *.unpackLimit configuration.
126 * When "git daemon" is run without --[init-]timeout specified, a
127 connection from a client that silently goes offline can hang around
128 for a long time, wasting resources. The socket-level KEEPALIVE has
129 been enabled to allow the OS to notice such failed connections.
131 * "git upload-pack" command has been updated to use the parse-options
132 API.
134 * The "git apply" standalone program is being libified; this is the
135 first step to move many state variables into a structure that can
136 be explicitly (re)initialized to make the machinery callable more
137 than once.
139 * HTTP transport gained an option to produce more detailed debugging
140 trace.
141 (merge 73e57aa ep/http-curl-trace later to maint).
143 * Instead of taking advantage of a struct string_list that is
144 allocated with all NULs happens to be STRING_LIST_INIT_NODUP kind,
145 initialize them explicitly as such, to document their behaviour
146 better.
147 (merge 2721ce2 jk/string-list-static-init later to maint).
149 * HTTPd tests learned to show the server error log to help diagnosing
150 a failing tests.
151 (merge 44f243d nd/test-lib-httpd-show-error-log-in-verbose later to maint).
153 * The ownership rule for the piece of memory that hold references to
154 be fetched in "git fetch" was screwy, which has been cleaned up.
156 * "git bisect" makes an internal call to "git diff-tree" when
157 bisection finds the culprit, but this call did not initialize the
158 data structure to pass to the diff-tree API correctly.
160 * Further preparatory clean-up for "worktree" feature continues.
161 (merge 0409e0b nd/worktree-cleanup-post-head-protection later to maint).
163 * Formats of the various data (and how to validate them) where we use
164 GPG signature have been documented.
166 * A new run-command API function pipe_command() is introduced to
167 sanely feed data to the standard input while capturing data from
168 the standard output and the standard error of an external process,
169 which is cumbersome to hand-roll correctly without deadlocking.
171 The codepath to sign data in a prepared buffer with GPG has been
172 updated to use this API to read from the status-fd to check for
173 errors (instead of relying on GPG's exit status).
174 (merge efee955 jk/gpg-interface-cleanup later to maint).
176 * Allow t/perf framework to use the features from the most recent
177 version of Git even when testing an older installed version.
179 * The commands in the "log/diff" family have had an FILE* pointer in the
180 data structure they pass around for a long time, but some codepaths
181 used to always write to the standard output. As a preparatory step
182 to make "git format-patch" available to the internal callers, these
183 codepaths have been updated to consistently write into that FILE*
184 instead.
186 * Conversion from unsigned char sha1[20] to struct object_id
187 continues.
189 * Improve the look of the way "git fetch" reports what happened to
190 each ref that was fetched.
192 * The .c/.h sources are marked as such in our .gitattributes file so
193 that "git diff -W" and friends would work better.
195 * Code clean-up to avoid using a variable string that compilers may
196 feel untrustable as printf-style format given to write_file()
197 helper function.
199 * "git p4" used a location outside $GIT_DIR/refs/ to place its
200 temporary branches, which has been moved to refs/git-p4-tmp/.
202 * Existing autoconf generated test for the need to link with pthread
203 library did not check all the functions from pthread libraries;
204 recent FreeBSD has some functions in libc but not others, and we
205 mistakenly thought linking with libc is enough when it is not.
207 * When "git fsck" reports a broken link (e.g. a tree object contains
208 a blob that does not exist), both containing object and the object
209 that is referred to were reported with their 40-hex object names.
210 The command learned the "--name-objects" option to show the path to
211 the containing object from existing refs (e.g. "HEAD~24^2:file.txt").
213 * Allow http daemon tests in Travis CI tests.
215 * Makefile assumed that -lrt is always available on platforms that
216 want to use clock_gettime() and CLOCK_MONOTONIC, which is not a
217 case for recent Mac OS X. The necessary symbols are often found in
218 libc on many modern systems and having -lrt on the command line, as
219 long as the library exists, had no effect, but when the platform
220 removes librt.a that is a different matter--having -lrt will break
221 the linkage.
223 This change could be seen as a regression for those who do need to
224 specify -lrt, as they now specifically ask for NEEDS_LIBRT when
225 building. Hopefully they are in the minority these days.
227 * Further preparatory work on the refs API before the pluggable
228 backend series can land.
230 * Error handling in the codepaths that updates refs has been
231 improved.
233 * The API to iterate over all the refs (i.e. for_each_ref(), etc.)
234 has been revamped.
236 * A few tests that specifically target "git rebase -i" have been
237 added.
239 * Dumb http transport on the client side has been optimized.
240 (merge ecba195 ew/http-walker later to maint).
242 * Users of the parse_options_concat() API function need to allocate
243 extra slots in advance and fill them with OPT_END() when they want
244 to decide the set of supported options dynamically, which makes the
245 code error-prone and hard to read. This has been corrected by tweaking
246 the API to allocate and return a new copy of "struct option" array.
248 * "git fetch" exchanges batched have/ack messages between the sender
249 and the receiver, initially doubling every time and then falling
250 back to enlarge the window size linearly. The "smart http"
251 transport, being an half-duplex protocol, outgrows the preset limit
252 too quickly and becomes inefficient when interacting with a large
253 repository. The internal mechanism learned to grow the window size
254 more aggressively when working with the "smart http" transport.
256 * Tests for "git svn" have been taught to reuse the lib-httpd test
257 infrastructure when testing the subversion integration that
258 interacts with subversion repositories served over the http://
259 protocol.
260 (merge a8a5d25 ew/git-svn-http-tests later to maint).
262 * "git pack-objects" has a few options that tell it not to pack
263 objects found in certain packfiles, which require it to scan .idx
264 files of all available packs. The codepaths involved in these
265 operations have been optimized for a common case of not having any
266 non-local pack and/or any .kept pack.
268 * The t3700 test about "add --chmod=-x" have been made a bit more
269 robust and generally cleaned up.
270 (merge 766cdc4 ib/t3700-add-chmod-x-updates later to maint).
272 * The build procedure learned PAGER_ENV knob that lists what default
273 environment variable settings to export for popular pagers. This
274 mechanism is used to tweak the default settings to MORE on FreeBSD.
275 (merge 995bc22 ew/build-time-pager-tweaks later to maint).
278 Also contains various documentation updates and code clean-ups.
281 Fixes since v2.9
282 ----------------
284 Unless otherwise noted, all the fixes since v2.8 in the maintenance
285 track are contained in this release (see the maintenance releases'
286 notes for details).
288 * The commands in `git log` family take %C(auto) in a custom format
289 string. This unconditionally turned the color on, ignoring
290 --no-color or with --color=auto when the output is not connected to
291 a tty; this was corrected to make the format truly behave as
292 "auto".
294 * "git rev-list --count" whose walk-length is limited with "-n"
295 option did not work well with the counting optimized to look at the
296 bitmap index.
298 * "git show -W" (extend hunks to cover the entire function, delimited
299 by lines that match the "funcname" pattern) used to show the entire
300 file when a change added an entire function at the end of the file,
301 which has been fixed.
303 * The documentation set has been updated so that literal commands,
304 configuration variables and environment variables are consistently
305 typeset in fixed-width font and bold in manpages.
307 * "git svn propset" subcommand that was added in 2.3 days is
308 documented now.
310 * The documentation tries to consistently spell "GPG"; when
311 referring to the specific program name, "gpg" is used.
313 * "git reflog" stopped upon seeing an entry that denotes a branch
314 creation event (aka "unborn"), which made it appear as if the
315 reflog was truncated.
317 * The git-prompt scriptlet (in contrib/) was not friendly with those
318 who uses "set -u", which has been fixed.
320 * compat/regex code did not cleanly compile.
322 * A codepath that used alloca(3) to place an unbounded amount of data
323 on the stack has been updated to avoid doing so.
325 * "git update-index --add --chmod=+x file" may be usable as an escape
326 hatch, but not a friendly thing to force for people who do need to
327 use it regularly. "git add --chmod=+x file" can be used instead.
329 * Build improvements for gnome-keyring (in contrib/)
331 * "git status" used to say "working directory" when it meant "working
332 tree".
334 * Comments about misbehaving FreeBSD shells have been clarified with
335 the version number (9.x and before are broken, newer ones are OK).
337 * "git cherry-pick A" worked on an unborn branch, but "git
338 cherry-pick A..B" didn't.
340 * Fix an unintended regression in v2.9 that breaks "clone --depth"
341 that recurses down to submodules by forcing the submodules to also
342 be cloned shallowly, which many server instances that host upstream
343 of the submodules are not prepared for.
345 * Fix unnecessarily waste in the idiomatic use of ': ${VAR=default}'
346 to set the default value, without enclosing it in double quotes.
348 * Some platform-specific code had non-ANSI strict declarations of C
349 functions that do not take any parameters, which has been
350 corrected.
352 * The internal code used to show local timezone offset is not
353 prepared to handle timestamps beyond year 2100, and gave a
354 bogus offset value to the caller. Use a more benign looking
355 +0000 instead and let "git log" going in such a case, instead
356 of aborting.
358 * One among four invocations of readlink(1) in our test suite has
359 been rewritten so that the test can run on systems without the
360 command (others are in valgrind test framework and t9802).
362 * t/perf needs /usr/bin/time with GNU extension; the invocation of it
363 is updated to "gtime" on Darwin.
365 * A bug, which caused "git p4" while running under verbose mode to
366 report paths that are omitted due to branch prefix incorrectly, has
367 been fixed; the command said "Ignoring file outside of prefix" for
368 paths that are _inside_.
370 * The top level documentation "git help git" still pointed at the
371 documentation set hosted at now-defunct google-code repository.
372 Update it to point to https://git.github.io/htmldocs/git.html
373 instead.
375 * A helper function that takes the contents of a commit object and
376 finds its subject line did not ignore leading blank lines, as is
377 commonly done by other codepaths. Make it ignore leading blank
378 lines to match.
380 * For a long time, we carried an in-code comment that said our
381 colored output would work only when we use fprintf/fputs on
382 Windows, which no longer is the case for the past few years.
384 * "gc.autoPackLimit" when set to 1 should not trigger a repacking
385 when there is only one pack, but the code counted poorly and did
386 so.
388 * Add a test to specify the desired behaviour that currently is not
389 available in "git rebase -Xsubtree=...".
391 * More mark-up updates to typeset strings that are expected to
392 literally typed by the end user in fixed-width font.
394 * "git commit --amend --allow-empty-message -S" for a commit without
395 any message body could have misidentified where the header of the
396 commit object ends.
398 * "git rebase -i --autostash" did not restore the auto-stashed change
399 when the operation was aborted.
401 * Git does not know what the contents in the index should be for a
402 path added with "git add -N" yet, so "git grep --cached" should not
403 show hits (or show lack of hits, with -L) in such a path, but that
404 logic does not apply to "git grep", i.e. searching in the working
405 tree files. But we did so by mistake, which has been corrected.
407 * "git blame -M" missed a single line that was moved within the file.
409 * Fix recently introduced codepaths that are involved in parallel
410 submodule operations, which gave up on reading too early, and
411 could have wasted CPU while attempting to write under a corner
412 case condition.
414 * "git grep -i" has been taught to fold case in non-ascii locales
415 correctly.
417 * A test that unconditionally used "mktemp" learned that the command
418 is not necessarily available everywhere.
420 * There are certain house-keeping tasks that need to be performed at
421 the very beginning of any Git program, and programs that are not
422 built-in commands had to do them exactly the same way as "git"
423 potty does. It was easy to make mistakes in one-off standalone
424 programs (like test helpers). A common "main()" function that
425 calls cmd_main() of individual program has been introduced to
426 make it harder to make mistakes.
427 (merge de61ceb jk/common-main later to maint).
429 * The test framework learned a new helper test_match_signal to
430 check an exit code from getting killed by an expected signal.
432 * General code clean-up around a helper function to write a
433 single-liner to a file.
434 (merge 7eb6e10 jk/write-file later to maint).
436 * One part of "git am" had an oddball helper function that called
437 stuff from outside "his" as opposed to calling what we have "ours",
438 which was not gender-neutral and also inconsistent with the rest of
439 the system where outside stuff is usuall called "theirs" in
440 contrast to "ours".
442 * "git blame file" allowed the lineage of lines in the uncommitted,
443 unadded contents of "file" to be inspected, but it refused when
444 "file" did not appear in the current commit. When "file" was
445 created by renaming an existing file (but the change has not been
446 committed), this restriction was unnecessarily tight.
448 * "git add -N dir/file && git write-tree" produced an incorrect tree
449 when there are other paths in the same directory that sorts after
450 "file".
452 * "git fetch http://user:pass@host/repo..." scrubbed the userinfo
453 part, but "git push" didn't.
455 * "git merge" with renormalization did not work well with
456 merge-recursive, due to "safer crlf" conversion kicking in when it
457 shouldn't.
458 (merge 1335d76 jc/renormalize-merge-kill-safer-crlf later to maint).
460 * The use of strbuf in "git rm" to build filename to remove was a bit
461 suboptimal, which has been fixed.
463 * An age old bug that caused "git diff --ignore-space-at-eol"
464 misbehave has been fixed.
466 * "git notes merge" had a code to see if a path exists (and fails if
467 it does) and then open the path for writing (when it doesn't).
468 Replace it with open with O_EXCL.
470 * "git pack-objects" and "git index-pack" mostly operate with off_t
471 when talking about the offset of objects in a packfile, but there
472 were a handful of places that used "unsigned long" to hold that
473 value, leading to an unintended truncation.
475 * Recent update to "git daemon" tries to enable the socket-level
476 KEEPALIVE, but when it is spawned via inetd, the standard input
477 file descriptor may not necessarily be connected to a socket.
478 Suppress an ENOTSOCK error from setsockopt().
480 * Recent FreeBSD stopped making perl available at /usr/bin/perl;
481 switch the default the built-in path to /usr/local/bin/perl on not
482 too ancient FreeBSD releases.
484 * "git commit --help" said "--no-verify" is only about skipping the
485 pre-commit hook, and failed to say that it also skipped the
486 commit-msg hook.
488 * "git merge" in Git v2.9 was taught to forbid merging an unrelated
489 lines of history by default, but that is exactly the kind of thing
490 the "--rejoin" mode of "git subtree" (in contrib/) wants to do.
491 "git subtree" has been taught to use the "--allow-unrelated-histories"
492 option to override the default.
494 * The build procedure for "git persistent-https" helper (in contrib/)
495 has been updated so that it can be built with more recent versions
496 of Go.
498 * There is an optimization used in "git diff $treeA $treeB" to borrow
499 an already checked-out copy in the working tree when it is known to
500 be the same as the blob being compared, expecting that open/mmap of
501 such a file is faster than reading it from the object store, which
502 involves inflating and applying delta. This however kicked in even
503 when the checked-out copy needs to go through the convert-to-git
504 conversion (including the clean filter), which defeats the whole
505 point of the optimization. The optimization has been disabled when
506 the conversion is necessary.
508 * "git -c grep.patternType=extended log --basic-regexp" misbehaved
509 because the internal API to access the grep machinery was not
510 designed well.
512 * Windows port was failing some tests in t4130, due to the lack of
513 inum in the returned values by its lstat(2) emulation.
515 * The reflog output format is documented better, and a new format
516 --date=unix to report the seconds-since-epoch (without timezone)
517 has been added.
518 (merge 442f6fd jk/reflog-date later to maint).
520 * "git difftool <paths>..." started in a subdirectory failed to
521 interpret the paths relative to that directory, which has been
522 fixed.
523 (merge 32b8c58 jk/difftool-in-subdir later to maint).
525 * The characters in the label shown for tags/refs for commits in
526 "gitweb" output are now properly escaped for proper HTML output.
528 * FreeBSD can lie when asked mtime of a directory, which made the
529 untracked cache code to fall back to a slow-path, which in turn
530 caused tests in t7063 to fail because it wanted to verify the
531 behaviour of the fast-path.
533 * Squelch compiler warnings for netmalloc (in compat/) library.
535 * A small memory leak in the command line parsing of "git blame"
536 has been plugged.
538 * The API documentation for hashmap was unclear if hashmap_entry
539 can be safely discarded without any other consideration. State
540 that it is safe to do so.
542 * Not-so-recent rewrite of "git am" that started making internal
543 calls into the commit machinery had an unintended regression, in
544 that no matter how many seconds it took to apply many patches, the
545 resulting committer timestamp for the resulting commits were all
546 the same.
547 (merge 4d9c7e6 jk/reset-ident-time-per-commit later to maint).
549 * "git push --force-with-lease" already had enough logic to allow
550 ensuring that such a push results in creation of a ref (i.e. the
551 receiving end did not have another push from sideways that would be
552 discarded by our force-pushing), but didn't expose this possibility
553 to the users. It does so now.
554 (merge 9eed4f3 jk/push-force-with-lease-creation later to maint).
556 * Other minor clean-ups and documentation updates