Merge branch 'sg/commit-graph-progress-fix' into master
[git] / Documentation / RelNotes / 2.28.0.txt
1 Git 2.28 Release Notes
2 ======================
3
4 Updates since v2.27
5 -------------------
6
7 Backward compatibility notes
8
9  * "fetch.writeCommitGraph" is deemed to be still a bit too risky and
10    is no longer part of the "feature.experimental" set.
11
12  * It used to be that setting extensions.* configuration variables
13    alone, while leaving core.repositoryFormatVersion=0, made these
14    settings effective, which was a wrong thing to do.  In version 0,
15    there was no special meaning in extensions.* configuration
16    variables.  This has been corrected.  If you need these repository
17    extensions to be effective, the core.repositoryFormatVersion
18    variable needs to be updated to 1 after vetting these extensions.*
19    variables are set correctly.
20
21
22 UI, Workflows & Features
23
24  * The commands in the "diff" family learned to honor "diff.relative"
25    configuration variable.
26
27  * The check in "git fsck" to ensure that the tree objects are sorted
28    still had corner cases it missed unsorted entries.
29
30  * The interface to redact sensitive information in the trace output
31    has been simplified.
32
33  * The command line completion (in contrib/) learned to complete
34    options that the "git switch" command takes.
35
36  * "git diff" used to take arguments in random and nonsense range
37    notation, e.g. "git diff A..B C", "git diff A..B C...D", etc.,
38    which has been cleaned up.
39
40  * "git diff-files" has been taught to say paths that are marked as
41    intent-to-add are new files, not modified from an empty blob.
42
43  * "git status" learned to report the status of sparse checkout.
44
45  * "git difftool" has trouble dealing with paths added to the index
46    with the intent-to-add bit.
47
48  * "git fast-export --anonymize" learned to take customized mapping to
49    allow its users to tweak its output more usable for debugging.
50
51  * The command line completion support (in contrib/) used to be
52    prepared to work with "set -u" but recent changes got a bit more
53    sloppy.  This has been corrected.
54
55
56 Performance, Internal Implementation, Development Support etc.
57
58  * Code optimization for a common case.
59    (merge 8777616e4d an/merge-single-strategy-optim later to maint).
60
61  * We've adopted a convention that any on-stack structure can be
62    initialized to have zero values in all fields with "= { 0 }",
63    even when the first field happens to be a pointer, but sparse
64    complained that a null pointer should be spelled NULL for a long
65    time.  Start using -Wno-universal-initializer option to squelch
66    it (the latest sparse has it on by default).
67
68  * "git log -L..." now takes advantage of the "which paths are touched
69    by this commit?" info stored in the commit-graph system.
70
71  * As FreeBSD is not the only platform whose regexp library reports
72    a REG_ILLSEQ error when fed invalid UTF-8, add logic to detect that
73    automatically and skip the affected tests.
74
75  * "git bugreport" learns to report what shell is in use.
76
77  * Support for GIT_CURL_VERBOSE has been rewritten in terms of
78    GIT_TRACE_CURL.
79
80  * Preliminary clean-ups around refs API, plus file format
81    specification documentation for the reftable backend.
82
83  * Workaround breakage in MSVC build, where "curl-config --cflags"
84    gives settings appropriate for GCC build.
85
86  * Code clean-up of "git clean" resulted in a fix of recent
87    performance regression.
88
89  * Code clean-up in the codepath that serves "git fetch" continues.
90
91  * "git merge-base --is-ancestor" is taught to take advantage of the
92    commit graph.
93
94  * Rewrite of parts of the scripted "git submodule" Porcelain command
95    continues; this time it is "git submodule set-branch" subcommand's
96    turn.
97
98  * The "fetch/clone" protocol has been updated to allow the server to
99    instruct the clients to grab pre-packaged packfile(s) in addition
100    to the packed object data coming over the wire.
101
102  * A misdesigned strbuf_write_fd() function has been retired.
103
104  * SHA-256 migration work continues, including CVS/SVN interface.
105
106  * A few fields in "struct commit" that do not have to always be
107    present have been moved to commit slabs.
108
109  * API cleanup for get_worktrees()
110
111  * By renumbering object flag bits, "struct object" managed to lose
112    bloated inter-field padding.
113
114  * The name of the primary branch in existing repositories, and the
115    default name used for the first branch in newly created
116    repositories, is made configurable, so that we can eventually wean
117    ourselves off of the hardcoded 'master'.
118
119  * The effort to avoid using test_must_fail on non-git command continues.
120
121
122 Fixes since v2.27
123 -----------------
124
125  * The "--prepare-p4-only" option of "git p4" is supposed to stop
126    after replaying one changeset, but kept going (by mistake?)
127
128  * The error message from "git checkout -b foo -t bar baz" was
129    confusing.
130
131  * Some repositories in the wild have commits that record nonsense
132    committer timezone (e.g. rails.git); "git fast-import" learned an
133    option to pass these nonsense timestamps intact to allow recreating
134    existing repositories as-is.
135    (merge d42a2fb72f en/fast-import-looser-date later to maint).
136
137  * The command line completion script (in contrib/) tried to complete
138    "git stash -p" as if it were "git stash push -p", but it was too
139    aggressive and also affected "git stash show -p", which has been
140    corrected.
141    (merge fffd0cf520 vs/complete-stash-show-p-fix later to maint).
142
143  * On-the-wire protocol v2 easily falls into a deadlock between the
144    remote-curl helper and the fetch-pack process when the server side
145    prematurely throws an error and disconnects.  The communication has
146    been updated to make it more robust.
147
148  * "git checkout -p" did not handle a newly added path at all.
149    (merge 2c8bd8471a js/checkout-p-new-file later to maint).
150
151  * The code to parse "git bisect start" command line was lax in
152    validating the arguments.
153    (merge 4d9005ff5d cb/bisect-helper-parser-fix later to maint).
154
155  * Reduce memory usage during "diff --quiet" in a worktree with too
156    many stat-unmatched paths.
157    (merge d2d7fbe129 jk/diff-memuse-optim-with-stat-unmatch later to maint).
158
159  * The reflog entries for "git clone" and "git fetch" did not
160    anonymize the URL they operated on.
161    (merge 46da295a77 js/reflog-anonymize-for-clone-and-fetch later to maint).
162
163  * The behaviour of "sparse-checkout" in the state "git clone
164    --no-checkout" left was changed accidentally in 2.27, which has
165    been corrected.
166
167  * Use of negative pathspec, while collecting paths including
168    untracked ones in the working tree, was broken.
169
170  * The same worktree directory must be registered only once, but
171    "git worktree move" allowed this invariant to be violated, which
172    has been corrected.
173    (merge 810382ed37 es/worktree-duplicate-paths later to maint).
174
175  * The effect of sparse checkout settings on submodules is documented.
176    (merge e7d7c73249 en/sparse-with-submodule-doc later to maint).
177
178  * Code clean-up around "git branch" with a minor bugfix.
179    (merge dc44639904 dl/branch-cleanup later to maint).
180
181  * A branch name used in a test has been clarified to match what is
182    going on.
183    (merge 08dc26061f pb/t4014-unslave later to maint).
184
185  * An in-code comment in "git diff" has been updated.
186    (merge c592fd4c83 dl/diff-usage-comment-update later to maint).
187
188  * The documentation and some tests have been adjusted for the recent
189    renaming of "pu" branch to "seen".
190    (merge 6dca5dbf93 js/pu-to-seen later to maint).
191
192  * The code to push changes over "dumb" HTTP had a bad interaction
193    with the commit reachability code due to incorrect allocation of
194    object flag bits, which has been corrected.
195    (merge 64472d15e9 bc/http-push-flagsfix later to maint).
196
197  * "git send-email --in-reply-to=<msg>" did not use the In-Reply-To:
198    header with the value given from the command line, and let it be
199    overridden by the value on In-Reply-To: header in the messages
200    being sent out (if exists).
201    (merge f9f60d7066 ra/send-email-in-reply-to-from-command-line-wins later to maint).
202
203  * "git log -Lx,y:path --before=date" lost track of where the range
204    should be because it didn't take the changes made by the youngest
205    commits that are omitted from the output into account.
206
207  * When "fetch.writeCommitGraph" configuration is set in a shallow
208    repository and a fetch moves the shallow boundary, we wrote out
209    broken commit-graph files that do not match the reality, which has
210    been corrected.
211
212  * "git checkout" failed to catch an error from fstat() after updating
213    a path in the working tree.
214    (merge 35e6e212fd mt/entry-fstat-fallback-fix later to maint).
215
216  * Other code cleanup, docfix, build fix, etc.
217    (merge 2c31a7aa44 jx/pkt-line-doc-count-fix later to maint).
218    (merge d63ae31962 cb/t5608-cleanup later to maint).
219    (merge 788db145c7 dl/t-readme-spell-git-correctly later to maint).
220    (merge 45a87a83bb dl/python-2.7-is-the-floor-version later to maint).
221    (merge b75a219904 es/advertise-contribution-doc later to maint).
222    (merge 0c9a4f638a rs/pull-leakfix later to maint).
223    (merge d546fe2874 rs/commit-reach-leakfix later to maint).
224    (merge 087bf5409c mk/pb-pretty-email-without-domain-part-fix later to maint).
225    (merge 5f4ee57ad9 es/worktree-code-cleanup later to maint).
226    (merge 0172f7834a cc/cat-file-usage-update later to maint).
227    (merge 81de0c01cf ma/rebase-doc-typofix later to maint).