Merge branch 'js/t3404-grammo-fix'
[git/git-svn.git] / Documentation / RelNotes / 2.10.0.txt
blob4783e25ce118f12edd27a7db06611dd10ef7f3de
1 Git 2.10 Release Notes
2 ======================
4 Backward compatibility notes
5 ----------------------------
7 Updates since v2.9
8 ------------------
10 UI, Workflows & Features
12  * "git pull --rebase --verify-signature" learned to warn the user
13    that "--verify-signature" is a no-op when rebasing.
15  * An upstream project can make a recommendation to shallowly clone
16    some submodules in the .gitmodules file it ships.
18  * "git worktree add" learned that '-' can be used as a short-hand for
19    "@{-1}", the previous branch.
21  * Update the funcname definition to support css files.
23  * The completion script (in contrib/) learned to complete "git
24    status" options.
26  * Messages that are generated by auto gc during "git push" on the
27    receiving end are now passed back to the sending end in such a way
28    that they are shown with "remote: " prefix to avoid confusing the
29    users.
31  * "git add -i/-p" learned to honor diff.compactionHeuristic
32    experimental knob, so that the user can work on the same hunk split
33    as "git diff" output.
34    (merge 46e3d17 jk/add-i-diff-compact-heuristics later to maint).
36  * "upload-pack" allows a custom "git pack-objects" replacement when
37    responding to "fetch/clone" via the uploadpack.packObjectsHook.
38    (merge 20b20a2 jk/upload-pack-hook later to maint).
40  * Teach format-patch and mailsplit (hence "am") how a line that
41    happens to begin with "From " in the e-mail message is quoted with
42    ">", so that these lines can be restored to their original shape.
43    (merge d9925d1 ew/mboxrd-format-am later to maint).
45  * "git repack" learned the "--keep-unreachable" option, which sends
46    loose unreachable objects to a pack instead of leaving them loose.
47    This helps heuristics based on the number of loose objects
48    (e.g. "gc --auto").
49    (merge e26a8c4 jk/repack-keep-unreachable later to maint).
51  * "log --graph --format=" learned that "%>|(N)" specifies the width
52    relative to the terminal's left edge, not relative to the area to
53    draw text that is to the right of the ancestry-graph section.  It
54    also now accepts negative N that means the column limit is relative
55    to the right border.
56    (merge 066790d nd/graph-width-padded later to maint).
58  * A careless invocation of "git send-email directory/" after editing
59    0001-change.patch with an editor often ends up sending both
60    0001-change.patch and its backup file, 0001-change.patch~, causing
61    embarrassment and a minor confusion.  Detect such an input and
62    offer to skip the backup files when sending the patches out.
63    (merge 531220b jc/send-email-skip-backup later to maint).
65  * "git submodule update" that drives many "git clone" could
66    eventually hit flaky servers/network conditions on one of the
67    submodules; the command learned to retry the attempt.
69  * The output coloring scheme learned two new attributes, italic and
70    strike, in addition to existing bold, reverse, etc.
72  * "git log" learns log.showSignature configuration variable, and a
73    command line option "--no-show-signature" to countermand it.
74    (merge fce04c3 mj/log-show-signature-conf later to maint).
76  * A couple of "git svn" updates.
79 Performance, Internal Implementation, Development Support etc.
81  * "git fast-import" learned the same performance trick to avoid
82    creating too small a packfile as "git fetch" and "git push" have,
83    using *.unpackLimit configuration.
85  * When "git daemon" is run without --[init-]timeout specified, a
86    connection from a client that silently goes offline can hang around
87    for a long time, wasting resources.  The socket-level KEEPALIVE has
88    been enabled to allow the OS to notice such failed connections.
89    (merge a43b68a ew/daemon-socket-keepalive later to maint).
91  * "git upload-pack" command has been updated to use the parse-options
92    API.
94  * The "git apply" standalone program is being libified; this is the
95    first step to move many state variables into a structure that can
96    be explicitly (re)initialized to make the machinery callable more
97    than once.
99  * HTTP transport gained an option to produce more detailed debugging
100    trace.
101    (merge 73e57aa ep/http-curl-trace later to maint).
103  * Instead of taking advantage of a struct string_list that is
104    allocated with all NULs happens to be STRING_LIST_INIT_NODUP kind,
105    initialize them explicitly as such, to document their behaviour
106    better.
107    (merge 2721ce2 jk/string-list-static-init later to maint).
109  * HTTPd tests learned to show the server error log to help diagnosing
110    a failing tests.
111    (merge 44f243d nd/test-lib-httpd-show-error-log-in-verbose later to maint).
113  * The ownership rule for the piece of memory that hold references to
114    be fetched in "git fetch" was screwy, which has been cleaned up.
115    (merge b7410f6 km/fetch-do-not-free-remote-name later to maint).
117  * "git bisect" makes an internal call to "git diff-tree" when
118    bisection finds the culprit, but this call did not initialize the
119    data structure to pass to the diff-tree API correctly.
120    (merge 43ec550 jk/bisect-show-tree later to maint).
122  * Further preparatory clean-up for "worktree" feature continues.
123    (merge 0409e0b nd/worktree-cleanup-post-head-protection later to maint).
125  * Formats of the various data (and how to validate them) where we use
126    GPG signature have been documented.
127    (merge cc6ee97 mg/signature-doc later to maint).
129  * A new run-command API function pipe_command() is introduced to
130    sanely feed data to the standard input while capturing data from
131    the standard output and the standard error of an external process,
132    which is cumbersome to hand-roll correctly without deadlocking.
134    The codepath to sign data in a prepared buffer with GPG has been
135    updated to use this API to read from the status-fd to check for
136    errors (instead of relying on GPG's exit status).
137    (merge efee955 jk/gpg-interface-cleanup later to maint).
139  * Allow t/perf framework to use the features from the most recent
140    version of Git even when testing an older installed version.
143 Also contains various documentation updates and code clean-ups.
146 Fixes since v2.9
147 ----------------
149 Unless otherwise noted, all the fixes since v2.8 in the maintenance
150 track are contained in this release (see the maintenance releases'
151 notes for details).
153  * The commands in `git log` family take %C(auto) in a custom format
154    string.  This unconditionally turned the color on, ignoring
155    --no-color or with --color=auto when the output is not connected to
156    a tty; this was corrected to make the format truly behave as
157    "auto".
158    (merge b15a3e0 et/pretty-format-c-auto later to maint).
160  * "git rev-list --count" whose walk-length is limited with "-n"
161    option did not work well with the counting optimized to look at the
162    bitmap index.
163    (merge fb85db8 jk/rev-list-count-with-bitmap later to maint).
165  * "git show -W" (extend hunks to cover the entire function, delimited
166    by lines that match the "funcname" pattern) used to show the entire
167    file when a change added an entire function at the end of the file,
168    which has been fixed.
169    (merge 6f8d9bc rs/xdiff-hunk-with-func-line later to maint).
171  * The documentation set has been updated so that literal commands,
172    configuration variables and environment variables are consistently
173    typeset in fixed-width font and bold in manpages.
175  * "git svn propset" subcommand that was added in 2.3 days is
176    documented now.
178  * The documentation tries to consistently spell "GPG"; when
179    referring to the specific program name, "gpg" is used.
181  * "git reflog" stopped upon seeing an entry that denotes a branch
182    creation event (aka "unborn"), which made it appear as if the
183    reflog was truncated.
185  * The git-prompt scriptlet (in contrib/) was not friendly with those
186    who uses "set -u", which has been fixed.
188  * compat/regex code did not cleanly compile.
190  * A codepath that used alloca(3) to place an unbounded amount of data
191    on the stack has been updated to avoid doing so.
193  * "git update-index --add --chmod=+x file" may be usable as an escape
194    hatch, but not a friendly thing to force for people who do need to
195    use it regularly.  "git add --chmod=+x file" can be used instead.
197  * Build improvements for gnome-keyring (in contrib/)
199  * "git status" used to say "working directory" when it meant "working
200    tree".
202  * Comments about misbehaving FreeBSD shells have been clarified with
203    the version number (9.x and before are broken, newer ones are OK).
205  * "git cherry-pick A" worked on an unborn branch, but "git
206    cherry-pick A..B" didn't.
208  * Fix an unintended regression in v2.9 that breaks "clone --depth"
209    that recurses down to submodules by forcing the submodules to also
210    be cloned shallowly, which many server instances that host upstream
211    of the submodules are not prepared for.
212    (merge 18a74a0 sb/clone-shallow-passthru later to maint).
214  * Fix unnecessarily waste in the idiomatic use of ': ${VAR=default}'
215    to set the default value, without enclosing it in double quotes.
216    (merge 01247e0 lc/shell-default-value-noexpand later to maint).
218  * Some platform-specific code had non-ANSI strict declarations of C
219    functions that do not take any parameters, which has been
220    corrected.
221    (merge 0767172 js/mingw-parameter-less-c-functions later to maint).
223  * The internal code used to show local timezone offset is not
224    prepared to handle timestamps beyond year 2100, and gave a
225    bogus offset value to the caller.  Use a more benign looking
226    +0000 instead and let "git log" going in such a case, instead
227    of aborting.
228    (merge bab7483 jk/tzoffset-fix later to maint).
230  * One among four invocations of readlink(1) in our test suite has
231    been rewritten so that the test can run on systems without the
232    command (others are in valgrind test framework and t9802).
233    (merge d2addc3 ak/t7800-wo-readlink later to maint).
235  * t/perf needs /usr/bin/time with GNU extension; the invocation of it
236    is updated to "gtime" on Darwin.
237    (merge e3efa94 js/perf-on-apple later to maint).
239  * A bug, which caused "git p4" while running under verbose mode to
240    report paths that are omitted due to branch prefix incorrectly, has
241    been fixed; the command said "Ignoring file outside of prefix" for
242    paths that are _inside_.
243    (merge 09667d0 ao/p4-has-branch-prefix-fix later to maint).
245  * The top level documentation "git help git" still pointed at the
246    documentation set hosted at now-defunct google-code repository.
247    Update it to point to https://git.github.io/htmldocs/git.html
248    instead.
249    (merge f793582 jn/preformatted-doc-url later to maint).
251  * A helper function that takes the contents of a commit object and
252    finds its subject line did not ignore leading blank lines, as is
253    commonly done by other codepaths.  Make it ignore leading blank
254    lines to match.
255    (merge 054a5ae js/find-commit-subject-ignore-leading-blanks later to maint).
257  * For a long time, we carried an in-code comment that said our
258    colored output would work only when we use fprintf/fputs on
259    Windows, which no longer is the case for the past few years.
260    (merge 3d0a833 js/color-on-windows-comment later to maint).
262  * Other minor clean-ups and documentation updates
263    (merge e51b0df pb/commit-editmsg-path later to maint).
264    (merge b333d0d jk/send-pack-stdio later to maint).
265    (merge fcf0fe9 lf/sideband-returns-void later to maint).
266    (merge 5819c2e sb/t5614-modernize later to maint).
267    (merge fe0537a cb/t7810-test-label-fix later to maint).
268    (merge 412b9a1 jc/t2300-setup later to maint).