Twelfth batch for 2.14
[gitweb.git] / Documentation / RelNotes / 2.14.0.txt
index 7ee326e1dc04246f03af523caa108ed7a682e715..8b80058a8539ff4ddcf18c0669f982fd9b2d026a 100644 (file)
@@ -18,6 +18,10 @@ Backward compatibility notes.
    might still be cases that need to be addressed--bug reports are
    greatly appreciated.
 
+ * The experiment to improve the hunk-boundary selection of textual
+   diff output has finished, and the "indent heuristics" has now
+   become the default.
+
 
 Updates since v2.13
 -------------------
@@ -34,19 +38,16 @@ UI, Workflows & Features
 
  * "git archive --format=zip" learned to use zip64 extension when
    necessary to go beyond the 4GB limit.
-   (merge 867e40ff3a rs/large-zip later to maint).
 
  * "git reset" learned "--recurse-submodules" option.
 
  * "git diff --submodule=diff" now recurses into nested submodules.
-   (merge 5a5221427c jk/diff-submodule-diff-inline later to maint).
 
  * "git repack" learned to accept the --threads=<n> option and pass it
    to pack-objects.
 
  * "git send-email" learned to run sendemail-validate hook to inspect
    and reject a message before sending it out.
-   (merge 6489660b4b jt/send-email-validate-hook later to maint).
 
  * There is no good reason why "git fetch $there $sha1" should fail
    when the $sha1 names an object at the tip of an advertised ref,
@@ -60,6 +61,39 @@ UI, Workflows & Features
    current repository to determine if the contents from the named path
    should be included.
 
+ * Make the "indent" heuristics the default in "diff" and diff.indentHeuristics
+   configuration variable an escape hatch for those who do no want it.
+
+ * Many commands learned to pay attention to submodule.recurse
+   configuration.
+
+ * The convention for a command line is to follow "git cmdname
+   --options" with revisions followed by an optional "--"
+   disambiguator and then finally pathspecs.  When "--" is not there,
+   we make sure early ones are all interpretable as revs (and do not
+   look like paths) and later ones are the other way around.  A
+   pathspec with "magic" (e.g. ":/p/a/t/h" that matches p/a/t/h from
+   the top-level of the working tree, no matter what subdirectory you
+   are working from) are conservatively judged as "not a path", which
+   required disambiguation more often.  The command line parser
+   learned to say "it's a pathspec" a bit more often when the syntax
+   looks like so.
+
+ * Update "perl-compatible regular expression" support to enable JIT
+   and also allow linking with the newer PCRE v2 library.
+
+ * "filter-branch" learned a pseudo filter "--setup" that can be used
+   to define common functions/variables that can be used by other
+   filters.
+
+ * Using "git add d/i/r" when d/i/r is the top of the working tree of
+   a separate repository would create a gitlink in the index, which
+   would appear as a not-quite-initialized submodule to others.  We
+   learned to give warnings when this happens.
+
+ * "git status" learned to optionally give how many stash entries the
+   user has in its output.
+
 
 Performance, Internal Implementation, Development Support etc.
 
@@ -69,14 +103,12 @@ Performance, Internal Implementation, Development Support etc.
 
  * Code to update the cache-tree has been tightened so that we won't
    accidentally write out any 0{40} entry in the tree object.
-   (merge a96d3cc3f6 jk/no-null-sha1-in-cache-tree later to maint).
 
  * Attempt to allow us notice "fishy" situation where we fail to
    remove the temporary directory used during the test.
 
  * Travis CI gained a task to format the documentation with both
    AsciiDoc and AsciiDoctor.
-   (merge 505ad91304 ls/travis-doc-asciidoctor later to maint).
 
  * Some platforms have ulong that is smaller than time_t, and our
    historical use of ulong for timestamp would mean they cannot
@@ -93,14 +125,11 @@ Performance, Internal Implementation, Development Support etc.
 
  * Simplify parse_pathspec() codepath and stop it from looking at the
    default in-core index.
-   (merge 08de9151a8 bw/pathspec-sans-the-index later to maint).
 
  * Add perf-test for wildmatch.
-   (merge 62ca75a6b9 ab/perf-wildmatch later to maint).
 
  * Code from "conversion using external process" codepath has been
    extracted to a separate sub-process.[ch] module.
-   (merge 4f2a2e9f0e bp/sub-process-convert-filter later to maint).
 
  * When "git checkout", "git merge", etc. manipulates the in-core
    index, various pieces of information in the index extensions are
@@ -111,7 +140,55 @@ Performance, Internal Implementation, Development Support etc.
    cache is properly invalidated).
 
  * The internal implementation of "git grep" has seen some clean-up.
