Documentation / RelNotes / 2.15.0.txton commit Merge branch 'master' of git://github.com/alshopov/git-po (a0c76f2)
   1Git 2.15 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 now scheduled to happen in Git v2.16,
  12   the next major release after this one.
  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 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 * "branch --set-upstream" that has been deprecated in Git 1.8 has
  22   finally been retired.
  23
  24
  25Updates since v2.14
  26-------------------
  27
  28UI, Workflows & Features
  29
  30 * An example that is now obsolete has been removed from a sample hook,
  31   and an old example in it that added a sign-off manually has been
  32   improved to use the interpret-trailers command.
  33
  34 * The advice message given when "git rebase" stops for conflicting
  35   changes has been improved.
  36
  37 * The "rerere-train" script (in contrib/) learned the "--overwrite"
  38   option to allow overwriting existing recorded resolutions.
  39
  40 * "git contacts" (in contrib/) now lists the address on the
  41   "Reported-by:" trailer to its output, in addition to those on
  42   S-o-b: and other trailers, to make it easier to notify (and thank)
  43   the original bug reporter.
  44
  45 * "git rebase", especially when it is run by mistake and ends up
  46   trying to replay many changes, spent long time in silence.  The
  47   command has been taught to show progress report when it spends
  48   long time preparing these many changes to replay (which would give
  49   the user a chance to abort with ^C).
  50
  51 * "git merge" learned a "--signoff" option to add the Signed-off-by:
  52   trailer with the committer's name.
  53
  54 * "git diff" learned to optionally paint new lines that are the same
  55   as deleted lines elsewhere differently from genuinely new lines.
  56
  57 * "git interpret-trailers" learned to take the trailer specifications
  58   from the command line that overrides the configured values.
  59
  60 * "git interpret-trailers" has been taught a "--parse" and a few
  61   other options to make it easier for scripts to grab existing
  62   trailer lines from a commit log message.
  63
  64 * The "--format=%(trailers)" option "git log" and its friends take
  65   learned to take the 'unfold' and 'only' modifiers to normalize its
  66   output, e.g. "git log --format=%(trailers:only,unfold)".
  67
  68 * "gitweb" shows a link to visit the 'raw' contents of blbos in the
  69   history overview page.
  70
  71 * "[gc] rerereResolved = 5.days" used to be invalid, as the variable
  72   is defined to take an integer counting the number of days.  It now
  73   is allowed.
  74
  75 * The code to acquire a lock on a reference (e.g. while accepting a
  76   push from a client) used to immediately fail when the reference is
  77   already locked---now it waits for a very short while and retries,
  78   which can make it succeed if the lock holder was holding it during
  79   a read-only operation.
  80
  81 * "branch --set-upstream" that has been deprecated in Git 1.8 has
  82   finally been retired.
  83
  84 * The codepath to call external process filter for smudge/clean
  85   operation learned to show the progress meter.
  86
  87 * "git rev-parse" learned "--is-shallow-repository", that is to be
  88   used in a way similar to existing "--is-bare-repository" and
  89   friends.
  90
  91 * "git describe --match <pattern>" has been taught to play well with
  92   the "--all" option.
  93
  94 * "git branch" learned "-c/-C" to create a new branch by copying an
  95   existing one.
  96
  97 * Some commands (most notably "git status") makes an opportunistic
  98   update when performing a read-only operation to help optimize later
  99   operations in the same repository.  The new "--no-optional-locks"
 100   option can be passed to Git to disable them.
 101
 102
 103Performance, Internal Implementation, Development Support etc.
 104
 105 * Conversion from uchar[20] to struct object_id continues.
 106
 107 * Start using selected c99 constructs in small, stable and
 108   essentialpart of the system to catch people who care about
 109   older compilers that do not grok them.
 110
 111 * The filter-process interface learned to allow a process with long
 112   latency give a "delayed" response.
 113
 114 * Many uses of comparision callback function the hashmap API uses
 115   cast the callback function type when registering it to
 116   hashmap_init(), which defeats the compile time type checking when
 117   the callback interface changes (e.g. gaining more parameters).
 118   The callback implementations have been updated to take "void *"
 119   pointers and cast them to the type they expect instead.
 120
 121 * Because recent Git for Windows do come with a real msgfmt, the
 122   build procedure for git-gui has been updated to use it instead of a
 123   hand-rolled substitute.
 124
 125 * "git grep --recurse-submodules" has been reworked to give a more
 126   consistent output across submodule boundary (and do its thing
 127   without having to fork a separate process).
 128
 129 * A helper function to read a single whole line into strbuf
 130   mistakenly triggered OOM error at EOF under certain conditions,
 131   which has been fixed.
 132   (merge 642956cf45 rs/strbuf-getwholeline-fix later to maint).
 133
 134 * The "ref-store" code reorganization continues.
 135
 136 * "git commit" used to discard the index and re-read from the filesystem
 137   just in case the pre-commit hook has updated it in the middle; this
 138   has been optimized out when we know we do not run the pre-commit hook.
 139   (merge 680ee550d7 kw/commit-keep-index-when-pre-commit-is-not-run later to maint).
 140
 141 * Updates to the HTTP layer we made recently unconditionally used
 142   features of libCurl without checking the existence of them, causing
 143   compilation errors, which has been fixed.  Also migrate the code to
 144   check feature macros, not version numbers, to cope better with
 145   libCurl that vendor ships with backported features.
 146
 147 * The API to start showing progress meter after a short delay has
 148   been simplified.
 149   (merge 8aade107dd jc/simplify-progress later to maint).
 150
 151 * Code clean-up to avoid mixing values read from the .gitmodules file
 152   and values read from the .git/config file.
 153
 154 * We used to spend more than necessary cycles allocating and freeing
 155   piece of memory while writing each index entry out.  This has been
 156   optimized.
 157
 158 * Platforms that ship with a separate sha1 with collision detection
 159   library can link to it instead of using the copy we ship as part of
 160   our source tree.
 161
 162 * Code around "notes" have been cleaned up.
 163   (merge 3964281524 mh/notes-cleanup later to maint).
 164
 165 * The long-standing rule that an in-core lockfile instance, once it
 166   is used, must not be freed, has been lifted and the lockfile and
 167   tempfile APIs have been updated to reduce the chance of programming
 168   errors.
 169
 170 * Our hashmap implementation in hashmap.[ch] is not thread-safe when
 171   adding a new item needs to expand the hashtable by rehashing; add
 172   an API to disable the automatic rehashing to work it around.
 173
 174 * Many of our programs consider that it is OK to release dynamic
 175   storage that is used throughout the life of the program by simply
 176   exiting, but this makes it harder to leak detection tools to avoid
 177   reporting false positives.  Plug many existing leaks and introduce
 178   a mechanism for developers to mark that the region of memory
 179   pointed by a pointer is not lost/leaking to help these tools.
 180
 181 * As "git commit" to conclude a conflicted "git merge" honors the
 182   commit-msg hook, "git merge" that records a merge commit that
 183   cleanly auto-merges should, but it didn't.
 184
 185 * The codepath for "git merge-recursive" has been cleaned up.
 186
 187 * Many leaks of strbuf have been fixed.
 188
 189 * "git imap-send" has our own implementation of the protocol and also
 190   can use more recent libCurl with the imap protocol support.  Update
 191   the latter so that it can use the credential subsystem, and then
 192   make it the default option to use, so that we can eventually
 193   deprecate and remove the former.
 194
 195 * "make style" runs git-clang-format to help developers by pointing
 196   out coding style issues.
 197
 198 * A test to demonstrate "git mv" failing to adjust nested submodules
 199   has been added.
 200   (merge c514167df2 hv/mv-nested-submodules-test later to maint).
 201
 202 * On Cygwin, "ulimit -s" does not report failure but it does not work
 203   at all, which causes an unexpected success of some tests that
 204   expect failures under a limited stack situation.  This has been
 205   fixed.
 206
 207 * Many codepaths have been updated to squelch -Wimplicit-fallthrough
 208   warnings from Gcc 7 (which is a good code hygiene).
 209
 210 * Add a helper for DLL loading in anticipation for its need in a
 211   future topic RSN.
 212
 213 * "git status --ignored", when noticing that a directory without any
 214   tracked path is ignored, still enumerated all the ignored paths in
 215   the directory, which is unnecessary.  The codepath has been
 216   optimized to avoid this overhead.
 217
 218 * The final batch to "git rebase -i" updates to move more code from
 219   the shell script to C has been merged.
 220
 221 * Operations that do not touch (majority of) packed refs have been
 222   optimized by making accesses to packed-refs file lazy; we no longer
 223   pre-parse everything, and an access to a single ref in the
 224   packed-refs does not touch majority of irrelevant refs, either.
 225
 226 * Add comment to clarify that the style file is meant to be used with
 227   clang-5 and the rules are still work in progress.
 228
 229 * Many variables that points at a region of memory that will live
 230   throughout the life of the program have been marked with UNLEAK
 231   marker to help the leak checkers concentrate on real leaks..
 232
 233
 234Also contains various documentation updates and code clean-ups.
 235
 236
 237Fixes since v2.14
 238-----------------
 239
 240 * "%C(color name)" in the pretty print format always produced ANSI
 241   color escape codes, which was an early design mistake.  They now
 242   honor the configuration (e.g. "color.ui = never") and also tty-ness
 243   of the output medium.
 244
 245 * The http.{sslkey,sslCert} configuration variables are to be
 246   interpreted as a pathname that honors "~[username]/" prefix, but
 247   weren't, which has been fixed.
 248
 249 * Numerous bugs in walking of reflogs via "log -g" and friends have
 250   been fixed.
 251
 252 * "git commit" when seeing an totally empty message said "you did not
 253   edit the message", which is clearly wrong.  The message has been
 254   corrected.
 255
 256 * When a directory is not readable, "gitweb" fails to build the
 257   project list.  Work this around by skipping such a directory.
 258
 259 * Some versions of GnuPG fails to kill gpg-agent it auto-spawned
 260   and such a left-over agent can interfere with a test.  Work it
 261   around by attempting to kill one before starting a new test.
 262
 263 * A recently added test for the "credential-cache" helper revealed
 264   that EOF detection done around the time the connection to the cache
 265   daemon is torn down were flaky.  This was fixed by reacting to
 266   ECONNRESET and behaving as if we got an EOF.
 267
 268 * "git log --tag=no-such-tag" showed log starting from HEAD, which
 269   has been fixed---it now shows nothing.
 270
 271 * The "tag.pager" configuration variable was useless for those who
 272   actually create tag objects, as it interfered with the use of an
 273   editor.  A new mechanism has been introduced for commands to enable
 274   pager depending on what operation is being carried out to fix this,
 275   and then "git tag -l" is made to run pager by default.
 276
 277 * "git push --recurse-submodules $there HEAD:$target" was not
 278   propagated down to the submodules, but now it is.
 279
 280 * Commands like "git rebase" accepted the --rerere-autoupdate option
 281   from the command line, but did not always use it.  This has been
 282   fixed.
 283
 284 * "git clone --recurse-submodules --quiet" did not pass the quiet
 285   option down to submodules.
 286
 287 * Test portability fix for OBSD.
 288
 289 * Portability fix for OBSD.
 290
 291 * "git am -s" has been taught that some input may end with a trailer
 292   block that is not Signed-off-by: and it should refrain from adding
 293   an extra blank line before adding a new sign-off in such a case.
 294
 295 * "git svn" used with "--localtime" option did not compute the tz
 296   offset for the timestamp in question and instead always used the
 297   current time, which has been corrected.
 298
 299 * Memory leak in an error codepath has been plugged.
 300
 301 * "git stash -u" used the contents of the committed version of the
 302   ".gitignore" file to decide which paths are ignored, even when the
 303   file has local changes.  The command has been taught to instead use
 304   the locally modified contents.
 305
 306 * bash 4.4 or newer gave a warning on NUL byte in command
 307   substitution done in "git stash"; this has been squelched.
 308
 309 * "git grep -L" and "git grep --quiet -L" reported different exit
 310   codes; this has been corrected.
 311
 312 * When handshake with a subprocess filter notices that the process
 313   asked for an unknown capability, Git did not report what program
 314   the offending subprocess was running.  This has been corrected.
 315
 316 * "git apply" that is used as a better "patch -p1" failed to apply a
 317   taken from a file with CRLF line endings to a file with CRLF line
 318   endings.  The root cause was because it misused convert_to_git()
 319   that tried to do "safe-crlf" processing by looking at the index
 320   entry at the same path, which is a nonsense---in that mode, "apply"
 321   is not working on the data in (or derived from) the index at all.
 322   This has been fixed.
 323
 324 * Killing "git merge --edit" before the editor returns control left
 325   the repository in a state with MERGE_MSG but without MERGE_HEAD,
 326   which incorrectly tells the subsequent "git commit" that there was
 327   a squash merge in progress.  This has been fixed.
 328
 329 * "git archive" did not work well with pathspecs and the
 330   export-ignore attribute.
 331
 332 * In addition to "cc: <a@dd.re.ss> # cruft", "cc: a@dd.re.ss # cruft"
 333   was taught to "git send-email" as a valid way to tell it that it
 334   needs to also send a carbon copy to <a@dd.re.ss> in the trailer
 335   section.
 336   (merge cc90750677 mm/send-email-cc-cruft later to maint).
 337
 338 * "git branch -M a b" while on a branch that is completely unrelated
 339   to either branch a or branch b misbehaved when multiple worktree
 340   was in use.  This has been fixed.
 341   (merge 31824d180d nd/worktree-kill-parse-ref later to maint).
 342
 343 * "git gc" and friends when multiple worktrees are used off of a
 344   single repository did not consider the index and per-worktree refs
 345   of other worktrees as the root for reachability traversal, making
 346   objects that are in use only in other worktrees to be subject to
 347   garbage collection.
 348
 349 * A regression to "gitk --bisect" by a recent update has been fixed.
 350   (merge 1d0538e486 mh/packed-ref-store-prep later to maint).
 351
 352 * "git -c submodule.recurse=yes pull" did not work as if the
 353   "--recurse-submodules" option was given from the command line.
 354   This has been corrected.
 355
 356 * Unlike "git commit-tree < file", "git commit-tree -F file" did not
 357   pass the contents of the file verbatim and instead completed an
 358   incomplete line at the end, if exists.  The latter has been updated
 359   to match the behaviour of the former.
 360   (merge c818e74332 rk/commit-tree-make-F-verbatim later to maint).
 361
 362 * Many codepaths did not diagnose write failures correctly when disks
 363   go full, due to their misuse of write_in_full() helper function,
 364   which have been corrected.
 365   (merge f48ecd38cb jk/write-in-full-fix later to maint).
 366
 367 * "git help co" now says "co is aliased to ...", not "git co is".
 368   (merge b3a8076e0d ks/help-alias-label later to maint).
 369
 370 * "git archive", especially when used with pathspec, stored an empty
 371   directory in its output, even though Git itself never does so.
 372   This has been fixed.
 373   (merge 4318094047 rs/archive-excluded-directory later to maint).
 374
 375 * API error-proofing which happens to also squelch warnings from GCC.
 376   (merge c788c54cde tg/refs-allowed-flags later to maint).
 377
 378 * The explanation of the cut-line in the commit log editor has been
 379   slightly tweaked.
 380   (merge 8c4b1a3593 ks/commit-do-not-touch-cut-line later to maint).
 381
 382 * "git gc" tries to avoid running two instances at the same time by
 383   reading and writing pid/host from and to a lock file; it used to
 384   use an incorrect fscanf() format when reading, which has been
 385   corrected.
 386   (merge afe2fab72c aw/gc-lockfile-fscanf-fix later to maint).
 387
 388 * The scripts to drive TravisCI has been reorganized and then an
 389   optimization to avoid spending cycles on a branch whose tip is
 390   tagged has been implemented.
 391   (merge 8376eb4a8f ls/travis-scriptify later to maint).
 392
 393 * The test linter has been taught that we do not like "echo -e".
 394   (merge 1a6d46895d tb/test-lint-echo-e later to maint).
 395
 396 * Code cmp.std.c nitpick.
 397   (merge ac7da78ede mh/for-each-string-list-item-empty-fix later to maint).
 398
 399 * A regression fix for 2.11 that made the code to read the list of
 400   alternate object stores overrun the end of the string.
 401   (merge f0f7bebef7 jk/info-alternates-fix later to maint).
 402
 403 * "git describe --match" learned to take multiple patterns in v2.13
 404   series, but the feature ignored the patterns after the first one
 405   and did not work at all.  This has been fixed.
 406   (merge da769d2986 jk/describe-omit-some-refs later to maint).
 407
 408 * "git filter-branch" cannot reproduce a history with a tag without
 409   the tagger field, which only ancient versions of Git allowed to be
 410   created.  This has been corrected.
 411   (merge b2c1ca6b4b ic/fix-filter-branch-to-handle-tag-without-tagger later to maint).
 412
 413 * "git cat-file --textconv" started segfaulting recently, which
 414   has been corrected.
 415   (merge cc0ea7c9e5 jk/diff-blob later to maint).
 416
 417 * The built-in pattern to detect the "function header" for HTML did
 418   not match <H1>..<H6> elements without any attributes, which has
 419   been fixed.
 420   (merge 9c03caca2c ik/userdiff-html-h-element-fix later to maint).
 421
 422 * "git mailinfo" was loose in decoding quoted printable and produced
 423   garbage when the two letters after the equal sign are not
 424   hexadecimal.  This has been fixed.
 425   (merge c8cf423eab rs/mailinfo-qp-decode-fix later to maint).
 426
 427 * The machinery to create xdelta used in pack files received the
 428   sizes of the data in size_t, but lost the higher bits of them by
 429   storing them in "unsigned int" during the computation, which is
 430   fixed.
 431
 432 * The delta format used in the packfile cannot reference data at
 433   offset larger than what can be expressed in 4-byte, but the
 434   generator for the data failed to make sure the offset does not
 435   overflow.  This has been corrected.
 436
 437 * The documentation for '-X<option>' for merges was misleadingly
 438   written to suggest that "-s theirs" exists, which is not the case.
 439   (merge c25d98b2a7 jc/merge-x-theirs-docfix later to maint).
 440
 441 * "git fast-export" with -M/-C option issued "copy" instruction on a
 442   path that is simultaneously modified, which was incorrect.
 443   (merge b3e8ca89cf jt/fast-export-copy-modify-fix later to maint).
 444
 445 * Many codepaths have been updated to squelch -Wsign-compare
 446   warnings.
 447   (merge 071bcaab64 rj/no-sign-compare later to maint).
 448
 449 * Memory leaks in various codepaths have been plugged.
 450   (merge 4d01a7fa65 ma/leakplugs later to maint).
 451
 452 * Recent versions of "git rev-parse --parseopt" did not parse the
 453   option specification that does not have the optional flags (*=?!)
 454   correctly, which has been corrected.
 455   (merge a6304fa4c2 bc/rev-parse-parseopt-fix later to maint).
 456
 457 * The checkpoint command "git fast-import" did not flush updates to
 458   refs and marks unless at least one object was created since the
 459   last checkpoint, which has been corrected, as these things can
 460   happen without any new object getting created.
 461   (merge 30e215a65c er/fast-import-dump-refs-on-checkpoint later to maint).
 462
 463 * Spell the name of our system as "Git" in the output from
 464   request-pull script.
 465   (merge e66d7c37a5 ar/request-pull-phrasofix later to maint).
 466
 467 * Fixes for a handful memory access issues identified by valgrind.
 468   (merge 2944a94c6b tg/memfixes later to maint).
 469
 470 * Backports a moral equivalent of 2015 fix to the poll() emulation
 471   from the upstream gnulib to fix occasional breakages on HPE NonStop.
 472   (merge 61b2a1acaa rb/compat-poll-fix later to maint).
 473
 474 * Users with "color.ui = always" in their configuration were broken
 475   by a recent change that made plumbing commands to pay attention to
 476   them as the patch created internally by "git add -p" were colored
 477   (heh) and made unusable.  Fix this regression by redefining
 478   'always' to mean the same thing as 'auto'.
 479   (merge 6be4595edb jk/ui-color-always-to-auto-maint later to maint).
 480
 481 * In the "--format=..." option of the "git for-each-ref" command (and
 482   its friends, i.e. the listing mode of "git branch/tag"), "%(atom:)"
 483   (e.g. "%(refname:)", "%(body:)" used to error out.  Instead, treat
 484   them as if the colon and an empty string that follows it were not
 485   there.
 486   (merge bea4dbeafd tb/ref-filter-empty-modifier later to maint).
 487
 488 * Other minor doc, test and build updates and code cleanups.
 489   (merge f094b89a4d ma/parse-maybe-bool later to maint).
 490   (merge 39b00fa4d4 jk/drop-sha1-entry-pos later to maint).
 491   (merge 6cdf8a7929 ma/ts-cleanups later to maint).
 492   (merge 7560f547e6 ma/up-to-date later to maint).
 493   (merge 0db3dc75f3 rs/apply-epoch later to maint).
 494   (merge 74f1bd912b dw/diff-highlight-makefile-fix later to maint).
 495   (merge f991761eb8 jk/config-lockfile-leak-fix later to maint).
 496   (merge 150efef1e7 ma/pkt-line-leakfix later to maint).
 497   (merge 5554451de6 mg/timestamp-t-fix later to maint).
 498   (merge 276d0e35c0 ma/split-symref-update-fix later to maint).
 499   (merge 3bc4b8f7c7 bb/doc-eol-dirty later to maint).
 500   (merge c1bb33c99c jk/system-path-cleanup later to maint).
 501   (merge ab46e6fc72 cc/subprocess-handshake-missing-capabilities later to maint).
 502   (merge f7a32dd97f kd/doc-for-each-ref later to maint).
 503   (merge be94568bc7 ez/doc-duplicated-words-fix later to maint).
 504   (merge 01e4be6c3d ks/test-readme-phrasofix later to maint).
 505   (merge 217bb56d4f hn/typofix later to maint).
 506   (merge c08fd6388c jk/doc-read-tree-table-asciidoctor-fix later to maint).
 507   (merge c3342b362e ks/doc-use-camelcase-for-config-name later to maint).
 508   (merge 0bca165fdb jk/validate-headref-fix later to maint).
 509   (merge 93dbefb389 mr/doc-negative-pathspec later to maint).
 510   (merge 5e633326e4 ad/doc-markup-fix later to maint).
 511   (merge 9ca356fa8b rs/cocci-de-paren-call-params later to maint).
 512   (merge 7099153e8d rs/tag-null-pointer-arith-fix later to maint).
 513   (merge 0e187d758c rs/run-command-use-alloc-array later to maint).
 514   (merge e0222159fa jn/strbuf-doc-re-reuse later to maint).
 515   (merge 97487ea11a rs/qsort-s later to maint).
 516   (merge a9155c50bd sb/branch-avoid-repeated-strbuf-release later to maint).
 517   (merge f777623514 ks/branch-tweak-error-message-for-extra-args later to maint).
 518   (merge 33f3c683ec ks/verify-filename-non-option-error-message-tweak later to maint).