Documentation / RelNotes / 2.21.0.txton commit Merge branch 'ss/describe-dirty-in-the-right-directory' (a1e1900)
   1Git 2.21 Release Notes
   2======================
   3
   4Backward Compatibility Notes
   5----------------------------
   6
   7
   8Updates since v2.20
   9-------------------
  10
  11UI, Workflows & Features
  12
  13 * The "http.version" configuration variable can be used with recent
  14   enough cURL library to force the version of HTTP used to talk when
  15   fetching and pushing.
  16
  17 * Small fixes and features for fast-export and fast-import, mostly on
  18   the fast-export side.
  19
  20 * "git push $there $src:$dst" rejects when $dst is not a fully
  21   qualified refname and not clear what the end user meant.  The
  22   codepath has been taught to give a clearer error message, and also
  23   guess where the push should go by taking the type of the pushed
  24   object into account (e.g. a tag object would want to go under
  25   refs/tags/).
  26
  27 * "git checkout [<tree-ish>] path..." learned to report the number of
  28   paths that have been checked out of the index or the tree-ish,
  29   which gives it the same degree of noisy-ness as the case in which
  30   the command checks out a branch.
  31
  32 * "git quiltimport" learned "--keep-non-patch" option.
  33
  34 * "git worktree remove" and "git worktree move" refused to work when
  35   there is a submodule involved.  This has been loosened to ignore
  36   uninitialized submodules.
  37
  38 * "git cherry-pick -m1" was forbidden when picking a non-merge
  39   commit, even though there _is_ parent number 1 for such a commit.
  40   This was done to avoid mistakes back when "cherry-pick" was about
  41   picking a single commit, but is no longer useful with "cherry-pick"
  42   that can pick a range of commits.  Now the "-m$num" option is
  43   allowed when picking any commit, as long as $num names an existing
  44   parent of the commit.
  45
  46 * Update "git multimail" from the upstream.
  47
  48 * "git p4" update.
  49
  50 * The "--format=<placeholder>" option of for-each-ref, branch and tag
  51   learned to show a few more traits of objects that can be learned by
  52   the object_info API.
  53
  54 * "git rebase -i" learned to re-execute a command given with 'exec'
  55   to run after it failed the last time.
  56
  57 * "git diff --color-moved-ws" updates.
  58
  59 * Custom userformat "log --format" learned %S atom that stands for
  60   the tip the traversal reached the commit from, i.e. --source.
  61
  62 * "git instaweb" learned to drive http.server that comes with
  63   "batteries included" Python installation (both Python2 & 3).
  64
  65
  66Performance, Internal Implementation, Development Support etc.
  67
  68 * Code clean-up with optimization for the codepath that checks
  69   (non-)existence of loose objects.
  70
  71 * More codepaths become aware of working with in-core repository
  72   instance other than the default "the_repository".
  73
  74 * The "strncat()" function is now among the banned functions.
  75
  76 * Portability updates for the HPE NonStop platform.
  77
  78 * Earlier we added "-Wformat-security" to developer builds, assuming
  79   that "-Wall" (which includes "-Wformat" which in turn is required
  80   to use "-Wformat-security") is always in effect.  This is not true
  81   when config.mak.autogen is in use, unfortunately.  This has been
  82   fixed by unconditionally adding "-Wall" to developer builds.
  83
  84 * The loose object cache used to optimize existence look-up has been
  85   updated.
  86
  87 * Flaky tests can now be repeatedly run under load with the
  88   "--stress" option.
  89   (merge fb7d1e3ac8 sg/stress-test later to maint).
  90
  91 * Documentation/Makefile is getting prepared for manpage
  92   localization.
  93
  94 * "git fetch-pack" now can talk the version 2 protocol.
  95
  96 * sha-256 hash has been added and plumbed through the code to allow
  97   building Git with the "NewHash".
  98
  99 * Debugging help for http transport.
 100
 101 * "git fetch --deepen=<more>" has been corrected to work over v2
 102   protocol.
 103
 104 * The code to walk tree objects has been taught that we may be
 105   working with object names that are not computed with SHA-1.
 106
 107 * The in-core repository instances are passed through more codepaths.
 108
 109 * Update the protocol message specification to allow only the limited
 110   use of scaled quantities.  This is ensure potential compatibility
 111   issues will not go out of hand.
 112
 113 * Micro-optimize the code that prepares commit objects to be walked
 114   by "git rev-list" when the commit-graph is available.
 115
 116 * "git fetch" and "git upload-pack" learned to send all exchange over
 117   the sideband channel while talking the v2 protocol.
 118
 119 * The codepath to write out commit-graph has been optimized by
 120   following the usual pattern of visiting objects in in-pack order.
 121
 122 * The codepath to show progress meter while writing out commit-graph
 123   file has been improved.
 124
 125 * Cocci rules have been updated to encourage use of strbuf_addbuf().
 126
 127
 128Fixes since v2.20
 129-----------------
 130
 131 * Updates for corner cases in merge-recursive.
 132   (merge cc4cb0902c en/merge-path-collision later to maint).
 133
 134 * "git checkout frotz" (without any double-dash) avoids ambiguity by
 135   making sure 'frotz' cannot be interpreted as a revision and as a
 136   path at the same time.  This safety has been updated to check also
 137   a unique remote-tracking branch 'frotz' in a remote, when dwimming
 138   to create a local branch 'frotz' out of a remote-tracking branch
 139   'frotz' from a remote.
 140   (merge be4908f103 nd/checkout-dwim-fix later to maint).
 141
 142 * Refspecs configured with "git -c var=val clone" did not propagate
 143   to the resulting repository, which has been corrected.
 144   (merge 7eae4a3ac4 sg/clone-initial-fetch-configuration later to maint).
 145
 146 * A properly configured username/email is required under
 147   user.useConfigOnly in order to create commits; now "git stash"
 148   (even though it creates commit objects to represent stash entries)
 149   command is exempt from the requirement.
 150   (merge 3bc2111fc2 sd/stash-wo-user-name later to maint).
 151
 152 * The http-backend CGI process did not correctly clean up the child
 153   processes it spawns to run upload-pack etc. when it dies itself,
 154   which has been corrected.
 155   (merge 02818a98d7 mk/http-backend-kill-children-before-exit later to maint).
 156
 157 * "git rev-list --exclude-promisor-objects" had to take an object
 158   that does not exist locally (and is lazily available) from the
 159   command line without barfing, but the code dereferenced NULL.
 160   (merge 4cf67869b2 md/list-lazy-objects-fix later to maint).
 161
 162 * The traversal over tree objects has learned to honor
 163   ":(attr:label)" pathspec match, which has been implemented only for
 164   enumerating paths on the filesystem.
 165   (merge 5a0b97b34c nd/attr-pathspec-in-tree-walk later to maint).
 166
 167 * BSD port updates.
 168   (merge 4e3ecbd439 cb/openbsd-allows-reading-directory later to maint).
 169   (merge b6bdc2a0f5 cb/t5004-empty-tar-archive-fix later to maint).
 170   (merge 82cbc8cde2 cb/test-lint-cp-a later to maint).
 171
 172 * Lines that begin with a certain keyword that come over the wire, as
 173   well as lines that consist only of one of these keywords, ought to
 174   be painted in color for easier eyeballing, but the latter was
 175   broken ever since the feature was introduced in 2.19, which has
 176   been corrected.
 177   (merge 1f67290450 hn/highlight-sideband-keywords later to maint).
 178
 179 * "git log -G<regex>" looked for a hunk in the "git log -p" patch
 180   output that contained a string that matches the given pattern.
 181   Optimize this code to ignore binary files, which by default will
 182   not show any hunk that would match any pattern (unless textconv or
 183   the --text option is in effect, that is).
 184   (merge e0e7cb8080 tb/log-G-binary later to maint).
 185
 186 * "git submodule update" ought to use a single job unless asked, but
 187   by mistake used multiple jobs, which has been fixed.
 188   (merge e3a9d1aca9 sb/submodule-fetchjobs-default-to-one later to maint).
 189
 190 * "git stripspace" should be usable outside a git repository, but
 191   under the "-s" or "-c" mode, it didn't.
 192   (merge 957da75802 jn/stripspace-wo-repository later to maint).
 193
 194 * Some of the documentation pages formatted incorrectly with
 195   Asciidoctor, which have been fixed.
 196   (merge b62eb1d2f4 ma/asciidoctor later to maint).
 197
 198 * The core.worktree setting in a submodule repository should not be
 199   pointing at a directory when the submodule loses its working tree
 200   (e.g. getting deinit'ed), but the code did not properly maintain
 201   this invariant.
 202
 203 * With zsh, "git cmd path<TAB>" was completed to "git cmd path name"
 204   when the completed path has a special character like SP in it,
 205   without any attempt to keep "path name" a single filename.  This
 206   has been fixed to complete it to "git cmd path\ name" just like
 207   Bash completion does.
 208
 209 * The test suite tried to see if it is run under bash, but the check
 210   itself failed under some other implementations of shell (notably
 211   under NetBSD).  This has been corrected.
 212   (merge 54ea72f09c sg/test-bash-version-fix later to maint).
 213
 214 * "git gc" and "git repack" did not close the open packfiles that
 215   they found unneeded before removing them, which didn't work on a
 216   platform incapable of removing an open file.  This has been
 217   corrected.
 218   (merge 5bdece0d70 js/gc-repack-close-before-remove later to maint).
 219
 220 * The code to drive GIT_EXTERNAL_DIFF command relied on the string
 221   returned from getenv() to be non-volatile, which is not true, that
 222   has been corrected.
 223   (merge 6776a84dae kg/external-diff-save-env later to maint).
 224
 225 * There were many places the code relied on the string returned from
 226   getenv() to be non-volatile, which is not true, that have been
 227   corrected.
 228   (merge 0da0e9268b jk/save-getenv-result later to maint).
 229
 230 * The v2 upload-pack protocol implementation failed to honor
 231   hidden-ref configuration, which has been corrected.
 232   (merge e20b4192a3 jk/proto-v2-hidden-refs-fix later to maint).
 233
 234 * "git fetch --recurse-submodules" may not fetch the necessary commit
 235   that is bound to the superproject, which is getting corrected.
 236   (merge be76c21282 sb/submodule-recursive-fetch-gets-the-tip later to maint).
 237
 238 * "git rebase" internally runs "checkout" to switch between branches,
 239   and the command used to call the post-checkout hook, but the
 240   reimplementation stopped doing so, which is getting fixed.
 241
 242 * "git add -e" got confused when the change it wants to let the user
 243   edit is smaller than the previous change that was left over in a
 244   temporary file.
 245   (merge fa6f225e01 js/add-e-clear-patch-before-stating later to maint).
 246
 247 * "git p4" failed to update a shelved change when there were moved
 248   files, which has been corrected.
 249   (merge 7a10946ab9 ld/git-p4-shelve-update-fix later to maint).
 250
 251 * The codepath to read from the commit-graph file attempted to read
 252   past the end of it when the file's table-of-contents was corrupt.
 253
 254 * The compat/obstack code had casts that -Wcast-function-type
 255   compilation option found questionable.
 256   (merge 764473d257 sg/obstack-cast-function-type-fix later to maint).
 257
 258 * An obvious typo in an assertion error message has been fixed.
 259   (merge 3c27e2e059 cc/test-ref-store-typofix later to maint).
 260
 261 * In Git for Windows, "git clone \\server\share\path" etc. that uses
 262   UNC paths from command line had bad interaction with its shell
 263   emulation.
 264
 265 * "git add --ignore-errors" did not work as advertised and instead
 266   worked as an unintended synonym for "git add --renormalize", which
 267   has been fixed.
 268   (merge 9e5da3d055 jk/add-ignore-errors-bit-assignment-fix later to maint).
 269
 270 * On a case-insensitive filesystem, we failed to compare the part of
 271   the path that is above the worktree directory in an absolute
 272   pathname, which has been corrected.
 273
 274 * Asking "git check-attr" about a macro (e.g. "binary") on a specific
 275   path did not work correctly, even though "git check-attr -a" listed
 276   such a macro correctly.  This has been corrected.
 277   (merge 7b95849be4 jk/attr-macro-fix later to maint).
 278
 279 * "git pack-objects" incorrectly used uninitialized mutex, which has
 280   been corrected.
 281   (merge edb673cf10 ph/pack-objects-mutex-fix later to maint).
 282
 283 * "git checkout -b <new> [HEAD]" to create a new branch from the
 284   current commit and check it out ought to be a no-op in the index
 285   and the working tree in normal cases, but there are corner cases
 286   that do require updates to the index and the working tree.  Running
 287   it immediately after "git clone --no-checkout" is one of these
 288   cases that an earlier optimization kicked in incorrectly, which has
 289   been fixed.
 290   (merge 8424bfd45b bp/checkout-new-branch-optim later to maint).
 291
 292 * "git diff --color-moved --cc --stat -p" did not work well due to
 293   funny interaction between a bug in color-moved and the rest, which
 294   has been fixed.
 295   (merge dac03b5518 jk/diff-cc-stat-fixes later to maint).
 296
 297 * When GIT_SEQUENCE_EDITOR is set, the command was incorrectly
 298   started when modes of "git rebase" that implicitly uses the
 299   machinery for the interactive rebase are run, which has been
 300   corrected.
 301   (merge 891d4a0313 pw/no-editor-in-rebase-i-implicit later to maint).
 302
 303 * The commit-graph facility did not work when in-core objects that
 304   are promoted from unknown type to commit (e.g. a commit that is
 305   accessed via a tag that refers to it) were involved, which has been
 306   corrected.
 307   (merge 4468d4435c sg/object-as-type-commit-graph-fix later to maint).
 308
 309 * "git fetch" output cleanup.
 310   (merge dc40b24df4 nd/fetch-compact-update later to maint).
 311
 312 * Code cleanup, docfix, build fix, etc.
 313   (merge 89ba9a79ae hb/t0061-dot-in-path-fix later to maint).
 314   (merge d173e799ea sb/diff-color-moved-config-option-fixup later to maint).
 315   (merge a8f5a59067 en/directory-renames-nothanks-doc-update later to maint).
 316   (merge ec36c42a63 nd/indentation-fix later to maint).
 317   (merge f116ee21cd do/gitweb-strict-export-conf-doc later to maint).
 318   (merge 112ea42663 fd/gitweb-snapshot-conf-doc-fix later to maint).
 319   (merge 1cadad6f65 tb/use-common-win32-pathfuncs-on-cygwin later to maint).
 320   (merge 57e9dcaa65 km/rebase-doc-typofix later to maint).
 321   (merge b8b4cb27e6 ds/gc-doc-typofix later to maint).
 322   (merge 3b3357626e nd/style-opening-brace later to maint).
 323   (merge b4583d5595 es/doc-worktree-guessremote-config later to maint).
 324   (merge cce99cd8c6 ds/commit-graph-assert-missing-parents later to maint).
 325   (merge 0650614982 cy/completion-typofix later to maint).
 326   (merge 6881925ef5 rs/sha1-file-close-mapped-file-on-error later to maint).
 327   (merge bd8d6f0def en/show-ref-doc-fix later to maint).
 328   (merge 1747125e2c cc/parial-clone-doc-typofix later to maint).
 329   (merge e01378753d cc/fetch-error-message-fix later to maint).
 330   (merge 54e8c11215 jk/remote-insteadof-cleanup later to maint).
 331   (merge d609615f48 js/test-git-installed later to maint).
 332   (merge ba170517be ja/doc-style-fix later to maint).