-   (merge 8df4c2953f ab/grep-preparatory-cleanup later to maint).
+
+ * Update the C style recommendation for notes for translators, as
+   recent versions of gettext tools can work with our style of
+   multi-line comments.
+
+ * The implementation of "ref" API around the "packed refs" have been
+   cleaned up, in preparation for further changes.
+
+ * The internal logic used in "git blame" has been libified to make it
+   easier to use by cgit.
+
+ * Our code often opens a path to an optional file, to work on its
+   contents when we can successfully open it.  We can ignore a failure
+   to open if such an optional file does not exist, but we do want to
+   report a failure in opening for other reasons (e.g. we got an I/O
+   error, or the file is there, but we lack the permission to open).
+
+   The exact errors we need to ignore are ENOENT (obviously) and
+   ENOTDIR (less obvious).  Instead of repeating comparison of errno
+   with these two constants, introduce a helper function to do so.
+
+ * We often try to open a file for reading whose existence is
+   optional, and silently ignore errors from open/fopen; report such
+   errors if they are not due to missing files.
+
+ * When an existing repository is used for t/perf testing, we first
+   create bit-for-bit copy of it, which may grab a transient state of
+   the repository and freeze it into the repository used for testing,
+   which then may cause Git operations to fail.  Single out "the index
+   being locked" case and forcibly drop the lock from the copy.
+
+ * Three instances of the same helper function have been consolidated
+   to one.
+
+ * "fast-import" uses a default pack chain depth that is consistent
+   with other parts of the system.
+
+ * A new test to show the interaction between the pattern [^a-z]
+   (which matches '/') and a slash in a path has been added.  The
+   pattern should not match the slash with "pathmatch", but should
+   with "wildmatch".
+
+ * The 'diff-highlight' program (in contrib/) has been restructured
+   for easier reuse by an external project 'diff-so-fancy'.
+   (merge 0c977dbc81 jk/diff-highlight-module later to maint).
+
+ * A common pattern to free a piece of memory and assign NULL to the
+   pointer that used to point at it has been replaced with a new
+   FREE_AND_NULL() macro.
 
 
 Also contains various documentation updates and code clean-ups.
@@ -131,107 +208,81 @@ notes for details).
    mishandled a trailer block whose last line is an incomplete line.
    This has been fixed so that an additional sign-off etc. are added
    after completing the existing incomplete line.
-   (merge 44dc738a39 jt/use-trailer-api-in-commands later to maint).
 
  * The codepath in "git am" that is used when running "git rebase"
    leaked memory held for the log message of the commits being rebased.
-   (merge 721f5f1e35 jk/am-leakfix later to maint).
 
  * "git clone --config var=val" is a way to populate the
    per-repository configuration file of the new repository, but it did
    not work well when val is an empty string.  This has been fixed.
-   (merge db4eca1fea jn/clone-add-empty-config-from-command-line later to maint).
 
  * Setting "log.decorate=false" in the configuration file did not take
    effect in v2.13, which has been corrected.
-   (merge c74271aae7 ah/log-decorate-default-to-auto later to maint).
 
  * A few codepaths in "checkout" and "am" working on an unborn branch
    tried to access an uninitialized piece of memory.
-   (merge 57e0ef0e0e rs/checkout-am-fix-unborn later to maint).
 
  * The Web interface to gmane news archive is long gone, even though
    the articles are still accessible via NTTP.  Replace the links with
    ones to public-inbox.org.  Because their message identification is
    based on the actual message-id, it is likely that it will be easier
    to migrate away from it if/when necessary.
-   (merge 5840eb9d14 ab/doc-replace-gmane-links later to maint).
 
  * The receive-pack program now makes sure that the push certificate
    records the same set of push options used for pushing.
-   (merge cbaf82cc6b jt/push-options-doc later to maint).
 
  * Tests have been updated to pass under GETTEXT_POISON (a mechanism
    to ensure that output strings that should not be translated are
    not translated by mistake), and TravisCI is told to run them.
-   (merge b8e188f6f5 ab/fix-poison-tests later to maint).
 
  * "git checkout --recurse-submodules" did not quite work with a
    submodule that itself has submodules.
-   (merge 218c883783 sb/checkout-recurse-submodules later to maint).
-
- * Plug some leaks and updates internal API used to implement the
-   split index feature to make it easier to avoid such a leak in the
-   future.
-   (merge de950c5773 nd/split-index-unshare later to maint).
 
  * "pack-objects" can stream a slice of an existing packfile out when
    the pack bitmap can tell that the reachable objects are all needed
    in the output, without inspecting individual objects.  This
    strategy however would not work well when "--local" and other
    options are in use, and need to be disabled.
