Update draft release notes for 1.5.4
[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
11 Deprecation notices
12 -------------------
13
14  * Next feature release of git (this change is scheduled for v1.5.5 but
15    it could slip) will by default install dashed form of commands
16    (e.g. "git-commit") outside of users' normal $PATH, and will install
17    only selected commands ("git" itself, and "gitk") in $PATH.  This
18    implies:
19
20    - Using dashed form of git commands (e.g. "git-commit") from the
21      command line has been informally deprecated since early 2006, but
22      now it officially is, and will be removed in the future.  Use
23      dashless form (e.g. "git commit") instead.
24
25    - Using dashed from from your scripts, without first prepending the
26      return value from "git --exec-path" to the scripts' PATH, has been
27      informally deprecated since early 2006, but now it officially is.
28
29    - Use of dashed form with "PATH=$(git --exec-path):$PATH; export
30      PATH" early in your script is not deprecated with this change.
31
32   Users are strongly encouraged to adjust their habits and scripts now
33   to prepare for this.
34
35  * The post-receive hook was introduced in March 2007 to supersede
36    post-update hook, primarily to overcome the command line length
37    limitation of the latter.  Use of post-update hook will be deprecated
38    in future versions of git, perhaps in v1.5.5.
39
40  * "git lost-found" was deprecated in favor of "git fsck"'s --lost-found
41    option, and will be removed in the future.
42
43  * "git peek-remote" is deprecated, as "git ls-remote" was written in C
44    and works for all transports, and will be removed in the future.
45
46
47 Updates since v1.5.3
48 --------------------
49
50  * Comes with much improved gitk.
51
52  * Comes with "git gui" 0.9.1 with i18n.
53
54  * gitk is now merged as a subdirectory of git.git project, in
55    preparation for its i18n.
56
57  * progress display from many commands are a lot nicer to the eye.
58    Transfer commands show throughput data.
59
60  * many commands that pay attention to per-directory .gitignore now do
61    so lazily, which makes the usual case go much faster.
62
63  * Output processing for '--pretty=format:<user format>' has been
64    optimized.
65
66  * Rename detection of diff family, while detecting exact matches, has
67    been greatly optimized.
68
69  * Rename detection of diff family tries to make more naturally looking
70    pairing.  Earlier if more than one identical rename sources were
71    found in the preimage, they were picked pretty much at random.
72
73  * Value "true" for color.diff and color.status configuration used to
74    mean "always" (even when the output is not going to a terminal).
75    This has been corrected to mean the same thing as "auto".
76
77  * HTTP proxy can be specified per remote repository using
78    remote.*.httpproxy configuration, or global http.proxy configuration
79    variable.
80
81  * Various Perforce importer updates.
82
83  * Example update and post-receive hooks have been improved.
84
85  * Any command that wants to take a commit object name can now use
86    ":/string" syntax to name a commit.
87
88  * "git reset" is now built-in and its output can be squelched with -q.
89
90  * "git send-email" can optionally talk over ssmtp and use SMTP-AUTH.
91
92  * "git rebase" learned --whitespace option.
93
94  * In "git rebase", when you decide not to replay a particular change
95    after the command stopped with a conflict, you can say "git rebase
96    --skip" without first running "git reset --hard", as the command now
97    runs it for you.
98
99  * "git rebase --interactive" mode can now work on detached HEAD.
100
101  * "git rebase" now detaches head during its operation, so after a
102    successful "git rebase" operation, the reflog entry branch@{1} for
103    the current branch points at the commit before the rebase was
104    started.
105
106  * "git rebase -i" also triggers rerere to help your repeated merges.
107
108  * "git merge" can call the "post-merge" hook.
109
110  * "git pack-objects" can optionally run deltification with multiple
111    threads.
112
113  * "git archive" can optionally substitute keywords in files marked with
114    export-subst attribute.
115
116  * "git cherry-pick" made a misguided attempt to repeat the original
117    command line in the generated log message, when told to cherry-pick a
118    commit by naming a tag that points at it.  It does not anymore.
119
120  * "git for-each-ref" learned %(xxxdate:<dateformat>) syntax to show the
121    various date fields in different formats.
122
123  * "git gc --auto" is a low-impact way to automatically run a variant of
124    "git repack" that does not lose unreferenced objects (read: safer
125    than the usual one) after the user accumulates too many loose
126    objects.
127
128  * "git clean" has been rewritten in C.
129
130  * You need to explicitly set clean.requireForce to "false" to allow
131    "git clean" without -f to do any damage (lack of the configuration
132    variable used to mean "do not require -f option to lose untracked
133    files", but we now use the safer default).
134
135  * "git push" learned --dry-run option to show what would happen if a
136    push is run.
137
138  * "git push" does not update a tracking ref on the local side when the
139    remote refused to update the corresponding ref.
140
141  * "git push" learned --mirror option.  This is to push the local refs
142    one-to-one to the remote, and deletes refs from the remote that do
143    not exist anymore in the repository on the pushing side.
144
145  * "git push" can remove a corrupt ref at the remote site with the usual
146    ":ref" refspec.
147
148  * "git remote" knows --mirror mode.  This is to set up configuration to
149    push into a remote repository to store local branch heads to the same
150    branch on the remote side, and remove branch heads locally removed
151    from local repository at the same time.  Suitable for pushing into a
152    back-up repository.
153
154  * "git remote" learned "rm" subcommand.
155
156  * "git cvsserver" can be run via "git shell".
157
158  * "git am" and "git rebase" are far less verbose.
159
160  * "git pull" learned to pass --[no-]ff option to underlying "git
161    merge".
162
163  * "git pull --rebase" is a different way to integrate what you fetched
164    into your current branch.
165
166  * "git fast-export" produces datastream that can be fed to fast-import
167    to reproduce the history recorded in a git repository.
168
169  * "git commit --allow-empty" allows you to create a single-parent
170    commit that records the same tree as its parent, overriding the usual
171    safety valve.
172
173  * "git commit --amend" can amend a merge that does not change the tree
174    from its first parent.
175
176  * "git stash random-text" does not create a new stash anymore.  It was
177    a UI mistake.  Use "git stash save random-text", or "git stash"
178    (without extra args) for that.
179
180  * "git prune --expire <time>" can exempt young loose objects from
181    getting pruned.
182
183  * "git branch --contains <commit>" can list branches that are
184    descendants of a given commit.
185
186  * "git log" learned --early-output option to help interactive GUI
187    implementations.
188
189  * "git bisect" learned "skip" action to mark untestable commits.
190
191  * "git format-patch" learned "format.numbered" configuration variable
192    to automatically turn --numbered option on when more than one commits
193    are formatted.
194
195  * "git ls-files" learned "--exclude-standard" to use the canned set of
196    exclude files.
197
198  * "git tag -a -f existing" begins the editor session using the existing
199    annotation message.
200
201  * "git tag -m one -m bar" (multiple -m options) behaves similarly to
202    "git commit"; the parameters to -m options are formatted as separate
203    paragraphs.
204
205  * "git cvsexportcommit" learned -w option to specify and switch to the
206    CVS working directory.
207
208  * "git checkout" from a subdirectory learned to use "../path" to allow
209    checking out a path outside the current directory without cd'ing up.
210
211  * "git send-email --dry-run" shows full headers for easier diagnosis.
212
213  * "git merge-ours" is now built-in.
214
215  * "git svn" learned "info" and "show-externals" subcommands.
216
217  * "git svn" run from a subdirectory failed to read settings from the
218    .git/config.
219
220  * "git svn" learned --use-log-author option, which picks up more
221    descriptive name from From: and Signed-off-by: lines in the commit
222    message.
223
224  * "git status" from a subdirectory now shows relative paths which makes
225    copy-and-pasting for git-checkout/git-add/git-rm easier.
226
227  * "git checkout" from and to detached HEAD leaves a bit more
228    information in the reflog.
229
230  * In addition there are quite a few internal clean-ups. Notably
231
232    - many fork/exec have been replaced with run-command API,
233      brought from the msysgit effort.
234
235    - introduction and more use of the option parser API.
236
237    - enhancement and more use of the strbuf API.
238
239
240 Fixes since v1.5.3
241 ------------------
242
243 All of the fixes in v1.5.3 maintenance series are included in
244 this release, unless otherwise noted.
245
246 These fixes are only in v1.5.4 and not backported to v1.5.3 maintenance
247 series.
248
249  * "git svn" talking with the SVN over http will correctly quote branch
250    and project names.
251
252 --
253 exec >/var/tmp/1
254 O=v1.5.3.7-1003-gf38ca7c
255 echo O=`git describe refs/heads/master`
256 git shortlog --no-merges $O..refs/heads/master ^refs/heads/maint