refs: update ref transactions to use struct object_id
[alt-git.git] / Documentation / RelNotes / 2.15.0.txt
blob748f3c9980f857f7e12ccf6069e6408e6e3c1e35
1 Git 2.15 Release Notes
2 ======================
4 Backward compatibility notes and other notable changes.
6  * Use of an empty string as a pathspec element that is used for
7    'everything matches' is still warned and Git asks users to use a
8    more explicit '.' for that instead.  The hope is that existing
9    users will not mind this change, and eventually the warning can be
10    turned into a hard error, upgrading the deprecation into removal of
11    this (mis)feature.  That is now scheduled to happen in Git v2.16,
12    the next major release after this one.
14  * Git now avoids blindly falling back to ".git" when the setup
15    sequence said we are _not_ in Git repository.  A corner case that
16    happens to work right now may be broken by a call to BUG().
17    We've tried hard to locate such cases and fixed them, but there
18    might still be cases that need to be addressed--bug reports are
19    greatly appreciated.
21  * "branch --set-upstream" that has been deprecated in Git 1.8 has
22    finally been retired.
25 Updates since v2.14
26 -------------------
28 UI, Workflows & Features
30  * An example that is now obsolete has been removed from a sample hook,
31    and an old example in it that added a sign-off manually has been
32    improved to use the interpret-trailers command.
34  * The advice message given when "git rebase" stops for conflicting
35    changes has been improved.
37  * The "rerere-train" script (in contrib/) learned the "--overwrite"
38    option to allow overwriting existing recorded resolutions.
40  * "git contacts" (in contrib/) now lists the address on the
41    "Reported-by:" trailer to its output, in addition to those on
42    S-o-b: and other trailers, to make it easier to notify (and thank)
43    the original bug reporter.
45  * "git rebase", especially when it is run by mistake and ends up
46    trying to replay many changes, spent long time in silence.  The
47    command has been taught to show progress report when it spends
48    long time preparing these many changes to replay (which would give
49    the user a chance to abort with ^C).
51  * "git merge" learned a "--signoff" option to add the Signed-off-by:
52    trailer with the committer's name.
54  * "git diff" learned to optionally paint new lines that are the same
55    as deleted lines elsewhere differently from genuinely new lines.
57  * "git interpret-trailers" learned to take the trailer specifications
58    from the command line that overrides the configured values.
60  * "git interpret-trailers" has been taught a "--parse" and a few
61    other options to make it easier for scripts to grab existing
62    trailer lines from a commit log message.
64  * The "--format=%(trailers)" option "git log" and its friends take
65    learned to take the 'unfold' and 'only' modifiers to normalize its
66    output, e.g. "git log --format=%(trailers:only,unfold)".
68  * "gitweb" shows a link to visit the 'raw' contents of blbos in the
69    history overview page.
71  * "[gc] rerereResolved = 5.days" used to be invalid, as the variable
72    is defined to take an integer counting the number of days.  It now
73    is allowed.
75  * The code to acquire a lock on a reference (e.g. while accepting a
76    push from a client) used to immediately fail when the reference is
77    already locked---now it waits for a very short while and retries,
78    which can make it succeed if the lock holder was holding it during
79    a read-only operation.
81  * "branch --set-upstream" that has been deprecated in Git 1.8 has
82    finally been retired.
84  * The codepath to call external process filter for smudge/clean
85    operation learned to show the progress meter.
87  * "git rev-parse" learned "--is-shallow-repository", that is to be
88    used in a way similar to existing "--is-bare-repository" and
89    friends.
91  * "git describe --match <pattern>" has been taught to play well with
92    the "--all" option.
94  * "git branch" learned "-c/-C" to create a new branch by copying an
95    existing one.
97  * Some commands (most notably "git status") makes an opportunistic
98    update when performing a read-only operation to help optimize later
99    operations in the same repository.  The new "--no-optional-locks"
100    option can be passed to Git to disable them.
102  * "git for-each-ref --format=..." learned a new format element,
103    %(trailers), to show only the commit log trailer part of the log
104    message.
107 Performance, Internal Implementation, Development Support etc.
109  * Conversion from uchar[20] to struct object_id continues.
111  * Start using selected c99 constructs in small, stable and
112    essentialpart of the system to catch people who care about
113    older compilers that do not grok them.
115  * The filter-process interface learned to allow a process with long
116    latency give a "delayed" response.
118  * Many uses of comparision callback function the hashmap API uses
119    cast the callback function type when registering it to
120    hashmap_init(), which defeats the compile time type checking when
121    the callback interface changes (e.g. gaining more parameters).
122    The callback implementations have been updated to take "void *"
123    pointers and cast them to the type they expect instead.
125  * Because recent Git for Windows do come with a real msgfmt, the
126    build procedure for git-gui has been updated to use it instead of a
127    hand-rolled substitute.
129  * "git grep --recurse-submodules" has been reworked to give a more
130    consistent output across submodule boundary (and do its thing
131    without having to fork a separate process).
133  * A helper function to read a single whole line into strbuf
134    mistakenly triggered OOM error at EOF under certain conditions,
135    which has been fixed.
136    (merge 642956cf45 rs/strbuf-getwholeline-fix later to maint).
138  * The "ref-store" code reorganization continues.
140  * "git commit" used to discard the index and re-read from the filesystem
141    just in case the pre-commit hook has updated it in the middle; this
142    has been optimized out when we know we do not run the pre-commit hook.
143    (merge 680ee550d7 kw/commit-keep-index-when-pre-commit-is-not-run later to maint).
145  * Updates to the HTTP layer we made recently unconditionally used
146    features of libCurl without checking the existence of them, causing
147    compilation errors, which has been fixed.  Also migrate the code to
148    check feature macros, not version numbers, to cope better with
149    libCurl that vendor ships with backported features.
151  * The API to start showing progress meter after a short delay has
152    been simplified.
153    (merge 8aade107dd jc/simplify-progress later to maint).
155  * Code clean-up to avoid mixing values read from the .gitmodules file
156    and values read from the .git/config file.
158  * We used to spend more than necessary cycles allocating and freeing
159    piece of memory while writing each index entry out.  This has been
160    optimized.
162  * Platforms that ship with a separate sha1 with collision detection
163    library can link to it instead of using the copy we ship as part of
164    our source tree.
166  * Code around "notes" have been cleaned up.
167    (merge 3964281524 mh/notes-cleanup later to maint).
169  * The long-standing rule that an in-core lockfile instance, once it
170    is used, must not be freed, has been lifted and the lockfile and
171    tempfile APIs have been updated to reduce the chance of programming
172    errors.
174  * Our hashmap implementation in hashmap.[ch] is not thread-safe when
175    adding a new item needs to expand the hashtable by rehashing; add
176    an API to disable the automatic rehashing to work it around.
178  * Many of our programs consider that it is OK to release dynamic
179    storage that is used throughout the life of the program by simply
180    exiting, but this makes it harder to leak detection tools to avoid
181    reporting false positives.  Plug many existing leaks and introduce
182    a mechanism for developers to mark that the region of memory
183    pointed by a pointer is not lost/leaking to help these tools.
185  * As "git commit" to conclude a conflicted "git merge" honors the
186    commit-msg hook, "git merge" that records a merge commit that
187    cleanly auto-merges should, but it didn't.
189  * The codepath for "git merge-recursive" has been cleaned up.
191  * Many leaks of strbuf have been fixed.
193  * "git imap-send" has our own implementation of the protocol and also
194    can use more recent libCurl with the imap protocol support.  Update
195    the latter so that it can use the credential subsystem, and then
196    make it the default option to use, so that we can eventually
197    deprecate and remove the former.
199  * "make style" runs git-clang-format to help developers by pointing
200    out coding style issues.
202  * A test to demonstrate "git mv" failing to adjust nested submodules
203    has been added.
204    (merge c514167df2 hv/mv-nested-submodules-test later to maint).
206  * On Cygwin, "ulimit -s" does not report failure but it does not work
207    at all, which causes an unexpected success of some tests that
208    expect failures under a limited stack situation.  This has been
209    fixed.
211  * Many codepaths have been updated to squelch -Wimplicit-fallthrough
212    warnings from Gcc 7 (which is a good code hygiene).
214  * Add a helper for DLL loading in anticipation for its need in a
215    future topic RSN.
217  * "git status --ignored", when noticing that a directory without any
218    tracked path is ignored, still enumerated all the ignored paths in
219    the directory, which is unnecessary.  The codepath has been
220    optimized to avoid this overhead.
222  * The final batch to "git rebase -i" updates to move more code from
223    the shell script to C has been merged.
225  * Operations that do not touch (majority of) packed refs have been
226    optimized by making accesses to packed-refs file lazy; we no longer
227    pre-parse everything, and an access to a single ref in the
228    packed-refs does not touch majority of irrelevant refs, either.
230  * Add comment to clarify that the style file is meant to be used with
231    clang-5 and the rules are still work in progress.
233  * Many variables that points at a region of memory that will live
234    throughout the life of the program have been marked with UNLEAK
235    marker to help the leak checkers concentrate on real leaks..
237  * Plans for weaning us off of SHA-1 has been documented.
239  * A new "oidmap" API has been introduced and oidset API has been
240    rewritten to use it.
243 Also contains various documentation updates and code clean-ups.
246 Fixes since v2.14
247 -----------------
249  * "%C(color name)" in the pretty print format always produced ANSI
250    color escape codes, which was an early design mistake.  They now
251    honor the configuration (e.g. "color.ui = never") and also tty-ness
252    of the output medium.
254  * The http.{sslkey,sslCert} configuration variables are to be
255    interpreted as a pathname that honors "~[username]/" prefix, but
256    weren't, which has been fixed.
258  * Numerous bugs in walking of reflogs via "log -g" and friends have
259    been fixed.
261  * "git commit" when seeing an totally empty message said "you did not
262    edit the message", which is clearly wrong.  The message has been
263    corrected.
265  * When a directory is not readable, "gitweb" fails to build the
266    project list.  Work this around by skipping such a directory.
268  * Some versions of GnuPG fails to kill gpg-agent it auto-spawned
269    and such a left-over agent can interfere with a test.  Work it
270    around by attempting to kill one before starting a new test.
272  * A recently added test for the "credential-cache" helper revealed
273    that EOF detection done around the time the connection to the cache
274    daemon is torn down were flaky.  This was fixed by reacting to
275    ECONNRESET and behaving as if we got an EOF.
277  * "git log --tag=no-such-tag" showed log starting from HEAD, which
278    has been fixed---it now shows nothing.
280  * The "tag.pager" configuration variable was useless for those who
281    actually create tag objects, as it interfered with the use of an
282    editor.  A new mechanism has been introduced for commands to enable
283    pager depending on what operation is being carried out to fix this,
284    and then "git tag -l" is made to run pager by default.
286  * "git push --recurse-submodules $there HEAD:$target" was not
287    propagated down to the submodules, but now it is.
289  * Commands like "git rebase" accepted the --rerere-autoupdate option
290    from the command line, but did not always use it.  This has been
291    fixed.
293  * "git clone --recurse-submodules --quiet" did not pass the quiet
294    option down to submodules.
296  * Test portability fix for OBSD.
298  * Portability fix for OBSD.
300  * "git am -s" has been taught that some input may end with a trailer
301    block that is not Signed-off-by: and it should refrain from adding
302    an extra blank line before adding a new sign-off in such a case.
304  * "git svn" used with "--localtime" option did not compute the tz
305    offset for the timestamp in question and instead always used the
306    current time, which has been corrected.
308  * Memory leak in an error codepath has been plugged.
310  * "git stash -u" used the contents of the committed version of the
311    ".gitignore" file to decide which paths are ignored, even when the
312    file has local changes.  The command has been taught to instead use
313    the locally modified contents.
315  * bash 4.4 or newer gave a warning on NUL byte in command
316    substitution done in "git stash"; this has been squelched.
318  * "git grep -L" and "git grep --quiet -L" reported different exit
319    codes; this has been corrected.
321  * When handshake with a subprocess filter notices that the process
322    asked for an unknown capability, Git did not report what program
323    the offending subprocess was running.  This has been corrected.
325  * "git apply" that is used as a better "patch -p1" failed to apply a
326    taken from a file with CRLF line endings to a file with CRLF line
327    endings.  The root cause was because it misused convert_to_git()
328    that tried to do "safe-crlf" processing by looking at the index
329    entry at the same path, which is a nonsense---in that mode, "apply"
330    is not working on the data in (or derived from) the index at all.
331    This has been fixed.
333  * Killing "git merge --edit" before the editor returns control left
334    the repository in a state with MERGE_MSG but without MERGE_HEAD,
335    which incorrectly tells the subsequent "git commit" that there was
336    a squash merge in progress.  This has been fixed.
338  * "git archive" did not work well with pathspecs and the
339    export-ignore attribute.
341  * In addition to "cc: <a@dd.re.ss> # cruft", "cc: a@dd.re.ss # cruft"
342    was taught to "git send-email" as a valid way to tell it that it
343    needs to also send a carbon copy to <a@dd.re.ss> in the trailer
344    section.
345    (merge cc90750677 mm/send-email-cc-cruft later to maint).
347  * "git branch -M a b" while on a branch that is completely unrelated
348    to either branch a or branch b misbehaved when multiple worktree
349    was in use.  This has been fixed.
350    (merge 31824d180d nd/worktree-kill-parse-ref later to maint).
352  * "git gc" and friends when multiple worktrees are used off of a
353    single repository did not consider the index and per-worktree refs
354    of other worktrees as the root for reachability traversal, making
355    objects that are in use only in other worktrees to be subject to
356    garbage collection.
358  * A regression to "gitk --bisect" by a recent update has been fixed.
359    (merge 1d0538e486 mh/packed-ref-store-prep later to maint).
361  * "git -c submodule.recurse=yes pull" did not work as if the
362    "--recurse-submodules" option was given from the command line.
363    This has been corrected.
365  * Unlike "git commit-tree < file", "git commit-tree -F file" did not
366    pass the contents of the file verbatim and instead completed an
367    incomplete line at the end, if exists.  The latter has been updated
368    to match the behaviour of the former.
369    (merge c818e74332 rk/commit-tree-make-F-verbatim later to maint).
371  * Many codepaths did not diagnose write failures correctly when disks
372    go full, due to their misuse of write_in_full() helper function,
373    which have been corrected.
374    (merge f48ecd38cb jk/write-in-full-fix later to maint).
376  * "git help co" now says "co is aliased to ...", not "git co is".
377    (merge b3a8076e0d ks/help-alias-label later to maint).
379  * "git archive", especially when used with pathspec, stored an empty
380    directory in its output, even though Git itself never does so.
381    This has been fixed.
382    (merge 4318094047 rs/archive-excluded-directory later to maint).
384  * API error-proofing which happens to also squelch warnings from GCC.
385    (merge c788c54cde tg/refs-allowed-flags later to maint).
387  * The explanation of the cut-line in the commit log editor has been
388    slightly tweaked.
389    (merge 8c4b1a3593 ks/commit-do-not-touch-cut-line later to maint).
391  * "git gc" tries to avoid running two instances at the same time by
392    reading and writing pid/host from and to a lock file; it used to
393    use an incorrect fscanf() format when reading, which has been
394    corrected.
395    (merge afe2fab72c aw/gc-lockfile-fscanf-fix later to maint).
397  * The scripts to drive TravisCI has been reorganized and then an
398    optimization to avoid spending cycles on a branch whose tip is
399    tagged has been implemented.
400    (merge 8376eb4a8f ls/travis-scriptify later to maint).
402  * The test linter has been taught that we do not like "echo -e".
403    (merge 1a6d46895d tb/test-lint-echo-e later to maint).
405  * Code cmp.std.c nitpick.
406    (merge ac7da78ede mh/for-each-string-list-item-empty-fix later to maint).
408  * A regression fix for 2.11 that made the code to read the list of
409    alternate object stores overrun the end of the string.
410    (merge f0f7bebef7 jk/info-alternates-fix later to maint).
412  * "git describe --match" learned to take multiple patterns in v2.13
413    series, but the feature ignored the patterns after the first one
414    and did not work at all.  This has been fixed.
415    (merge da769d2986 jk/describe-omit-some-refs later to maint).
417  * "git filter-branch" cannot reproduce a history with a tag without
418    the tagger field, which only ancient versions of Git allowed to be
419    created.  This has been corrected.
420    (merge b2c1ca6b4b ic/fix-filter-branch-to-handle-tag-without-tagger later to maint).
422  * "git cat-file --textconv" started segfaulting recently, which
423    has been corrected.
424    (merge cc0ea7c9e5 jk/diff-blob later to maint).
426  * The built-in pattern to detect the "function header" for HTML did
427    not match <H1>..<H6> elements without any attributes, which has
428    been fixed.
429    (merge 9c03caca2c ik/userdiff-html-h-element-fix later to maint).
431  * "git mailinfo" was loose in decoding quoted printable and produced
432    garbage when the two letters after the equal sign are not
433    hexadecimal.  This has been fixed.
434    (merge c8cf423eab rs/mailinfo-qp-decode-fix later to maint).
436  * The machinery to create xdelta used in pack files received the
437    sizes of the data in size_t, but lost the higher bits of them by
438    storing them in "unsigned int" during the computation, which is
439    fixed.
441  * The delta format used in the packfile cannot reference data at
442    offset larger than what can be expressed in 4-byte, but the
443    generator for the data failed to make sure the offset does not
444    overflow.  This has been corrected.
446  * The documentation for '-X<option>' for merges was misleadingly
447    written to suggest that "-s theirs" exists, which is not the case.
448    (merge c25d98b2a7 jc/merge-x-theirs-docfix later to maint).
450  * "git fast-export" with -M/-C option issued "copy" instruction on a
451    path that is simultaneously modified, which was incorrect.
452    (merge b3e8ca89cf jt/fast-export-copy-modify-fix later to maint).
454  * Many codepaths have been updated to squelch -Wsign-compare
455    warnings.
456    (merge 071bcaab64 rj/no-sign-compare later to maint).
458  * Memory leaks in various codepaths have been plugged.
459    (merge 4d01a7fa65 ma/leakplugs later to maint).
461  * Recent versions of "git rev-parse --parseopt" did not parse the
462    option specification that does not have the optional flags (*=?!)
463    correctly, which has been corrected.
464    (merge a6304fa4c2 bc/rev-parse-parseopt-fix later to maint).
466  * The checkpoint command "git fast-import" did not flush updates to
467    refs and marks unless at least one object was created since the
468    last checkpoint, which has been corrected, as these things can
469    happen without any new object getting created.
470    (merge 30e215a65c er/fast-import-dump-refs-on-checkpoint later to maint).
472  * Spell the name of our system as "Git" in the output from
473    request-pull script.
474    (merge e66d7c37a5 ar/request-pull-phrasofix later to maint).
476  * Fixes for a handful memory access issues identified by valgrind.
477    (merge 2944a94c6b tg/memfixes later to maint).
479  * Backports a moral equivalent of 2015 fix to the poll() emulation
480    from the upstream gnulib to fix occasional breakages on HPE NonStop.
481    (merge 61b2a1acaa rb/compat-poll-fix later to maint).
483  * Users with "color.ui = always" in their configuration were broken
484    by a recent change that made plumbing commands to pay attention to
485    them as the patch created internally by "git add -p" were colored
486    (heh) and made unusable.  Fix this regression by redefining
487    'always' to mean the same thing as 'auto'.
488    (merge 6be4595edb jk/ui-color-always-to-auto-maint later to maint).
490  * In the "--format=..." option of the "git for-each-ref" command (and
491    its friends, i.e. the listing mode of "git branch/tag"), "%(atom:)"
492    (e.g. "%(refname:)", "%(body:)" used to error out.  Instead, treat
493    them as if the colon and an empty string that follows it were not
494    there.
495    (merge bea4dbeafd tb/ref-filter-empty-modifier later to maint).
497  * An ancient bug that made Git misbehave with creation/renaming of
498    refs has been fixed.
500  * Other minor doc, test and build updates and code cleanups.
501    (merge f094b89a4d ma/parse-maybe-bool later to maint).
502    (merge 39b00fa4d4 jk/drop-sha1-entry-pos later to maint).
503    (merge 6cdf8a7929 ma/ts-cleanups later to maint).
504    (merge 7560f547e6 ma/up-to-date later to maint).
505    (merge 0db3dc75f3 rs/apply-epoch later to maint).
506    (merge 74f1bd912b dw/diff-highlight-makefile-fix later to maint).
507    (merge f991761eb8 jk/config-lockfile-leak-fix later to maint).
508    (merge 150efef1e7 ma/pkt-line-leakfix later to maint).
509    (merge 5554451de6 mg/timestamp-t-fix later to maint).
510    (merge 276d0e35c0 ma/split-symref-update-fix later to maint).
511    (merge 3bc4b8f7c7 bb/doc-eol-dirty later to maint).
512    (merge c1bb33c99c jk/system-path-cleanup later to maint).
513    (merge ab46e6fc72 cc/subprocess-handshake-missing-capabilities later to maint).
514    (merge f7a32dd97f kd/doc-for-each-ref later to maint).
515    (merge be94568bc7 ez/doc-duplicated-words-fix later to maint).
516    (merge 01e4be6c3d ks/test-readme-phrasofix later to maint).
517    (merge 217bb56d4f hn/typofix later to maint).
518    (merge c08fd6388c jk/doc-read-tree-table-asciidoctor-fix later to maint).
519    (merge c3342b362e ks/doc-use-camelcase-for-config-name later to maint).
520    (merge 0bca165fdb jk/validate-headref-fix later to maint).
521    (merge 93dbefb389 mr/doc-negative-pathspec later to maint).
522    (merge 5e633326e4 ad/doc-markup-fix later to maint).
523    (merge 9ca356fa8b rs/cocci-de-paren-call-params later to maint).
524    (merge 7099153e8d rs/tag-null-pointer-arith-fix later to maint).
525    (merge 0e187d758c rs/run-command-use-alloc-array later to maint).
526    (merge e0222159fa jn/strbuf-doc-re-reuse later to maint).
527    (merge 97487ea11a rs/qsort-s later to maint).
528    (merge a9155c50bd sb/branch-avoid-repeated-strbuf-release later to maint).
529    (merge f777623514 ks/branch-tweak-error-message-for-extra-args later to maint).
530    (merge 33f3c683ec ks/verify-filename-non-option-error-message-tweak later to maint).
531    (merge b3ea7dd32d jk/sha1-loose-object-info-fix later to maint).
532    (merge 2720f6db5d rs/fsck-null-return-from-lookup later to maint).
533    (merge 99b7b687a6 rs/rs-mailmap later to maint).
534    (merge 7823655082 tb/complete-describe later to maint).
535    (merge 7cbbf9d6a2 ls/filter-process-delayed later to maint).