Merge tag 'gitgui-0.20.0' of http://repo.or.cz/r/git-gui
[gitweb.git] / Documentation / RelNotes / 2.4.0.txt
index f052162effb9a64b036bc03df06fea3d41870abb..0e70681828f265e7b300540a7547cac9bcf21148 100644 (file)
@@ -5,7 +5,8 @@ Backward compatibility warning(s)
 ---------------------------------
 
 This release has a few changes in the user-visible output from
-Porcelain commands, which the users may want to be aware of.
+Porcelain commands. These are not meant to be parsed by scripts, but
+the users still may want to be aware of the changes:
 
  * Output from "git log --decorate" (and "%d" format specifier used in
    the userformat "--format=<string>" parameter "git log" family of
@@ -114,6 +115,16 @@ UI, Workflows & Features
  * A new "push.followTags" configuration turns the "--follow-tags"
    option on by default for the "git push" command.
 
+ * "git log --graph --no-walk A B..." is a conflicting request that
+   asks nonsense; no-walk tells us show discrete points in the
+   history, while graph asks to draw connections between these
+   discrete points. Forbid the combination.
+
+ * "git rev-list --bisect --first-parent" does not work (yet) and can
+   even cause SEGV; forbid it.  "git log --bisect --first-parent"
+   would not be useful until "git bisect --first-parent" materializes,
+   so it is also forbidden for now.
+
 
 Performance, Internal Implementation, Development Support etc.
 
@@ -168,6 +179,19 @@ Performance, Internal Implementation, Development Support etc.
  * "git push" codepath has been restructured to make it easier to add
    new configuration bits.
 
+ * The run-command interface was easy to abuse and make a pipe for us
+   to read from the process, wait for the process to finish and then
+   attempt to read its output, which is a pattern that lead to a
+   deadlock.  Fix such uses by introducing a helper to do this
+   correctly (i.e. we need to read first and then wait the process to
+   finish) and also add code to prevent such abuse in the run-command
+   helper.
+
+ * People often forget to chain the commands in their test together
+   with &&, leaving a failure from an earlier command in the test go
+   unnoticed.  The new GIT_TEST_CHAIN_LINT mechanism allows you to
+   catch such a mistake more easily.
+
 
 Also contains various documentation updates and code clean-ups.
 
@@ -193,7 +217,7 @@ notes for details).
    (merge 339de50 dk/format-patch-ignore-diff-submodule later to maint).
 
  * After attempting and failing a password-less authentication
-   (e.g. kerberos), libcURL refuses to fall back to password based
+   (e.g. Kerberos), libcURL refuses to fall back to password based
    Basic authentication without a bit of help/encouragement.
    (merge 4dbe664 bc/http-fallback-to-password-after-krb-fails later to maint).
 
@@ -273,12 +297,22 @@ notes for details).
    a user name with an at-sign in it.
    (merge 13d261e av/wincred-with-at-in-username-fix later to maint).
 
+ * "diff-highlight" (in contrib/) used to show byte-by-byte
+   differences, which meant that multi-byte characters can be chopped
+   in the middle.  It learned to pay attention to character boundaries
+   (assuming the UTF-8 payload).
+   (merge 8d00662 jk/colors later to maint).
+
+ * "git merge --quiet" did not squelch messages from the underlying
+   merge-recursive strategy.
+   (merge 2bf15a3 jk/merge-quiet later to maint).
+
  * Longstanding configuration variable naming rules has been added to
    the documentation.
    (merge 35840a3 jc/conf-var-doc later to maint).
 
  * An earlier workaround to squelch unhelpful deprecation warnings
-   from the complier on Mac OSX unnecessarily set minimum required
+   from the compiler on Mac OSX unnecessarily set minimum required
    version of the OS, which the user might want to raise (or lower)
    for other reasons.
    (merge 88c03eb es/squelch-openssl-warnings-on-macosx later to maint).
@@ -337,7 +371,7 @@ notes for details).
  * We did not parse username followed by literal IPv6 address in SSH
    transport URLs, e.g. ssh://user@[2001:db8::1]:22/repo.git
    correctly.
-   (merge 3f55cca tb/connect-ipv6-parse-fix later to maint).
+   (merge 6b6c5f7 tb/connect-ipv6-parse-fix later to maint).
 
  * The configuration variable 'mailinfo.scissors' was hard to
    discover in the documentation.
@@ -400,6 +434,37 @@ notes for details).
    that are about listing in a wrong section.
    (merge dd059c6 jk/tag-h-column-is-a-listing-option later to maint).
 
+ * "git prune" used to largely ignore broken refs when deciding which
+   objects are still being used, which could spread an existing small
+   damage and make it a larger one.
+   (merge ea56c4e jk/prune-with-corrupt-refs later to maint).
+
+ * The split-index mode introduced at v2.3.0-rc0~41 was broken in the
+   codepath to protect us against a broken reimplementation of Git
+   that writes an invalid index with duplicated index entries, etc.
+   (merge 03f15a7 tg/fix-check-order-with-split-index later to maint).
+
+ * "git fetch" that fetches a commit using the allow-tip-sha1-in-want
+   extension could have failed to fetch all the requested refs.
+   (merge 32d0462 jk/fetch-pack later to maint).
+
+ * An failure early in the "git clone" that started creating the
+   working tree and repository could have resulted in some directories
+   and files left without getting cleaned up.
+   (merge 16eff6c jk/cleanup-failed-clone later to maint).
+
+ * Recommend format-patch and send-email for those who want to submit
+   patches to this project.
+   (merge b25c469 jc/submitting-patches-mention-send-email later to maint).
+
+ * Even though "git grep --quiet" is run merely to ask for the exit
+   status, we spawned the pager regardless.  Stop doing that.
+   (merge c2048f0 ws/grep-quiet-no-pager later to maint).
+
+ * The prompt script (in contrib/) did not show the untracked sign
+   when working in a subdirectory without any untracked files.
+   (merge 9bdc517 ct/prompt-untracked-fix later to maint).
+
  * Code cleanups and documentation updates.
    (merge 2ce63e9 rs/simple-cleanups later to maint).
    (merge 33baa69 rj/no-xopen-source-for-cygwin later to maint).
@@ -412,3 +477,17 @@ notes for details).
    (merge 9a6f128 rs/deflate-init-cleanup later to maint).
    (merge 6f75d45 rs/use-isxdigit later to maint).
    (merge 376e4b3 jk/test-annoyances later to maint).
+   (merge 7032054 nd/doc-git-index-version later to maint).
+   (merge e869c5e tg/test-index-v4 later to maint).
+   (merge 599d223 jk/simplify-csum-file-sha1fd-check later to maint).
+   (merge 260d585 sg/completion-gitcomp-nl-for-refs later to maint).
+   (merge 777c55a jc/report-path-error-to-dir later to maint).
+   (merge fddfaf8 ph/push-doc-cas later to maint).
+   (merge d50d31e ss/pull-rebase-preserve later to maint).
+   (merge c8c3f1d pt/enter-repo-comment-fix later to maint).
+   (merge d7bfb9e jz/gitweb-conf-doc-fix later to maint).
+   (merge f907282 jk/cherry-pick-docfix later to maint).
+   (merge d3c0811 iu/fix-parse-options-h-comment later to maint).
+   (merge 6c3b2af jg/cguide-we-cannot-count later to maint).
+   (merge 2b8bd44 jk/pack-corruption-post-mortem later to maint).
+   (merge 9585cb8 jn/doc-fast-import-no-16-octopus-limit later to maint).