-   (merge da5a1f8100 jk/disable-pack-reuse-when-broken later to maint).
 
  * Fix memory leaks pointed out by Coverity (and people).
-   (merge 443a12f37b js/plug-leaks later to maint).
 
  * "git read-tree -m" (no tree-ish) gave a nonsense suggestion "use
    --empty if you want to clear the index".  With "-m", such a request
    will still fail anyway, as you'd need to name at least one tree-ish
    to be merged.
-   (merge b9b10d3681 jc/read-tree-empty-with-m later to maint).
 
  * Make sure our tests would pass when the sources are checked out
    with "platform native" line ending convention by default on
    Windows.  Some "text" files out tests use and the test scripts
    themselves that are meant to be run with /bin/sh, ought to be
    checked out with eol=LF even on Windows.
-   (merge 2779f66505 js/eol-on-ourselves later to maint).
 
  * Introduce the BUG() macro to improve die("BUG: ...").
-   (merge 3d7dd2d3b6 jk/bug-to-abort later to maint).
 
  * Clarify documentation for include.path and includeIf.<condition>.path
    configuration variables.
-   (merge ce933ebd5a jk/doc-config-include later to maint).
 
  * Git sometimes gives an advice in a rhetorical question that does
    not require an answer, which can confuse new users and non native
    speakers.  Attempt to rephrase them.
-   (merge 6963893943 ja/do-not-ask-needless-questions later to maint).
 
  * A few http:// links that are redirected to https:// in the
    documentation have been updated to https:// links.
-   (merge 5e68729fd9 jk/update-links-in-docs later to maint).
 
  * "git for-each-ref --format=..." with %(HEAD) in the format used to
    resolve the HEAD symref as many times as it had processed refs,
    which was wasteful, and "git branch" shared the same problem.
-   (merge 613a0e52ea kn/ref-filter-branch-list later to maint).
 
  * Regression fix to topic recently merged to 'master'.
-   (merge d096d7f1ef pw/rebase-i-regression-fix later to maint).
 
  * The shell completion script (in contrib/) learned "git stash" has
    a new "push" subcommand.
-   (merge 3851e4483f tg/stash-push-fixup later to maint).
 
  * "git interpret-trailers", when used as GIT_EDITOR for "git commit
    -v", looked for and appended to a trailer block at the very end,
    i.e. at the end of the "diff" output.  The command has been
    corrected to pay attention to the cut-mark line "commit -v" adds to
    the buffer---the real trailer block should appear just before it.
-   (merge d76650b8d1 bm/interpret-trailers-cut-line-is-eom later to maint).
 
  * A test allowed both "git push" and "git receive-pack" on the other
    end write their traces into the same file.  This is OK on platforms
@@ -239,60 +290,110 @@ notes for details).
    but on other platforms led to a mangled output, causing
    intermittent test failures.  This has been fixed by disabling
    traces from "receive-pack" in the test.
-   (merge 71406ed4d6 jk/alternate-ref-optim later to maint).
 
  * Tag objects, which are not reachable from any ref, that point at
    missing objects were mishandled by "git gc" and friends (they
    should silently be ignored instead)
-   (merge a3ba6bf10a jk/ignore-broken-tags-when-ignoring-missing-links later to maint).
 
  * "git describe --contains" penalized light-weight tags so much that
    they were almost never considered.  Instead, give them about the
    same chance to be considered as an annotated tag that is the same
    age as the underlying commit would.
-   (merge ef1e74065c jc/name-rev-lw-tag later to maint).
 
  * The "run-command" API implementation has been made more robust
    against dead-locking in a threaded environment.
-   (merge e3f43ce765 bw/forking-and-threading later to maint).
 
  * A recent update to t5545-push-options.sh started skipping all the
    tests in the script when a web server testing is disabled or
    unavailable, not just the ones that require a web server.  Non HTTP
    tests have been salvaged to always run in this script.
-   (merge 2e397e4ddf jc/skip-test-in-the-middle later to maint).
 
  * "git send-email" now uses Net::SMTP::SSL, which is obsolete, only
    when needed.  Recent versions of Net::SMTP can do TLS natively.
-   (merge 0ead000c3a dk/send-email-avoid-net-smtp-ssl-when-able later to maint).
 
  * "foo\bar\baz" in "git fetch foo\bar\baz", even though there is no
    slashes in it, cannot be a nickname for a remote on Windows, as
    that is likely to be a pathname on a local filesystem.
-   (merge d9244ecf4f js/bs-is-a-dir-sep-on-windows later to maint).
 
  * "git clean -d" used to clean directories that has ignored files,
    even though the command should not lose ignored ones without "-x".
    "git status --ignored"  did not list ignored and untracked files
    without "-uall".  These have been corrected.
