git-compat-util: always enable variadic macros
[git] / Documentation / RelNotes / 2.31.0.txt
1 Git 2.31 Release Notes
2 ======================
3
4 Updates since v2.30
5 -------------------
6
7 Backward incompatible and other important changes
8
9  * The "pack-redundant" command, which has been left stale with almost
10    unusable performance issues, now warns loudly when it gets used, as
11    we no longer want to recommend its use (instead just "repack -d"
12    instead).
13
14  * The development community has adopted Contributor Covenant v2.0 to
15    update from v1.4 that we have been using.
16
17
18 UI, Workflows & Features
19
20  * The "--format=%(trailers)" mechanism gets enhanced to make it
21    easier to design output for machine consumption.
22
23  * When a user does not tell "git pull" to use rebase or merge, the
24    command gives a loud message telling a user to choose between
25    rebase or merge but creates a merge anyway, forcing users who would
26    want to rebase to redo the operation.  Fix an early part of this
27    problem by tightening the condition to give the message---there is
28    no reason to stop or force the user to choose between rebase or
29    merge if the history fast-forwards.
30
31  * The configuration variable 'core.abbrev' can be set to 'no' to
32    force no abbreviation regardless of the hash algorithm.
33
34  * "git rev-parse" can be explicitly told to give output as absolute
35    or relative path with the `--path-format=(absolute|relative)` option.
36
37  * Bash completion (in contrib/) update to make it easier for
38    end-users to add completion for their custom "git" subcommands.
39
40  * "git maintenance" learned to drive scheduled maintenance on
41    platforms whose native scheduling methods are not 'cron'.
42
43  * After expiring a reflog and making a single commit, the reflog for
44    the branch would record a single entry that knows both @{0} and
45    @{1}, but we failed to answer "what commit were we on?", i.e. @{1}
46
47  * "git bundle" learns "--stdin" option to read its refs from the
48    standard input.  Also, it now does not lose refs whey they point
49    at the same object.
50
51 Performance, Internal Implementation, Development Support etc.
52
53  * A 3-year old test that was not testing anything useful has been
54    corrected.
55
56  * Retire more names with "sha1" in it.
57
58  * The topological walk codepath is covered by new trace2 stats.
59
60  * Update the Code-of-conduct to version 2.0 from the upstream (we've
61    been using version 1.4).
62
63  * "git mktag" validates its input using its own rules before writing
64    a tag object---it has been updated to share the logic with "git
65    fsck".
66
67  * Two new ways to feed configuration variable-value pairs via
68    environment variables have been introduced, and the way
69    GIT_CONFIG_PARAMETERS encodes variable/value pairs has been tweaked
70    to make it more robust.
71
72  * Tests have been updated so that they do not to get affected by the
73    name of the default branch "git init" creates.
74
75  * "git fetch" learns to treat ref updates atomically in all-or-none
76    fashion, just like "git push" does, with the new "--atomic" option.
77
78
79 Fixes since v2.30
80 -----------------
81
82  * Diagnose command line error of "git rebase" early.
83    (merge ca5120c339 rs/rebase-commit-validation later to maint).
84
85  * Clean up option descriptions in "git cmd --help".
86    (merge e73fe3dd02 zh/arg-help-format later to maint).
87
88  * "git stash" did not work well in a sparsely checked out working
89    tree.
90    (merge ba359fd507 en/stash-apply-sparse-checkout later to maint).
91
92  * Some tests expect that "ls -l" output has either '-' or 'x' for
93    group executable bit, but setgid bit can be inherited from parent
94    directory and make these fields 'S' or 's' instead, causing test
95    failures.
96    (merge ea8bbf2a4e mt/t4129-with-setgid-dir later to maint).
97
98  * "git for-each-repo --config=<var> <cmd>" should not run <cmd> for
99    any repository when the configuration variable <var> is not defined
100    even once.
101    (merge 6c62f01552 ds/for-each-repo-noopfix later to maint).
102
103  * Fix 2.29 regression where "git mergetool --tool-help" fails to list
104    all the available tools.
105    (merge 80f5a16798 pb/mergetool-tool-help-fix later to maint).
106
107  * Fix for procedure to building CI test environment for mac.
108    (merge 3831132ace jc/macos-install-dependencies-fix later to maint).
109
110  * The implementation of "git branch --sort" wrt the detached HEAD
111    display has always been hacky, which has been cleaned up.
112    (merge 4045f659bd ab/branch-sort later to maint).
113
114  * Newline characters in the host and path part of git:// URL are
115    now forbidden.
116    (merge 6aed56736b jk/forbid-lf-in-git-url later to maint).
117
118  * "git diff" showed a submodule working tree with untracked cruft as
119    "Submodule commit <objectname>-dirty", but a natural expectation is
120    that the "-dirty" indicator would align with "git describe --dirty",
121    which does not consider having untracked files in the working tree
122    as source of dirtiness.  The inconsistency has been fixed.
123
124  * When more than one commit with the same patch ID appears on one
125    side, "git log --cherry-pick A...B" did not exclude them all when a
126    commit with the same patch ID appears on the other side.  Now it
127    does.
128    (merge c9e3a4e76d jk/log-cherry-pick-duplicate-patches later to maint).
129
130  * Other code cleanup, docfix, build fix, etc.
131    (merge 505a276596 pk/subsub-fetch-fix-take-2 later to maint).
132    (merge 33fc56253b fc/t6030-bisect-reset-removes-auxiliary-files later to maint).
133    (merge 7efc378205 ta/doc-typofix later to maint).
134    (merge 1f4e9319c7 pb/doc-modules-git-work-tree-typofix later to maint).
135    (merge 04f6b0a192 ma/t1300-cleanup later to maint).
136    (merge 7b77f5a13e ma/doc-pack-format-varint-for-sizes later to maint).
137    (merge cc2d43be2b nk/perf-fsmonitor-cleanup later to maint).
138    (merge c8302c6c00 ar/t6016-modernise later to maint).
139    (merge 0454986e78 jc/sign-off later to maint).
140    (merge 155067ab4f vv/send-email-with-less-secure-apps-access later to maint).
141    (merge acaabcf391 jk/t5516-deflake later to maint).
142    (merge a1e03535db ad/t4129-setfacl-target-fix later to maint).
143    (merge b356d23638 ug/doc-lose-dircache later to maint).
144    (merge 9371c0e9dd ab/gettext-charset-comment-fix later to maint).
145    (merge 52fc4f195c dl/p4-encode-after-kw-expansion later to maint).
146    (merge 4eb56b56e7 bc/doc-status-short later to maint).
147    (merge a4a1ca22ef tb/local-clone-race-doc later to maint).
148    (merge 6a8c89d053 ma/more-opaque-lock-file later to maint).