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