doc: documentation update for the branch track changes
[git/git.git] / Documentation / RelNotes-1.5.4.txt
1 GIT v1.5.4 Release Notes
2 ========================
3
4 Removal
5 -------
6
7 * "git svnimport" was removed in favor of "git svn". It is still there
8 in the source tree (contrib/examples) but unsupported.
9
10 * As git-commit and git-status have been rewritten, "git runstatus"
11 helper script lost all its users and has been removed.
12
13 * Curl library older than 7.10 is not supported by "git http-push",
14 as it does not work without CURLM.
15
16
17 Deprecation notices
18 -------------------
19
20 * The next feature release of git (this change is scheduled for v1.6.0)
21 will by default install dashed form of commands (e.g. "git-commit")
22 outside of users' normal $PATH, and will install only selected
23 commands ("git" itself, and "gitk") in $PATH. This implies:
24
25 - Using dashed forms of git commands (e.g. "git-commit") from the
26 command line has been informally deprecated since early 2006, but
27 now it officially is, and will be removed in the future. Use
28 dashless forms (e.g. "git commit") instead.
29
30 - Using dashed forms from your scripts, without first prepending the
31 return value from "git --exec-path" to the scripts' PATH, has been
32 informally deprecated since early 2006, but now it officially is.
33
34 - Use of dashed forms with "PATH=$(git --exec-path):$PATH; export
35 PATH" early in your script is not deprecated with this change.
36
37 Users are strongly encouraged to adjust their habits and scripts now
38 to prepare for this.
39
40 * The post-receive hook was introduced in March 2007 to supersede
41 the post-update hook, primarily to overcome the command line length
42 limitation of the latter. Use of post-update hook will be deprecated
43 in future versions of git, starting from v1.6.0.
44
45 * "git lost-found" was deprecated in favor of "git fsck"'s --lost-found
46 option, and will be removed in the future.
47
48 * "git peek-remote" is deprecated, as "git ls-remote" was written in C
49 and works for all transports; "git peek-remote" will be removed in
50 the future.
51
52 * "git repo-config" which was an old name for "git config" command
53 has been supported without being advertised for a long time. The
54 next feature release will remove it.
55
56 * From v1.6.0, the repack.usedeltabaseoffset config option will default
57 to true, which will give denser packfiles (i.e. more efficient storage).
58 The downside is that git older than version 1.4.4 will not be able
59 to directly use a repository packed using this setting.
60
61 * From v1.6.0, the pack.indexversion config option will default to 2,
62 which is slightly more efficient, and makes repacking more immune to
63 data corruptions. Git older than version 1.5.2 may revert to version 1
64 of the pack index with a manual "git index-pack" to be able to directly
65 access corresponding pack files.
66
67
68 Updates since v1.5.3
69 --------------------
70
71 * Comes with much improved gitk, with i18n.
72
73 * Comes with "git gui" 0.9.1 with i18n.
74
75 * gitk is now merged as a subdirectory of git.git project, in
76 preparation for its i18n.
77
78 * progress displays from many commands are a lot nicer to the eye.
79 Transfer commands show throughput data.
80
81 * many commands that pay attention to per-directory .gitignore now do
82 so lazily, which makes the usual case go much faster.
83
84 * Output processing for '--pretty=format:<user format>' has been
85 optimized.
86
87 * Rename detection of diff family while detecting exact matches has
88 been greatly optimized.
89
90 * Rename detection of diff family tries to make more natural looking
91 pairing. Earlier, if multiple identical rename sources were
92 found in the preimage, the source used was picked pretty much at random.
93
94 * Value "true" for color.diff and color.status configuration used to
95 mean "always" (even when the output is not going to a terminal).
96 This has been corrected to mean the same thing as "auto".
97
98 * "git diff" Porcelain now respects diff.external configuration, which
99 is another way to specify GIT_EXTERNAL_DIFF.
100
101 * "git diff" can be told to use different prefixes other than
102 "a/" and "b/" e.g. "git diff --src-prefix=l/ --dst-prefix=k/".
103
104 * "git diff" sometimes did not quote paths with funny
105 characters properly.
106
107 * "git log" (and any revision traversal commands) misbehaved
108 when --diff-filter is given but was not asked to actually
109 produce diff.
110
111 * HTTP proxy can be specified per remote repository using
112 remote.*.httpproxy configuration, or global http.proxy configuration
113 variable.
114
115 * Various Perforce importer updates.
116
117 * Example update and post-receive hooks have been improved.
118
119 * Any command that wants to take a commit object name can now use
120 ":/string" syntax to name a commit.
121
122 * "git reset" is now built-in and its output can be squelched with -q.
123
124 * "git reset --hard" does not make any sense in a bare
125 repository, but did not error out; fixed.
126
127 * "git send-email" can optionally talk over ssmtp and use SMTP-AUTH.
128
129 * "git rebase" learned --whitespace option.
130
131 * In "git rebase", when you decide not to replay a particular change
132 after the command stopped with a conflict, you can say "git rebase
133 --skip" without first running "git reset --hard", as the command now
134 runs it for you.
135
136 * "git rebase --interactive" mode can now work on detached HEAD.
137
138 * Other minor to serious bugs in "git rebase -i" have been fixed.
139
140 * "git rebase" now detaches head during its operation, so after a
141 successful "git rebase" operation, the reflog entry branch@{1} for
142 the current branch points at the commit before the rebase was
143 started.
144
145 * "git rebase -i" also triggers rerere to help your repeated merges.
146
147 * "git merge" can call the "post-merge" hook.
148
149 * "git pack-objects" can optionally run deltification with multiple
150 threads.
151
152 * "git archive" can optionally substitute keywords in files marked with
153 export-subst attribute.
154
155 * "git cherry-pick" made a misguided attempt to repeat the original
156 command line in the generated log message, when told to cherry-pick a
157 commit by naming a tag that points at it. It does not anymore.
158
159 * "git for-each-ref" learned %(xxxdate:<dateformat>) syntax to show the
160 various date fields in different formats.
161
162 * "git gc --auto" is a low-impact way to automatically run a variant of
163 "git repack" that does not lose unreferenced objects (read: safer
164 than the usual one) after the user accumulates too many loose
165 objects.
166
167 * "git clean" has been rewritten in C.
168
169 * You need to explicitly set clean.requireForce to "false" to allow
170 "git clean" without -f to do any damage (lack of the configuration
171 variable used to mean "do not require -f option to lose untracked
172 files", but we now use the safer default).
173
174 * The kinds of whitespace errors "git diff" and "git apply" notice (and
175 fix) can be controlled via 'core.whitespace' configuration variable
176 and 'whitespace' attribute in .gitattributes file.
177
178 * "git push" learned --dry-run option to show what would happen if a
179 push is run.
180
181 * "git push" does not update a tracking ref on the local side when the
182 remote refused to update the corresponding ref.
183
184 * "git push" learned --mirror option. This is to push the local refs
185 one-to-one to the remote, and deletes refs from the remote that do
186 not exist anymore in the repository on the pushing side.
187
188 * "git push" can remove a corrupt ref at the remote site with the usual
189 ":ref" refspec.
190
191 * "git remote" knows --mirror mode. This is to set up configuration to
192 push into a remote repository to store local branch heads to the same
193 branch on the remote side, and remove branch heads locally removed
194 from local repository at the same time. Suitable for pushing into a
195 back-up repository.
196
197 * "git remote" learned "rm" subcommand.
198
199 * "git cvsserver" can be run via "git shell". Also, "cvs" is
200 recognized as a synonym for "git cvsserver", so that CVS users
201 can be switched to git just by changing their login shell.
202
203 * "git cvsserver" acts more like receive-pack by running post-receive
204 and post-update hooks.
205
206 * "git am" and "git rebase" are far less verbose.
207
208 * "git pull" learned to pass --[no-]ff option to underlying "git
209 merge".
210
211 * "git pull --rebase" is a different way to integrate what you fetched
212 into your current branch.
213
214 * "git fast-export" produces datastream that can be fed to fast-import
215 to reproduce the history recorded in a git repository.
216
217 * "git add -i" takes pathspecs to limit the set of files to work on.
218
219 * "git add -p" is a short-hand to go directly to the selective patch
220 subcommand in the interactive command loop and to exit when done.
221
222 * "git add -i" UI has been colorized. The interactive prompt
223 and menu can be colored by setting color.interactive
224 configuration. The diff output (including the hunk picker)
225 are colored with color.diff configuration.
226
227 * "git commit --allow-empty" allows you to create a single-parent
228 commit that records the same tree as its parent, overriding the usual
229 safety valve.
230
231 * "git commit --amend" can amend a merge that does not change the tree
232 from its first parent.
233
234 * "git commit" used to unconditionally strip comment lines that
235 began with '#' and removed excess blank lines. This
236 behaviour has been made configurable.
237
238 * "git commit" has been rewritten in C.
239
240 * "git stash random-text" does not create a new stash anymore. It was
241 a UI mistake. Use "git stash save random-text", or "git stash"
242 (without extra args) for that.
243
244 * "git stash clear extra-text" does not clear the whole stash
245 anymore. It is tempting to expect "git stash clear stash@{2}"
246 to drop only a single named stash entry, and it is rude to
247 discard everything when that is asked (but not provided).
248
249 * "git prune --expire <time>" can exempt young loose objects from
250 getting pruned.
251
252 * "git branch --contains <commit>" can list branches that are
253 descendants of a given commit.
254
255 * "git log" learned --early-output option to help interactive GUI
256 implementations.
257
258 * "git bisect" learned "skip" action to mark untestable commits.
259
260 * "git bisect visualize" learned a shorter synonym "git bisect view".
261
262 * "git bisect visualize" runs "git log" in a non-windowed
263 environments. It also can be told what command to run (e.g. "git
264 bisect visualize tig").
265
266 * "git format-patch" learned "format.numbered" configuration variable
267 to automatically turn --numbered option on when more than one commits
268 are formatted.
269
270 * "git ls-files" learned "--exclude-standard" to use the canned set of
271 exclude files.
272
273 * "git tag -a -f existing" begins the editor session using the existing
274 annotation message.
275
276 * "git tag -m one -m bar" (multiple -m options) behaves similarly to
277 "git commit"; the parameters to -m options are formatted as separate
278 paragraphs.
279
280 * The format "git show" outputs an annotated tag has been updated to
281 include "Tagger: " and "Date: " lines from the tag itself. Strictly
282 speaking this is a backward incompatible change, but this is a
283 reasonable usability fix and people's scripts shouldn't have been
284 relying on the exact output from "git show" Porcelain anyway.
285
286 * "git cvsimport" did not notice errors from underlying "cvsps"
287 and produced a corrupt import silently.
288
289 * "git cvsexportcommit" learned -w option to specify and switch to the
290 CVS working directory.
291
292 * "git checkout" from a subdirectory learned to use "../path" to allow
293 checking out a path outside the current directory without cd'ing up.
294
295 * "git checkout" from and to detached HEAD leaves a bit more
296 information in the reflog.
297
298 * "git send-email --dry-run" shows full headers for easier diagnosis.
299
300 * "git merge-ours" is now built-in.
301
302 * "git svn" learned "info" and "show-externals" subcommands.
303
304 * "git svn" run from a subdirectory failed to read settings from the
305 .git/config.
306
307 * "git svn" learned --use-log-author option, which picks up more
308 descriptive name from From: and Signed-off-by: lines in the commit
309 message.
310
311 * "git svn" wasted way too much disk to record revision mappings
312 between svn and git; a new representation that is much more compact
313 for this information has been introduced to correct this.
314
315 * "git svn" left temporary index files it used without cleaning them
316 up; this was corrected.
317
318 * "git status" from a subdirectory now shows relative paths, which
319 makes copy-and-pasting for git-checkout/git-add/git-rm easier. The
320 traditional behaviour to show the full path relative to the top of
321 the work tree can be had by setting status.relativepaths
322 configuration variable to false.
323
324 * "git blame" kept text for each annotated revision in core needlessly;
325 this has been corrected.
326
327 * "git shortlog" learned to default to HEAD when the standard input is
328 a terminal and the user did not give any revision parameter.
329
330 * "git shortlog" learned "-e" option to show e-mail addresses as well as
331 authors' names.
332
333 * "git help" learned "-w" option to show documentation in browsers.
334
335 * In addition there are quite a few internal clean-ups. Notably
336
337 - many fork/exec have been replaced with run-command API,
338 brought from the msysgit effort.
339
340 - introduction and more use of the option parser API.
341
342 - enhancement and more use of the strbuf API.
343
344
345 Fixes since v1.5.3
346 ------------------
347
348 All of the fixes in v1.5.3 maintenance series are included in
349 this release, unless otherwise noted.
350
351 These fixes are only in v1.5.4 and not backported to v1.5.3 maintenance
352 series.
353
354 * The way "git diff --check" behaves is much more consistent with the way
355 "git apply --whitespace=warn" works.
356
357 * "git svn" talking with the SVN over http will correctly quote branch
358 and project names.
359
360 * "git config" did not work correctly on platforms that define
361 REG_NOMATCH to an even number.
362
363 * Recent versions of AsciiDoc 8 has a change to break our
364 documentation; a workaround has been implemented.
365
366 * "git diff --color-words" colored context lines in a wrong color.
367
368 --
369 exec >/var/tmp/1
370 O=v1.5.4-rc4
371 echo O=`git describe refs/heads/master`
372 git shortlog --no-merges $O..refs/heads/master ^refs/heads/maint