Documentation / RelNotes / 2.23.0.txton commit Merge branch 'js/rebase-cleanup' (38dac33)
   1Git 2.23 Release Notes
   2======================
   3
   4Updates since v2.22
   5-------------------
   6
   7Backward compatibility note
   8
   9 * The "--base" option of "format-patch" computed the patch-ids for
  10   prerequisite patches in an unstable way, which has been updated to
  11   compute in a way that is compatible with "git patch-id --stable".
  12
  13
  14UI, Workflows & Features
  15
  16 * The "git fast-export/import" pair has been taught to handle commits
  17   with log messages in encoding other than UTF-8 better.
  18
  19 * In recent versions of Git, per-worktree refs are exposed in
  20   refs/worktrees/<wtname>/ hierarchy, which means that worktree names
  21   must be a valid refname component.  The code now sanitizes the names
  22   given to worktrees, to make sure these refs are well-formed.
  23
  24 * "git merge" learned "--quit" option that cleans up the in-progress
  25   merge while leaving the working tree and the index still in a mess.
  26
  27 * "git format-patch" learns a configuration to set the default for
  28   its --notes=<ref> option.
  29
  30 * The code to show args with potential typo that cannot be
  31   interpreted as a commit-ish has been improved.
  32
  33 * "git clone --recurse-submodules" learned to set up the submodules
  34   to ignore commit object names recorded in the superproject gitlink
  35   and instead use the commits that happen to be at the tip of the
  36   remote-tracking branches from the get-go, by passing the new
  37   "--remote-submodules" option.
  38
  39 * The pattern "git diff/grep" use to extract funcname and words
  40   boundary for Matlab has been extend to cover Octave, which is more
  41   or less equivalent.
  42
  43 * "git help git" was hard to discover (well, at least for some
  44   people).
  45
  46 * The pattern "git diff/grep" use to extract funcname and words
  47   boundary for Rust has been added.
  48
  49 * "git status" can be told a non-standard default value for the
  50   "--[no-]ahead-behind" option with a new configuration variable
  51   status.aheadBehind.
  52
  53 * "git fetch" and "git pull" reports when a fetch results in
  54   non-fast-forward updates to let the user notice unusual situation.
  55   The commands learned "--no-shown-forced-updates" option to disable
  56   this safety feature.
  57
  58 * Two new commands "git switch" and "git restore" are introduced to
  59   split "checking out a branch to work on advancing its history" and
  60   "checking out paths out of the index and/or a tree-ish to work on
  61   advancing the current history" out of the single "git checkout"
  62   command.
  63
  64 * "git branch --list" learned to always output the detached HEAD as
  65   the first item (when the HEAD is detached, of course), regardless
  66   of the locale.
  67
  68 * The conditional inclusion mechanism learned to base the choice on
  69   the branch the HEAD currently is on.
  70
  71 * "git rev-list --objects" learned with "--no-object-names" option to
  72   squelch the path to the object that is used as a grouping hint for
  73   pack-objects.
  74
  75 * A new tag.gpgSign configuration variable turns "git tag -a" into
  76   "git tag -s".
  77
  78 * "git multi-pack-index" learned expire and repack subcommands.
  79
  80 * "git blame" learned to "ignore" commits in the history, whose
  81   effects (as well as their presence) get ignored.
  82
  83 * "git cherry-pick/revert" learned a new "--skip" action.
  84
  85 * The tips of refs from the alternate object store can be used as
  86   starting point for reachability computation now.
  87
  88 * Extra blank lines in "git status" output have been reduced.
  89
  90 * The commits in a repository can be described by multiple
  91   commit-graph files now, which allows the commit-graph files to be
  92   updated incrementally.
  93
  94 * The "git log" command learns to issue a warning when log.mailmap
  95   configuration is not set and --[no-]mailmap option is not used, to
  96   prepare users for future versions of Git that uses the mailmap by
  97   default.
  98
  99 * "git range-diff" output has been tweaked for easier identification
 100   of which part of what file the patch shown is about.
 101
 102
 103Performance, Internal Implementation, Development Support etc.
 104
 105 * Update supporting parts of "git rebase" to remove code that should
 106   no longer be used.
 107
 108 * Developer support to emulate unsatisfied prerequisites in tests to
 109   ensure that the remainer of the tests still succeeds when tests
 110   with prerequisites are skipped.
 111
 112 * "git update-server-info" learned not to rewrite the file with the
 113   same contents.
 114
 115 * The way of specifying the path to find dynamic libraries at runtime
 116   has been simplified.  The old default to pass -R/path/to/dir has been
 117   replaced with the new default to pass -Wl,-rpath,/path/to/dir,
 118   which is the more recent GCC uses.  Those who need to build with an
 119   old GCC can still use "CC_LD_DYNPATH=-R"
 120
 121 * Prepare use of reachability index in topological walker that works
 122   on a range (A..B).
 123
 124 * A new tutorial targetting specifically aspiring git-core
 125   developers has been added.
 126
 127 * Auto-detect how to tell HP-UX aCC where to use dynamically linked
 128   libraries from at runtime.
 129
 130 * "git mergetool" and its tests now spawn fewer subprocesses.
 131
 132 * Dev support update to help tracing out tests.
 133
 134 * Support to build with MSVC has been updated.
 135
 136 * "git fetch" that grabs from a group of remotes learned to run the
 137   auto-gc only once at the very end.
 138
 139 * A handful of Windows build patches have been upstreamed.
 140
 141 * The code to read state files used by the sequencer machinery for
 142   "git status" has been made more robust against a corrupt or stale
 143   state files.
 144
 145 * "git for-each-ref" with multiple patterns have been optimized.
 146
 147 * The tree-walk API learned to pass an in-core repository
 148   instance throughout more codepaths.
 149
 150 * When one step in multi step cherry-pick or revert is reset or
 151   committed, the command line prompt script failed to notice the
 152   current status, which has been improved.
 153
 154 * Many GIT_TEST_* environment variables control various aspects of
 155   how our tests are run, but a few followed "non-empty is true, empty
 156   or unset is false" while others followed the usual "there are a few
 157   ways to spell true, like yes, on, etc., and also ways to spell
 158   false, like no, off, etc." convention.
 159
 160 * Adjust the dir-iterator API and apply it to the local clone
 161   optimization codepath.
 162
 163 * We have been trying out a few language features outside c89; the
 164   coding guidelines document did not talk about them and instead had
 165   a blanket ban against them.
 166   (merge cc0c42975a jc/post-c89-rules-doc later to maint).
 167
 168 * A test helper has been introduced to optimize preparation of test
 169   repositories with many simple commits, and a handful of test
 170   scripts have been updated to use it.
 171
 172
 173Fixes since v2.22
 174-----------------
 175
 176 * A relative pathname given to "git init --template=<path> <repo>"
 177   ought to be relative to the directory "git init" gets invoked in,
 178   but it instead was made relative to the repository, which has been
 179   corrected.
 180   (merge e1df7fe43f nd/init-relative-template-fix later to maint).
 181
 182 * "git worktree add" used to fail when another worktree connected to
 183   the same repository was corrupt, which has been corrected.
 184   (merge 105df73e71 nd/corrupt-worktrees later to maint).
 185
 186 * The ownership rule for the file descriptor to fast-import remote
 187   backend was mixed up, leading to unrelated file descriptor getting
 188   closed, which has been fixed.
 189   (merge 3203566a71 mh/import-transport-fd-fix later to maint).
 190
 191 * A "merge -c" instruction during "git rebase --rebase-merges" should
 192   give the user a chance to edit the log message, even when there is
 193   otherwise no need to create a new merge and replace the existing
 194   one (i.e. fast-forward instead), but did not.  Which has been
 195   corrected.
 196
 197 * Code cleanup and futureproof.
 198   (merge 31f5256c82 ds/object-info-for-prefetch-fix later to maint).
 199
 200 * More parameter validation.
 201   (merge de99eb0c24 es/grep-require-name-when-needed later to maint).
 202
 203 * "git update-server-info" used to leave stale packfiles in its
 204   output, which has been corrected.
 205   (merge e941c48d49 ew/server-info-remove-crufts later to maint).
 206
 207 * The server side support for "git fetch" used to show incorrect
 208   value for the HEAD symbolic ref when the namespace feature is in
 209   use, which has been corrected.
 210   (merge 533e088250 jk/HEAD-symref-in-xfer-namespaces later to maint).
 211
 212 * "git am -i --resolved" segfaulted after trying to see a commit as
 213   if it were a tree, which has been corrected.
 214   (merge 7663e438c5 jk/am-i-resolved-fix later to maint).
 215
 216 * "git bundle verify" needs to see if prerequisite objects exist in
 217   the receiving repository, but the command did not check if we are
 218   in a repository upfront, which has been corrected.
 219   (merge 3bbbe467f2 js/bundle-verify-require-object-store later to maint).
 220
 221 * "git merge --squash" is designed to update the working tree and the
 222   index without creating the commit, and this cannot be countermanded
 223   by adding the "--commit" option; the command now refuses to work
 224   when both options are given.
 225   (merge 1d14d0c994 vv/merge-squash-with-explicit-commit later to maint).
 226
 227 * The data collected by fsmonitor was not properly written back to
 228   the on-disk index file, breaking t7519 tests occasionally, which
 229   has been corrected.
 230   (merge b5a8169752 js/fsmonitor-unflake later to maint).
 231
 232 * Update to Unicode 12.1 width table.
 233   (merge 5817f9caa3 bb/unicode-12.1-reiwa later to maint).
 234
 235 * The command line to invoke a "git cat-file" command from inside
 236   "git p4" was not properly quoted to protect a caret and running a
 237   broken command on Windows, which has been corrected.
 238   (merge c3f2358de3 mm/p4-unshelve-windows-fix later to maint).
 239
 240 * "git request-pull" learned to warn when the ref we ask them to pull
 241   from in the local repository and in the published repository are
 242   different.
 243   (merge 0454220d66 pb/request-pull-verify-remote-ref later to maint).
 244
 245 * When creating a partial clone, the object filtering criteria is
 246   recorded for the origin of the clone, but this incorrectly used a
 247   hardcoded name "origin" to name that remote; it has been corrected
 248   to honor the "--origin <name>" option.
 249   (merge 1c4a9f9114 xl/record-partial-clone-origin later to maint).
 250
 251 * "git fetch" into a lazy clone forgot to fetch base objects that are
 252   necessary to complete delta in a thin packfile, which has been
 253   corrected.
 254   (merge 810e19322d jt/partial-clone-missing-ref-delta-base later to maint).
 255
 256 * The filter_data used in the list-objects-filter (which manages a
 257   lazily sparse clone repository) did not use the dynamic array API
 258   correctly---'nr' is supposed to point at one past the last element
 259   of the array in use.  This has been corrected.
 260   (merge 7140600e2e md/list-objects-filter-memfix later to maint).
 261
 262 * The description about slashes in gitignore patterns (used to
 263   indicate things like "anchored to this level only" and "only
 264   matches directories") has been revamped.
 265   (merge 1a58bad014 an/ignore-doc-update later to maint).
 266
 267 * The URL decoding code has been updated to avoid going past the end
 268   of the string while parsing %-<hex>-<hex> sequence.
 269   (merge d37dc239a4 md/url-parse-harden later to maint).
 270
 271 * The list of for-each like macros used by clang-format has been
 272   updated.
 273   (merge fc7e03aace mo/clang-format-for-each-update later to maint).
 274
 275 * "git branch --list" learned to show branches that are checked out
 276   in other worktrees connected to the same repository prefixed with
 277   '+', similar to the way the currently checked out branch is shown
 278   with '*' in front.
 279   (merge 6e9381469e nb/branch-show-other-worktrees-head later to maint).
 280
 281 * Code restructuring during 2.20 period broke fetching tags via
 282   "import" based transports.
 283   (merge f80d922355 fc/fetch-with-import-fix later to maint).
 284
 285 * The commit-graph file is now part of the "files that the runtime
 286   may keep open file descriptors on, all of which would need to be
 287   closed when done with the object store", and the file descriptor to
 288   an existing commit-graph file now is closed before "gc" finalizes a
 289   new instance to replace it.
 290   (merge 2d511cfc0b ds/close-object-store later to maint).
 291
 292 * "git checkout -p" needs to selectively apply a patch in reverse,
 293   which did not work well.
 294   (merge 2bd69b9024 pw/add-p-recount later to maint).
 295
 296 * Code clean-up to avoid signed integer wraparounds during binary search.
 297   (merge 568a05c5ec rs/avoid-overflow-in-midpoint-computation later to maint).
 298
 299 * "git interpret-trailers" always treated '#' as the comment
 300   character, regardless of core.commentChar setting, which has been
 301   corrected.
 302   (merge 29c83fc23f jk/trailers-use-config later to maint).
 303
 304 * "git stash show 23" used to work, but no more after getting
 305   rewritten in C; this regression has been corrected.
 306   (merge 63b50c8ffe tg/stash-ref-by-index-fix later to maint).
 307
 308 * "git rebase --abort" used to leave refs/rewritten/ when concluding
 309   "git rebase -r", which has been corrected.
 310   (merge d559f502c5 pw/rebase-abort-clean-rewritten later to maint).
 311
 312 * An incorrect list of options was cached after command line
 313   completion failed (e.g. trying to complete a command that requires
 314   a repository outside one), which has been corrected.
 315   (merge 69702523af nd/completion-no-cache-failure later to maint).
 316
 317 * The code to parse scaled numbers out of configuration files has
 318   been made more robust and also easier to follow.
 319   (merge 39c575c969 rs/config-unit-parsing later to maint).
 320
 321 * The codepath to compute delta islands used to spew progress output
 322   without giving the callers any way to squelch it, which has been
 323   fixed.
 324   (merge bdbdf42f8a jk/delta-islands-progress-fix later to maint).
 325
 326 * Protocol capabilities that go over wire should never be translated,
 327   but it was incorrectly marked for translation, which has been
 328   corrected.  The output of protocol capabilities for debugging has
 329   been tweaked a bit.
 330
 331 * Use "Erase in Line" CSI sequence that is already used in the editor
 332   support to clear cruft in the progress output.
 333   (merge 5b12e3123b sg/rebase-progress later to maint).
 334
 335 * "git submodule foreach" did not protect command line options passed
 336   to the command to be run in each submodule correctly, when the
 337   "--recursive" option was in use.
 338   (merge 30db18b148 ms/submodule-foreach-fix later to maint).
 339
 340 * The configuration variable rebase.rescheduleFailedExec should be
 341   effective only while running an interactive rebase and should not
 342   affect anything when running an non-interactive one, which was not
 343   the case.  This has been corrected.
 344   (merge 906b63942a js/rebase-reschedule-applies-only-to-interactive later to maint).
 345
 346 * The "git clone" documentation refers to command line options in its
 347   description in the short form; they have been replaced with long
 348   forms to make them more recognisable.
 349   (merge bfc8c84ed5 qn/clone-doc-use-long-form later to maint).
 350
 351 * Generation of pack bitmaps are now disabled when .keep files exist,
 352   as these are mutually exclusive features.
 353   (merge 7328482253 ew/repack-with-bitmaps-by-default later to maint).
 354
 355 * "git rm" to resolve a conflicted path leaked an internal message
 356   "needs merge" before actually removing the path, which was
 357   confusing.  This has been corrected.
 358   (merge b2b1f615ce jc/denoise-rm-to-resolve later to maint).
 359
 360 * "git stash --keep-index" did not work correctly on paths that have
 361   been removed, which has been fixed.
 362   (merge b932f6a5e8 tg/stash-keep-index-with-removed-paths later to maint).
 363
 364 * Window 7 update ;-)
 365   (merge eb7c786314 js/mingw-spawn-with-spaces-in-path later to maint).
 366
 367 * A codepath that reads from GPG for signed object verification read
 368   past the end of allocated buffer, which has been fixed.
 369   (merge 64c45dc72e sr/gpg-interface-stop-at-the-end later to maint).
 370
 371 * "git clean" silently skipped a path when it cannot lstat() it; now
 372   it gives a warning.
 373   (merge b09364c47a js/clean-report-too-long-a-path later to maint).
 374
 375 * "git push --atomic" that goes over the transport-helper (namely,
 376   the smart http transport) failed to prevent refs to be pushed when
 377   it can locally tell that one of the ref update will fail without
 378   having to consult the other end, which has been corrected.
 379   (merge 2581ea3d31 es/local-atomic-push-failure-with-http later to maint).
 380
 381 * Other code cleanup, docfix, build fix, etc.
 382   (merge f547101b26 es/git-debugger-doc later to maint).
 383   (merge 7877ac3d7b js/bisect-helper-check-get-oid-return-value later to maint).
 384   (merge 0108f47eb3 sw/git-p4-unshelve-branched-files later to maint).
 385   (merge 9df8f734fd cm/send-email-document-req-modules later to maint).
 386   (merge afc3bf6eb1 ab/hash-object-doc later to maint).
 387   (merge 1fde99cfc7 po/doc-branch later to maint).
 388   (merge 459842e1c2 dl/config-alias-doc later to maint).
 389   (merge 5d137fc2c7 cb/fsmonitor-intfix later to maint).
 390   (merge 921d49be86 rs/copy-array later to maint).
 391   (merge cc8d872e69 js/t3404-typofix later to maint).
 392   (merge 729a9b558b cb/mkstemps-uint-type-fix later to maint).
 393   (merge 9dae4fe79f js/gcc-8-and-9 later to maint).
 394   (merge ed33bd8f30 js/t0001-case-insensitive later to maint).
 395   (merge dfa880e336 jw/gitweb-sample-update later to maint).
 396   (merge e532a90a9f sg/t5551-fetch-smart-error-is-translated later to maint).
 397   (merge 8d45ad8c29 jt/t5551-test-chunked later to maint).
 398   (merge 1a64e07d23 sg/git-C-empty-doc later to maint).
 399   (merge 37a2e35395 sg/ci-brew-gcc-workaround later to maint).
 400   (merge 24df0d49c4 js/trace2-signo-typofix later to maint).
 401   (merge fbec05c210 cc/test-oidmap later to maint).
 402   (merge 7926cee904 di/readme-markup-fix later to maint).
 403   (merge 02638d1e11 vn/xmmap-gently later to maint).
 404   (merge f7bf24d4dd rm/gpg-program-doc-fix later to maint).
 405   (merge 3aef54e8b8 js/unmap-before-ext-diff later to maint).