1Git 2.14 Release Notes 2====================== 3 4Backward compatibility notes and other notable changes. 5 6 * Use of an empty string as a pathspec element that is used for 7 'everything matches' is still warned and Git asks users to use a 8 more explicit '.' for that instead. The hope is that existing 9 users will not mind this change, and eventually the warning can be 10 turned into a hard error, upgrading the deprecation into removal of 11 this (mis)feature. That is not scheduled to happen in the upcoming 12 release (yet). 13 14 * Git now avoids blindly falling back to ".git" when the setup 15 sequence said we are _not_ in Git repository. A corner case that 16 happens to work right now may be broken by a call to die("BUG"). 17 We've tried hard to locate such cases and fixed them, but there 18 might still be cases that need to be addressed--bug reports are 19 greatly appreciated. 20 21 * The experiment to improve the hunk-boundary selection of textual 22 diff output has finished, and the "indent heuristics" has now 23 become the default. 24 25 * Git can now be built with PCRE v2 instead of v1 of the PCRE 26 library. Replace USE_LIBPCRE=YesPlease with USE_LIBPCRE2=YesPlease 27 in existing build scripts to build against the new version. As the 28 upstream PCRE maintainer has abandoned v1 maintenance for all but 29 the most critical bug fixes, use of v2 is recommended. 30 31 32Updates since v2.13 33------------------- 34 35UI, Workflows & Features 36 37 * The colors in which "git status --short --branch" showed the names 38 of the current branch and its remote-tracking branch are now 39 configurable. 40 41 * "git clone" learned the "--no-tags" option not to fetch all tags 42 initially, and also set up the tagopt not to follow any tags in 43 subsequent fetches. 44 45 * "git archive --format=zip" learned to use zip64 extension when 46 necessary to go beyond the 4GB limit. 47 48 * "git reset" learned "--recurse-submodules" option. 49 50 * "git diff --submodule=diff" now recurses into nested submodules. 51 52 * "git repack" learned to accept the --threads=<n> option and pass it 53 to pack-objects. 54 55 * "git send-email" learned to run sendemail-validate hook to inspect 56 and reject a message before sending it out. 57 58 * There is no good reason why "git fetch $there $sha1" should fail 59 when the $sha1 names an object at the tip of an advertised ref, 60 even when the other side hasn't enabled allowTipSHA1InWant. 61 62 * The "[includeIf "gitdir:$dir"] path=..." mechanism introduced in 63 2.13.0 would canonicalize the path of the gitdir being matched, 64 and did not match e.g. "gitdir:~/work/*" against a repo in 65 "~/work/main" if "~/work" was a symlink to "/mnt/storage/work". 66 Now we match both the resolved canonical path and what "pwd" would 67 show. The include will happen if either one matches. 68 69 * The "indent" heuristics is now the default in "diff". The 70 diff.indentHeuristic configuration variable can be set to "false" 71 for those who do not want it. 72 73 * Many commands learned to pay attention to submodule.recurse 74 configuration. 75 76 * The convention for a command line is to follow "git cmdname 77 --options" with revisions followed by an optional "--" 78 disambiguator and then finally pathspecs. When "--" is not there, 79 we make sure early ones are all interpretable as revs (and do not 80 look like paths) and later ones are the other way around. A 81 pathspec with "magic" (e.g. ":/p/a/t/h" that matches p/a/t/h from 82 the top-level of the working tree, no matter what subdirectory you 83 are working from) are conservatively judged as "not a path", which 84 required disambiguation more often. The command line parser 85 learned to say "it's a pathspec" a bit more often when the syntax 86 looks like so. 87 88 * Update "perl-compatible regular expression" support to enable JIT 89 and also allow linking with the newer PCRE v2 library. 90 91 * "filter-branch" learned a pseudo filter "--setup" that can be used 92 to define common functions/variables that can be used by other 93 filters. 94 95 * Using "git add d/i/r" when d/i/r is the top of the working tree of 96 a separate repository would create a gitlink in the index, which 97 would appear as a not-quite-initialized submodule to others. We 98 learned to give warnings when this happens. 99 100 * "git status" learned to optionally give how many stash entries there 101 are in its output. 102 103 * "git status" has long shown essentially the same message as "git 104 commit"; the message it gives while preparing for the root commit, 105 i.e. "Initial commit", was hard to understand for some new users. 106 Now it says "No commits yet" to stress more on the current status 107 (rather than the commit the user is preparing for, which is more in 108 line with the focus of "git commit"). 109 110 * "git send-email" now has --batch-size and --relogin-delay options 111 which can be used to overcome limitations on SMTP servers that 112 restrict on how many of e-mails can be sent in a single session. 113 114 * An old message shown in the commit log template was removed, as it 115 has outlived its usefulness. 116 117 * "git pull --rebase --recurse-submodules" learns to rebase the 118 branch in the submodules to an updated base. 119 120 121Performance, Internal Implementation, Development Support etc. 122 123 * The default packed-git limit value has been raised on larger 124 platforms to save "git fetch" from a (recoverable) failure while 125 "gc" is running in parallel. 126 127 * Code to update the cache-tree has been tightened so that we won't 128 accidentally write out any 0{40} entry in the tree object. 129 130 * Attempt to allow us notice "fishy" situation where we fail to 131 remove the temporary directory used during the test. 132 133 * Travis CI gained a task to format the documentation with both 134 AsciiDoc and AsciiDoctor. 135 136 * Some platforms have ulong that is smaller than time_t, and our 137 historical use of ulong for timestamp would mean they cannot 138 represent some timestamp that the platform allows. Invent a 139 separate and dedicated timestamp_t (so that we can distingiuish 140 timestamps and a vanilla ulongs, which along is already a good 141 move), and then declare uintmax_t is the type to be used as the 142 timestamp_t. 143 144 * We can trigger Windows auto-build tester (credits: Dscho & 145 Microsoft) from our existing Travis CI tester now. 146 147 * Conversion from uchar[20] to struct object_id continues. 148 149 * Simplify parse_pathspec() codepath and stop it from looking at the 150 default in-core index. 151 152 * Add perf-test for wildmatch. 153 154 * Code from "conversion using external process" codepath has been 155 extracted to a separate sub-process.[ch] module. 156 157 * When "git checkout", "git merge", etc. manipulates the in-core 158 index, various pieces of information in the index extensions are 159 discarded from the original state, as it is usually not the case 160 that they are kept up-to-date and in-sync with the operation on the 161 main index. The untracked cache extension is copied across these 162 operations now, which would speed up "git status" (as long as the 163 cache is properly invalidated). 164 165 * The internal implementation of "git grep" has seen some clean-up. 166 167 * Update the C style recommendation for notes for translators, as 168 recent versions of gettext tools can work with our style of 169 multi-line comments. 170 171 * The implementation of "ref" API around the "packed refs" have been 172 cleaned up, in preparation for further changes. 173 174 * The internal logic used in "git blame" has been libified to make it 175 easier to use by cgit. 176 177 * Our code often opens a path to an optional file, to work on its 178 contents when we can successfully open it. We can ignore a failure 179 to open if such an optional file does not exist, but we do want to 180 report a failure in opening for other reasons (e.g. we got an I/O 181 error, or the file is there, but we lack the permission to open). 182 183 The exact errors we need to ignore are ENOENT (obviously) and 184 ENOTDIR (less obvious). Instead of repeating comparison of errno 185 with these two constants, introduce a helper function to do so. 186 187 * We often try to open a file for reading whose existence is 188 optional, and silently ignore errors from open/fopen; report such 189 errors if they are not due to missing files. 190 191 * When an existing repository is used for t/perf testing, we first 192 create bit-for-bit copy of it, which may grab a transient state of 193 the repository and freeze it into the repository used for testing, 194 which then may cause Git operations to fail. Single out "the index 195 being locked" case and forcibly drop the lock from the copy. 196 197 * Three instances of the same helper function have been consolidated 198 to one. 199 200 * "fast-import" uses a default pack chain depth that is consistent 201 with other parts of the system. 202 203 * A new test to show the interaction between the pattern [^a-z] 204 (which matches '/') and a slash in a path has been added. The 205 pattern should not match the slash with "pathmatch", but should 206 with "wildmatch". 207 208 * The 'diff-highlight' program (in contrib/) has been restructured 209 for easier reuse by an external project 'diff-so-fancy'. 210 211 * A common pattern to free a piece of memory and assign NULL to the 212 pointer that used to point at it has been replaced with a new 213 FREE_AND_NULL() macro. 214 215 * Traditionally, the default die() routine had a code to prevent it 216 from getting called multiple times, which interacted badly when a 217 threaded program used it (one downside is that the real error may 218 be hidden and instead the only error message given to the user may 219 end up being "die recursion detected", which is not very useful). 220 221 * Introduce a "repository" object to eventually make it easier to 222 work in multiple repositories (the primary focus is to work with 223 the superproject and its submodules) in a single process. 224 225 * Optimize "what are the object names already taken in an alternate 226 object database?" query that is used to derive the length of prefix 227 an object name is uniquely abbreviated to. 228 229 * The hashmap API has been updated so that data to customize the 230 behaviour of the comparison function can be specified at the time a 231 hashmap is initialized. 232 233 234Also contains various documentation updates and code clean-ups. 235 236 237Fixes since v2.13 238----------------- 239 240Unless otherwise noted, all the fixes since v2.13 in the maintenance 241track are contained in this release (see the maintenance releases' 242notes for details). 243 244 * "git gc" did not interact well with "git worktree"-managed 245 per-worktree refs. 246 247 * "git cherry-pick" and other uses of the sequencer machinery 248 mishandled a trailer block whose last line is an incomplete line. 249 This has been fixed so that an additional sign-off etc. are added 250 after completing the existing incomplete line. 251 252 * The codepath in "git am" that is used when running "git rebase" 253 leaked memory held for the log message of the commits being rebased. 254 255 * "git clone --config var=val" is a way to populate the 256 per-repository configuration file of the new repository, but it did 257 not work well when val is an empty string. This has been fixed. 258 259 * Setting "log.decorate=false" in the configuration file did not take 260 effect in v2.13, which has been corrected. 261 262 * A few codepaths in "checkout" and "am" working on an unborn branch 263 tried to access an uninitialized piece of memory. 264 265 * The Web interface to gmane news archive is long gone, even though 266 the articles are still accessible via NTTP. Replace the links with 267 ones to public-inbox.org. Because their message identification is 268 based on the actual message-id, it is likely that it will be easier 269 to migrate away from it if/when necessary. 270 271 * The receive-pack program now makes sure that the push certificate 272 records the same set of push options used for pushing. 273 274 * Tests have been updated to pass under GETTEXT_POISON (a mechanism 275 to ensure that output strings that should not be translated are 276 not translated by mistake), and TravisCI is told to run them. 277 278 * "git checkout --recurse-submodules" did not quite work with a 279 submodule that itself has submodules. 280 281 * "pack-objects" can stream a slice of an existing packfile out when 282 the pack bitmap can tell that the reachable objects are all needed 283 in the output, without inspecting individual objects. This 284 strategy however would not work well when "--local" and other 285 options are in use, and need to be disabled. 286 287 * Fix memory leaks pointed out by Coverity (and people). 288 289 * "git read-tree -m" (no tree-ish) gave a nonsense suggestion "use 290 --empty if you want to clear the index". With "-m", such a request 291 will still fail anyway, as you'd need to name at least one tree-ish 292 to be merged. 293 294 * Make sure our tests would pass when the sources are checked out 295 with "platform native" line ending convention by default on 296 Windows. Some "text" files out tests use and the test scripts 297 themselves that are meant to be run with /bin/sh, ought to be 298 checked out with eol=LF even on Windows. 299 300 * Introduce the BUG() macro to improve die("BUG: ..."). 301 302 * Clarify documentation for include.path and includeIf.<condition>.path 303 configuration variables. 304 305 * Git sometimes gives an advice in a rhetorical question that does 306 not require an answer, which can confuse new users and non native 307 speakers. Attempt to rephrase them. 308 309 * A few http:// links that are redirected to https:// in the 310 documentation have been updated to https:// links. 311 312 * "git for-each-ref --format=..." with %(HEAD) in the format used to 313 resolve the HEAD symref as many times as it had processed refs, 314 which was wasteful, and "git branch" shared the same problem. 315 316 * Regression fix to topic recently merged to 'master'. 317 318 * The shell completion script (in contrib/) learned "git stash" has 319 a new "push" subcommand. 320 321 * "git interpret-trailers", when used as GIT_EDITOR for "git commit 322 -v", looked for and appended to a trailer block at the very end, 323 i.e. at the end of the "diff" output. The command has been 324 corrected to pay attention to the cut-mark line "commit -v" adds to 325 the buffer---the real trailer block should appear just before it. 326 327 * A test allowed both "git push" and "git receive-pack" on the other 328 end write their traces into the same file. This is OK on platforms 329 that allows atomically appending to a file opened with O_APPEND, 330 but on other platforms led to a mangled output, causing 331 intermittent test failures. This has been fixed by disabling 332 traces from "receive-pack" in the test. 333 334 * Tag objects, which are not reachable from any ref, that point at 335 missing objects were mishandled by "git gc" and friends (they 336 should silently be ignored instead) 337 338 * "git describe --contains" penalized light-weight tags so much that 339 they were almost never considered. Instead, give them about the 340 same chance to be considered as an annotated tag that is the same 341 age as the underlying commit would. 342 343 * The "run-command" API implementation has been made more robust 344 against dead-locking in a threaded environment. 345 346 * A recent update to t5545-push-options.sh started skipping all the 347 tests in the script when a web server testing is disabled or 348 unavailable, not just the ones that require a web server. Non HTTP 349 tests have been salvaged to always run in this script. 350 351 * "git send-email" now uses Net::SMTP::SSL, which is obsolete, only 352 when needed. Recent versions of Net::SMTP can do TLS natively. 353 354 * "foo\bar\baz" in "git fetch foo\bar\baz", even though there is no 355 slashes in it, cannot be a nickname for a remote on Windows, as 356 that is likely to be a pathname on a local filesystem. 357 358 * "git clean -d" used to clean directories that has ignored files, 359 even though the command should not lose ignored ones without "-x". 360 "git status --ignored" did not list ignored and untracked files 361 without "-uall". These have been corrected. 362 363 * The result from "git diff" that compares two blobs, e.g. "git diff 364 $commit1:$path $commit2:$path", used to be shown with the full 365 object name as given on the command line, but it is more natural to 366 use the $path in the output and use it to look up .gitattributes. 367 368 * The "collision detecting" SHA-1 implementation shipped with 2.13 369 was quite broken on some big-endian platforms and/or platforms that 370 do not like unaligned fetches. Update to the upstream code which 371 has already fixed these issues. 372 373 * "git am -h" triggered a BUG(). 374 375 * The interaction of "url.*.insteadOf" and custom URL scheme's 376 whitelisting is now documented better. 377 378 * The timestamp of the index file is now taken after the file is 379 closed, to help Windows, on which a stale timestamp is reported by 380 fstat() on a file that is opened for writing and data was written 381 but not yet closed. 382 383 * "git pull --rebase --autostash" didn't auto-stash when the local history 384 fast-forwards to the upstream. 385 386 * A flaky test has been corrected. 387 388 * "git $cmd -h" for builtin commands calls the implementation of the 389 command (i.e. cmd_$cmd() function) without doing any repository 390 set-up, and the commands that expect RUN_SETUP is done by the Git 391 potty needs to be prepared to show the help text without barfing. 392 (merge d691551192 jk/consistent-h later to maint). 393 394 * Help contributors that visit us at GitHub. 395 396 * "git stash push <pathspec>" did not work from a subdirectory at all. 397 Bugfix for a topic in v2.13 398 399 * As there is no portable way to pass timezone information to 400 strftime, some output format from "git log" and friends are 401 impossible to produce. Teach our own strbuf_addftime to replace %z 402 and %Z with caller-supplied values to help working around this. 403 (merge 6eced3ec5e rs/strbuf-addftime-zZ later to maint). 404 405 * "git mergetool" learned to work around a wrapper MacOS X adds 406 around underlying meld. 407 408 * An example in documentation that does not work in multi worktree 409 configuration has been corrected. 410 411 * The pretty-format specifiers like '%h', '%t', etc. had an 412 optimization that no longer works correctly. In preparation/hope 413 of getting it correctly implemented, first discard the optimization 414 that is broken. 415 416 * The code to pick up and execute command alias definition from the 417 configuration used to switch to the top of the working tree and 418 then come back when the expanded alias was executed, which was 419 unnecessarilyl complex. Attempt to simplify the logic by using the 420 early-config mechanism that does not chdir around. 421 422 * Fix configuration codepath to pay proper attention to commondir 423 that is used in multi-worktree situation, and isolate config API 424 into its own header file. 425 (merge dc8441fdb4 bw/config-h later to maint). 426 427 * "git add -p" were updated in 2.12 timeframe to cope with custom 428 core.commentchar but the implementation was buggy and a 429 metacharacter like $ and * did not work. 430 431 * A recent regression in "git rebase -i" has been fixed and tests 432 that would have caught it and others have been added. 433 434 * An unaligned 32-bit access in pack-bitmap code has been corrected. 435 436 * Tighten error checks for invalid "git apply" input. 437 438 * The split index code did not honor core.sharedRepository setting 439 correctly. 440 441 * The Makefile rule in contrib/subtree for building documentation 442 learned to honour USE_ASCIIDOCTOR just like the main documentation 443 set does. 444 445 * Code clean-up to fix possible buffer over-reading. 446 (merge 2d105451c0 rs/apply-avoid-over-reading later to maint). 447 448 * A few tests that tried to verify the contents of push certificates 449 did not use 'git rev-parse' to formulate the line to look for in 450 the certificate correctly. 451 452 * Update the character width tables. 453 (merge 7560aacd7c bb/unicode-10.0 later to maint). 454 455 * After "git branch --move" of the currently checked out branch, the 456 code to walk the reflog of HEAD via "log -g" and friends 457 incorrectly stopped at the reflog entry that records the renaming 458 of the branch. 459 460 * The rewrite of "git branch --list" using for-each-ref's internals 461 that happened in v2.13 regressed its handling of color.branch.local; 462 this has been fixed. 463 464 * The build procedure has been improved to allow building and testing 465 Git with address sanitizer more easily. 466 (merge 566cf0b3bd jk/build-with-asan later to maint). 467 468 * On Cygwin, similar to Windows, "git push //server/share/repository" 469 ought to mean a repository on a network share that can be accessed 470 locally, but this did not work correctly due to stripping the double 471 slashes at the beginning. 472 (merge 496f256989 tb/push-to-cygwin-unc-path later to maint). 473 474 * The progress meter did not give a useful output when we haven't had 475 0.5 seconds to measure the throughput during the interval. Instead 476 show the overall throughput rate at the end, which is a much more 477 useful number. 478 (merge 0fae1e072a rs/progress-overall-throughput-at-the-end later to maint). 479 480 * Code clean-up, that makes us in sync with Debian by one patch. 481 (merge 8db1ae5740 jn/hooks-pre-rebase-sample-fix later to maint). 482 483 * We run an early part of "git gc" that deals with refs before 484 daemonising (and not under lock) even when running a background 485 auto-gc, which caused multiple gc processes attempting to run the 486 early part at the same time. This is now prevented by running the 487 early part also under the GC lock. 488 (merge c45af94dbc jk/gc-pre-detach-under-hook later to maint). 489 490 * Other minor doc, test and build updates and code cleanups. 491 (merge 3f9c637ec7 pw/unquote-path-in-git-pm later to maint). 492 (merge 5053313562 rs/urlmatch-cleanup later to maint). 493 (merge 42c78a216e rs/use-div-round-up later to maint). 494 (merge 5e8d2729ae rs/wt-status-cleanup later to maint). 495 (merge 01826066b0 ks/fix-rebase-doc-picture later to maint).