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