7ee326e1dc04246f03af523caa108ed7a682e715
   1Git 2.14 Release Notes
   2======================
   3
   4Backward compatibility notes.
   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
  22Updates since v2.13
  23-------------------
  24
  25UI, Workflows & Features
  26
  27 * The colors in which "git status --short --branch" showed the names
  28   of the current branch and its remote-tracking branch are now
  29   configurable.
  30
  31 * "git clone" learned the "--no-tags" option not to fetch all tags
  32   initially, and also set up the tagopt not to follow any tags in
  33   subsequent fetches.
  34
  35 * "git archive --format=zip" learned to use zip64 extension when
  36   necessary to go beyond the 4GB limit.
  37   (merge 867e40ff3a rs/large-zip later to maint).
  38
  39 * "git reset" learned "--recurse-submodules" option.
  40
  41 * "git diff --submodule=diff" now recurses into nested submodules.
  42   (merge 5a5221427c jk/diff-submodule-diff-inline later to maint).
  43
  44 * "git repack" learned to accept the --threads=<n> option and pass it
  45   to pack-objects.
  46
  47 * "git send-email" learned to run sendemail-validate hook to inspect
  48   and reject a message before sending it out.
  49   (merge 6489660b4b jt/send-email-validate-hook later to maint).
  50
  51 * There is no good reason why "git fetch $there $sha1" should fail
  52   when the $sha1 names an object at the tip of an advertised ref,
  53   even when the other side hasn't enabled allowTipSHA1InWant.
  54
  55 * The recently introduced "[includeIf "gitdir:$dir"] path=..."
  56   mechansim has further been taught to take symlinks into account.
  57   The directory "$dir" specified in "gitdir:$dir" may be a symlink to
  58   a real location, not something that $(getcwd) may return.  In such
  59   a case, a realpath of "$dir" is compared with the real path of the
  60   current repository to determine if the contents from the named path
  61   should be included.
  62
  63
  64Performance, Internal Implementation, Development Support etc.
  65
  66 * The default packed-git limit value has been raised on larger
  67   platforms to save "git fetch" from a (recoverable) failure while
  68   "gc" is running in parallel.
  69
  70 * Code to update the cache-tree has been tightened so that we won't
  71   accidentally write out any 0{40} entry in the tree object.
  72   (merge a96d3cc3f6 jk/no-null-sha1-in-cache-tree later to maint).
  73
  74 * Attempt to allow us notice "fishy" situation where we fail to
  75   remove the temporary directory used during the test.
  76
  77 * Travis CI gained a task to format the documentation with both
  78   AsciiDoc and AsciiDoctor.
  79   (merge 505ad91304 ls/travis-doc-asciidoctor later to maint).
  80
  81 * Some platforms have ulong that is smaller than time_t, and our
  82   historical use of ulong for timestamp would mean they cannot
  83   represent some timestamp that the platform allows.  Invent a
  84   separate and dedicated timestamp_t (so that we can distingiuish
  85   timestamps and a vanilla ulongs, which along is already a good
  86   move), and then declare uintmax_t is the type to be used as the
  87   timestamp_t.
  88
  89 * We can trigger Windows auto-build tester (credits: Dscho &
  90   Microsoft) from our existing Travis CI tester now.
  91
  92 * Conversion from uchar[20] to struct object_id continues.
  93
  94 * Simplify parse_pathspec() codepath and stop it from looking at the
  95   default in-core index.
  96   (merge 08de9151a8 bw/pathspec-sans-the-index later to maint).
  97
  98 * Add perf-test for wildmatch.
  99   (merge 62ca75a6b9 ab/perf-wildmatch later to maint).
 100
 101 * Code from "conversion using external process" codepath has been
 102   extracted to a separate sub-process.[ch] module.
 103   (merge 4f2a2e9f0e bp/sub-process-convert-filter later to maint).
 104
 105 * When "git checkout", "git merge", etc. manipulates the in-core
 106   index, various pieces of information in the index extensions are
 107   discarded from the original state, as it is usually not the case
 108   that they are kept up-to-date and in-sync with the operation on the
 109   main index.  The untracked cache extension is copied across these
 110   operations now, which would speed up "git status" (as long as the
 111   cache is properly invalidated).
 112
 113 * The internal implementation of "git grep" has seen some clean-up.
 114   (merge 8df4c2953f ab/grep-preparatory-cleanup later to maint).
 115
 116
 117Also contains various documentation updates and code clean-ups.
 118
 119
 120Fixes since v2.13
 121-----------------
 122
 123Unless otherwise noted, all the fixes since v2.13 in the maintenance
 124track are contained in this release (see the maintenance releases'
 125notes for details).
 126
 127 * "git gc" did not interact well with "git worktree"-managed
 128   per-worktree refs.
 129
 130 * "git cherry-pick" and other uses of the sequencer machinery
 131   mishandled a trailer block whose last line is an incomplete line.
 132   This has been fixed so that an additional sign-off etc. are added
 133   after completing the existing incomplete line.
 134   (merge 44dc738a39 jt/use-trailer-api-in-commands later to maint).
 135
 136 * The codepath in "git am" that is used when running "git rebase"
 137   leaked memory held for the log message of the commits being rebased.
 138   (merge 721f5f1e35 jk/am-leakfix later to maint).
 139
 140 * "git clone --config var=val" is a way to populate the
 141   per-repository configuration file of the new repository, but it did
 142   not work well when val is an empty string.  This has been fixed.
 143   (merge db4eca1fea jn/clone-add-empty-config-from-command-line later to maint).
 144
 145 * Setting "log.decorate=false" in the configuration file did not take
 146   effect in v2.13, which has been corrected.
 147   (merge c74271aae7 ah/log-decorate-default-to-auto later to maint).
 148
 149 * A few codepaths in "checkout" and "am" working on an unborn branch
 150   tried to access an uninitialized piece of memory.
 151   (merge 57e0ef0e0e rs/checkout-am-fix-unborn later to maint).
 152
 153 * The Web interface to gmane news archive is long gone, even though
 154   the articles are still accessible via NTTP.  Replace the links with
 155   ones to public-inbox.org.  Because their message identification is
 156   based on the actual message-id, it is likely that it will be easier
 157   to migrate away from it if/when necessary.
 158   (merge 5840eb9d14 ab/doc-replace-gmane-links later to maint).
 159
 160 * The receive-pack program now makes sure that the push certificate
 161   records the same set of push options used for pushing.
 162   (merge cbaf82cc6b jt/push-options-doc later to maint).
 163
 164 * Tests have been updated to pass under GETTEXT_POISON (a mechanism
 165   to ensure that output strings that should not be translated are
 166   not translated by mistake), and TravisCI is told to run them.
 167   (merge b8e188f6f5 ab/fix-poison-tests later to maint).
 168
 169 * "git checkout --recurse-submodules" did not quite work with a
 170   submodule that itself has submodules.
 171   (merge 218c883783 sb/checkout-recurse-submodules later to maint).
 172
 173 * Plug some leaks and updates internal API used to implement the
 174   split index feature to make it easier to avoid such a leak in the
 175   future.
 176   (merge de950c5773 nd/split-index-unshare later to maint).
 177
 178 * "pack-objects" can stream a slice of an existing packfile out when
 179   the pack bitmap can tell that the reachable objects are all needed
 180   in the output, without inspecting individual objects.  This
 181   strategy however would not work well when "--local" and other
 182   options are in use, and need to be disabled.
 183   (merge da5a1f8100 jk/disable-pack-reuse-when-broken later to maint).
 184
 185 * Fix memory leaks pointed out by Coverity (and people).
 186   (merge 443a12f37b js/plug-leaks later to maint).
 187
 188 * "git read-tree -m" (no tree-ish) gave a nonsense suggestion "use
 189   --empty if you want to clear the index".  With "-m", such a request
 190   will still fail anyway, as you'd need to name at least one tree-ish
 191   to be merged.
 192   (merge b9b10d3681 jc/read-tree-empty-with-m later to maint).
 193
 194 * Make sure our tests would pass when the sources are checked out
 195   with "platform native" line ending convention by default on
 196   Windows.  Some "text" files out tests use and the test scripts
 197   themselves that are meant to be run with /bin/sh, ought to be
 198   checked out with eol=LF even on Windows.
 199   (merge 2779f66505 js/eol-on-ourselves later to maint).
 200
 201 * Introduce the BUG() macro to improve die("BUG: ...").
 202   (merge 3d7dd2d3b6 jk/bug-to-abort later to maint).
 203
 204 * Clarify documentation for include.path and includeIf.<condition>.path
 205   configuration variables.
 206   (merge ce933ebd5a jk/doc-config-include later to maint).
 207
 208 * Git sometimes gives an advice in a rhetorical question that does
 209   not require an answer, which can confuse new users and non native
 210   speakers.  Attempt to rephrase them.
 211   (merge 6963893943 ja/do-not-ask-needless-questions later to maint).
 212
 213 * A few http:// links that are redirected to https:// in the
 214   documentation have been updated to https:// links.
 215   (merge 5e68729fd9 jk/update-links-in-docs later to maint).
 216
 217 * "git for-each-ref --format=..." with %(HEAD) in the format used to
 218   resolve the HEAD symref as many times as it had processed refs,
 219   which was wasteful, and "git branch" shared the same problem.
 220   (merge 613a0e52ea kn/ref-filter-branch-list later to maint).
 221
 222 * Regression fix to topic recently merged to 'master'.
 223   (merge d096d7f1ef pw/rebase-i-regression-fix later to maint).
 224
 225 * The shell completion script (in contrib/) learned "git stash" has
 226   a new "push" subcommand.
 227   (merge 3851e4483f tg/stash-push-fixup later to maint).
 228
 229 * "git interpret-trailers", when used as GIT_EDITOR for "git commit
 230   -v", looked for and appended to a trailer block at the very end,
 231   i.e. at the end of the "diff" output.  The command has been
 232   corrected to pay attention to the cut-mark line "commit -v" adds to
 233   the buffer---the real trailer block should appear just before it.
 234   (merge d76650b8d1 bm/interpret-trailers-cut-line-is-eom later to maint).
 235
 236 * A test allowed both "git push" and "git receive-pack" on the other
 237   end write their traces into the same file.  This is OK on platforms
 238   that allows atomically appending to a file opened with O_APPEND,
 239   but on other platforms led to a mangled output, causing
 240   intermittent test failures.  This has been fixed by disabling
 241   traces from "receive-pack" in the test.
 242   (merge 71406ed4d6 jk/alternate-ref-optim later to maint).
 243
 244 * Tag objects, which are not reachable from any ref, that point at
 245   missing objects were mishandled by "git gc" and friends (they
 246   should silently be ignored instead)
 247   (merge a3ba6bf10a jk/ignore-broken-tags-when-ignoring-missing-links later to maint).
 248
 249 * "git describe --contains" penalized light-weight tags so much that
 250   they were almost never considered.  Instead, give them about the
 251   same chance to be considered as an annotated tag that is the same
 252   age as the underlying commit would.
 253   (merge ef1e74065c jc/name-rev-lw-tag later to maint).
 254
 255 * The "run-command" API implementation has been made more robust
 256   against dead-locking in a threaded environment.
 257   (merge e3f43ce765 bw/forking-and-threading later to maint).
 258
 259 * A recent update to t5545-push-options.sh started skipping all the
 260   tests in the script when a web server testing is disabled or
 261   unavailable, not just the ones that require a web server.  Non HTTP
 262   tests have been salvaged to always run in this script.
 263   (merge 2e397e4ddf jc/skip-test-in-the-middle later to maint).
 264
 265 * "git send-email" now uses Net::SMTP::SSL, which is obsolete, only
 266   when needed.  Recent versions of Net::SMTP can do TLS natively.
 267   (merge 0ead000c3a dk/send-email-avoid-net-smtp-ssl-when-able later to maint).
 268
 269 * "foo\bar\baz" in "git fetch foo\bar\baz", even though there is no
 270   slashes in it, cannot be a nickname for a remote on Windows, as
 271   that is likely to be a pathname on a local filesystem.
 272   (merge d9244ecf4f js/bs-is-a-dir-sep-on-windows later to maint).
 273
 274 * "git clean -d" used to clean directories that has ignored files,
 275   even though the command should not lose ignored ones without "-x".
 276   "git status --ignored"  did not list ignored and untracked files
 277   without "-uall".  These have been corrected.
 278   (merge 6b1db43109 sl/clean-d-ignored-fix later to maint).
 279
 280 * The result from "git diff" that compares two blobs, e.g. "git diff
 281   $commit1:$path $commit2:$path", used to be shown with the full
 282   object name as given on the command line, but it is more natural to
 283   use the $path in the output and use it to look up .gitattributes.
 284   (merge 30d005c020 jk/diff-blob later to maint).
 285
 286 * Other minor doc, test and build updates and code cleanups.
 287   (merge 515360f9e9 jn/credential-doc-on-clear later to maint).
 288   (merge 0e6d899fee ab/aix-needs-compat-regex later to maint).
 289   (merge e294e8959f jc/apply-fix-mismerge later to maint).
 290   (merge 7f1b225153 bw/submodule-with-bs-path later to maint).
 291   (merge c8f7c8b704 tb/dedup-crlf-tests later to maint).
 292   (merge 449456ad47 sg/core-filemode-doc-typofix later to maint).
 293   (merge ba4dce784e km/log-showsignature-doc later to maint).
 294   (merge c5a9157393 jh/memihash-opt later to maint).
 295   (merge 80f4cd8046 ab/ref-filter-no-contains later to maint).
 296   (merge b275da816c ah/doc-interpret-trailers-ifexists later to maint).
 297   (merge fc7a5edb55 ah/doc-pretty-format-fix later to maint).
 298   (merge 7e95fcb4b5 sb/t5531-update-desc later to maint).