-   (merge 6b1db43109 sl/clean-d-ignored-fix later to maint).
 
  * The result from "git diff" that compares two blobs, e.g. "git diff
    $commit1:$path $commit2:$path", used to be shown with the full
    object name as given on the command line, but it is more natural to
    use the $path in the output and use it to look up .gitattributes.
-   (merge 30d005c020 jk/diff-blob later to maint).
+
+ * The "collision detecting" SHA-1 implementation shipped with 2.13
+   was quite broken on some big-endian platforms and/or platforms that
+   do not like unaligned fetches.  Update to the upstream code which
+   has already fixed these issues.
+
+ * "git am -h" triggered a BUG().
+
+ * The interaction of "url.*.insteadOf" and custom URL scheme's
+   whitelisting is now documented better.
+
+ * The timestamp of the index file is now taken after the file is
+   closed, to help Windows, on which a stale timestamp is reported by
+   fstat() on a file that is opened for writing and data was written
+   but not yet closed.
+
+ * "git pull --rebase --autostash" didn't auto-stash when the local history
+   fast-forwards to the upstream.
+
+ * A flaky test has been corrected.
+
+ * "git $cmd -h" for builtin commands calls the implementation of the
+   command (i.e. cmd_$cmd() function) without doing any repository
+   set-up, and the commands that expect RUN_SETUP is done by the Git
+   potty needs to be prepared to show the help text without barfing.
+   (merge d691551192 jk/consistent-h later to maint).
+
+ * Help contributors that visit us at GitHub.
+
+ * "git stash push <pathspec>" did not work from a subdirectory at all.
+   Bugfix for a topic in v2.13
+
+ * As there is no portable way to pass timezone information to
+   strftime, some output format from "git log" and friends are
+   impossible to produce.  Teach our own strbuf_addftime to replace %z
+   and %Z with caller-supplied values to help working around this.
+   (merge 6eced3ec5e rs/strbuf-addftime-zZ later to maint).
+
+ * "git mergetool" learned to work around a wrapper MacOS X adds
+   around underlying meld.
+   (merge 0af85f84bd da/mergetools-meld-output-opt-on-macos later to maint).
+
+ * An example in documentation that does not work in multi worktree
+   configuration has been corrected.
+   (merge 773a88914f ah/doc-gitattributes-empty-index later to maint).
+
+ * The pretty-format specifiers like '%h', '%t', etc. had an
+   optimization that no longer works correctly.  In preparation/hope
+   of getting it correctly implemented, first discard the optimization
+   that is broken.
+   (merge fe9e2aefd4 rs/pretty-add-again later to maint).
+
+ * The code to pick up and execute command alias definition from the
+   configuration used to switch to the top of the working tree and
+   then come back when the expanded alias was executed, which was
+   unnecessarilyl complex.  Attempt to simplify the logic by using the
+   early-config mechanism that does not chdir around.
+   (merge a9bcf6586d js/alias-early-config later to maint).
+
+ * Fix configuration codepath to pay proper attention to commondir
+   that is used in multi-worktree situation, and isolate config API
+   into its own header file.
+   (merge dc8441fdb4 bw/config-h later to maint).
+
+ * "git add -p" were updated in 2.12 timeframe to cope with custom
+   core.commentchar but the implementation was buggy and a
+   metacharacter like $ and * did not work.
+   (merge d85d7ecb80 jk/add-p-commentchar-fix later to maint).
 
  * Other minor doc, test and build updates and code cleanups.
-   (merge 515360f9e9 jn/credential-doc-on-clear later to maint).
-   (merge 0e6d899fee ab/aix-needs-compat-regex later to maint).
-   (merge e294e8959f jc/apply-fix-mismerge later to maint).
-   (merge 7f1b225153 bw/submodule-with-bs-path later to maint).
-   (merge c8f7c8b704 tb/dedup-crlf-tests later to maint).
-   (merge 449456ad47 sg/core-filemode-doc-typofix later to maint).
-   (merge ba4dce784e km/log-showsignature-doc later to maint).
-   (merge c5a9157393 jh/memihash-opt later to maint).
-   (merge 80f4cd8046 ab/ref-filter-no-contains later to maint).
-   (merge b275da816c ah/doc-interpret-trailers-ifexists later to maint).
-   (merge fc7a5edb55 ah/doc-pretty-format-fix later to maint).
-   (merge 7e95fcb4b5 sb/t5531-update-desc later to maint).
+   (merge 68241cb9dd sb/t4005-modernize later to maint).
+   (merge 4fced24712 ks/t7508-indent-fix later to maint).
+   (merge 968b1fe263 mb/reword-autocomplete-message later to maint).