add macro REALLOC_ARRAY
[git] / Documentation / RelNotes / 2.2.0.txt
1 Git v2.2 Release Notes
2 ======================
3
4 Updates since v2.1
5 ------------------
6
7 Ports
8
9  * Building on older MacOS X systems automatically sets
10    the necessary NO_APPLE_COMMON_CRYPTO build-time option.
11
12
13 UI, Workflows & Features
14
15  * "git config --edit --global" starts from a skeletal per-user
16    configuration file contents, instead of a total blank, when the
17    user does not already have any.  This immediately reduces the
18    need for a later "Have you forgotten setting core.user?" and we
19    can add more to the template as we gain more experience.
20
21  * "git stash list -p" used to be almost always a no-op because each
22    stash entry is represented as a merge commit.  It learned to show
23    the difference between the base commit version and the working tree
24    version, which is in line with what "git show" gives.
25
26 Performance, Internal Implementation, etc.
27
28  * The API to manipulate the "refs" is currently undergoing a revamp
29    to make it more transactional, with the eventual goal to allow
30    all-or-none atomic updates and migrating the storage to something
31    other than the traditional filesystem based one (e.g. databases).
32
33  * We no longer attempt to keep track of individual dependencies to
34    the header files in the build procedure, relying on automated
35    dependency generation support from modern compilers.
36
37  * In tests, we have been using NOT_{MINGW,CYGWIN} test prerequisites
38    long before negated prerequisites e.g. !MINGW were invented.
39    The former has been converted to the latter to avoid confusion.
40
41  * Looking up remotes configuration in a repository with very many
42    remotes defined has been optimized.
43
44  * There are cases where you lock and open to write a file, close it
45    to show the updated contents to external processes, and then have
46    to update the file again while still holding the lock, but the
47    lockfile API lacked support for such an access pattern.
48
49  * The API to allocate the structure to keep track of commit
50    decoration has been updated to make it less cumbersome to use.
51
52  * An in-core caching layer to let us avoid reading the same
53    configuration files number of times has been added.  A few commands
54    have been converted to use this subsystem.
55
56  * Various code paths have been cleaned up and simplified by using
57    "strbuf", "starts_with()", and "skip_prefix()" APIs more.
58
59  * A few codepaths that died when large blobs that would not fit in
60    core are involved in their operation have been taught to punt
61    instead, by e.g. marking too large a blob as not to be diffed.
62
63  * A few more code paths in "commit" and "checkout" have been taught
64    to repopulate the cache-tree in the index, to help speed up later
65    "write-tree" (used in "commit") and "diff-index --cached" (used in
66    "status").
67
68
69 Also contains various documentation updates and code clean-ups.
70
71
72 Fixes since v2.1
73 ----------------
74
75 Unless otherwise noted, all the fixes since v2.1 in the maintenance
76 track are contained in this release (see the maintenance releases'
77 notes for details).
78
79  * "git log --pretty/format=" with an empty format string did not
80    mean the more obvious "No output whatsoever" but "Use default
81    format", which was counterintuitive.
82    (merge b9c7d6e jk/pretty-empty-format later to maint).
83
84  * Implementations of "tar" that do not understand an extended pax
85    header would extract the contents of it in a regular file; make
86    sure the permission bits of this file follows the same tar.umask
87    configuration setting.
88
89  * "git -c section.var command" and "git -c section.var= command"
90    should pass the configuration differently (the former should be a
91    boolean true, the latter should be an empty string).
92    (merge a789ca7 jk/command-line-config-empty-string later to maint).
93
94  * Applying a patch not generated by Git in a subdirectory used to
95    check the whitespace breakage using the attributes for incorrect
96    paths. Also whitespace checks were performed even for paths
97    excluded via "git apply --exclude=<path>" mechanism.
98    (merge 477a08a jc/apply-ws-prefix later to maint).
99
100  * "git bundle create" with date-range specification were meant to
101    exclude tags outside the range, but it didn't.
102    (merge 2c8544a lf/bundle-exclusion later to maint).
103
104  * "git add x" where x that used to be a directory has become a
105    symbolic link to a directory misbehaved.
106    (merge ccad42d rs/refresh-beyond-symlink later to maint).
107
108  * The prompt script checked $GIT_DIR/ref/stash file to see if there
109    is a stash, which was a no-no.
110    (merge 0fa7f01 jk/prompt-stash-could-be-packed later to maint).
111
112  * Pack-protocol documentation had a minor typo.
113    (merge 5d146f7 sp/pack-protocol-doc-on-shallow later to maint).
114
115  * "git checkout -m" did not switch to another branch while carrying
116    the local changes forward when a path was deleted from the index.
117    (merge 6a143aa jn/unpack-trees-checkout-m-carry-deletion later to maint).
118
119  * With sufficiently long refnames, "git fast-import" could have
120    overflown an on-stack buffer.
121    (merge c252785 jk/fast-import-fixes later to maint).
122
123  * After "pack-refs --prune" packed refs at the top-level, it failed
124    to prune them.
125    (merge afd11d3 jk/prune-top-level-refs-after-packing later to maint).
126
127  * Progress output from "git gc --auto" was visible in "git fetch -q".
128    (merge 6fceed3 nd/fetch-pass-quiet-to-gc-child-process later to maint).
129
130  * We used to pass -1000 to poll(2), expecting it to also mean "no
131    timeout", which should be spelled as -1.
132    (merge 6c71f8b et/spell-poll-infinite-with-minus-one-only later to maint).