git-status: documentation improvements
[git/dscho.git] / Documentation / RelNotes-1.5.4.txt
blobc1ebd6997a1ba4b25d1302f53a9c36aad9959f36
1 GIT v1.5.4 Release Notes
2 ========================
4 Removal
5 -------
7  * "git svnimport" was removed in favor of "git svn".  It is still there
8    in the source tree (contrib/examples) but unsupported.
11 Deprecation notices
12 -------------------
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:
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.
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.
29    - Use of dashed form with "PATH=$(git --exec-path):$PATH; export
30      PATH" early in your script is not deprecated with this change.
32   Users are strongly encouraged to adjust their habits and scripts now
33   to prepare for this.
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.
40  * "git lost-found" was deprecated in favor of "git fsck"'s --lost-found
41    option, and will be removed in the future.
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.
47 Updates since v1.5.3
48 --------------------
50  * Comes with much improved gitk.
52  * Comes with "git gui" 0.9.1 with i18n.
54  * gitk is now merged as a subdirectory of git.git project, in
55    preparation for its i18n.
57  * progress display from many commands are a lot nicer to the eye.
58    Transfer commands show throughput data.
60  * many commands that pay attention to per-directory .gitignore now do
61    so lazily, which makes the usual case go much faster.
63  * Output processing for '--pretty=format:<user format>' has been
64    optimized.
66  * Rename detection of diff family, while detecting exact matches, has
67    been greatly optimized.
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.
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".
77  * HTTP proxy can be specified per remote repository using
78    remote.*.httpproxy configuration, or global http.proxy configuration
79    variable.
81  * Various Perforce importer updates.
83  * Example update and post-receive hooks have been improved.
85  * Any command that wants to take a commit object name can now use
86    ":/string" syntax to name a commit.
88  * "git reset" is now built-in and its output can be squelched with -q.
90  * "git send-email" can optionally talk over ssmtp and use SMTP-AUTH.
92  * "git rebase" learned --whitespace option.
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.
99  * "git rebase --interactive" mode can now work on detached HEAD.
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.
106  * "git rebase -i" also triggers rerere to help your repeated merges.
108  * "git merge" can call the "post-merge" hook.
110  * "git pack-objects" can optionally run deltification with multiple
111    threads.
113  * "git archive" can optionally substitute keywords in files marked with
114    export-subst attribute.
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.
120  * "git for-each-ref" learned %(xxxdate:<dateformat>) syntax to show the
121    various date fields in different formats.
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.
128  * "git clean" has been rewritten in C.
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).
135  * "git push" learned --dry-run option to show what would happen if a
136    push is run.
138  * "git push" does not update a tracking ref on the local side when the
139    remote refused to update the corresponding ref.
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.
145  * "git push" can remove a corrupt ref at the remote site with the usual
146    ":ref" refspec.
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.
154  * "git remote" learned "rm" subcommand.
156  * "git cvsserver" can be run via "git shell".
158  * "git cvsserver" acts more like receive-pack by running post-receive
159    and post-update hooks.
161  * "git am" and "git rebase" are far less verbose.
163  * "git pull" learned to pass --[no-]ff option to underlying "git
164    merge".
166  * "git pull --rebase" is a different way to integrate what you fetched
167    into your current branch.
169  * "git fast-export" produces datastream that can be fed to fast-import
170    to reproduce the history recorded in a git repository.
172  * "git add -i" takes pathspecs to limit the set of files to work on.
174  * "git add -p" is a short-hand to go directly to the selective patch
175    subcommand in the interactive command loop and to exit when done.
177  * "git add -i" UI has been colorized.
179  * "git commit --allow-empty" allows you to create a single-parent
180    commit that records the same tree as its parent, overriding the usual
181    safety valve.
183  * "git commit --amend" can amend a merge that does not change the tree
184    from its first parent.
186  * "git commit" has been rewritten in C.
188  * "git stash random-text" does not create a new stash anymore.  It was
189    a UI mistake.  Use "git stash save random-text", or "git stash"
190    (without extra args) for that.
192  * "git prune --expire <time>" can exempt young loose objects from
193    getting pruned.
195  * "git branch --contains <commit>" can list branches that are
196    descendants of a given commit.
198  * "git log" learned --early-output option to help interactive GUI
199    implementations.
201  * "git bisect" learned "skip" action to mark untestable commits.
203  * "git format-patch" learned "format.numbered" configuration variable
204    to automatically turn --numbered option on when more than one commits
205    are formatted.
207  * "git ls-files" learned "--exclude-standard" to use the canned set of
208    exclude files.
210  * "git tag -a -f existing" begins the editor session using the existing
211    annotation message.
213  * "git tag -m one -m bar" (multiple -m options) behaves similarly to
214    "git commit"; the parameters to -m options are formatted as separate
215    paragraphs.
217  * "git cvsexportcommit" learned -w option to specify and switch to the
218    CVS working directory.
220  * "git checkout" from a subdirectory learned to use "../path" to allow
221    checking out a path outside the current directory without cd'ing up.
223  * "git send-email --dry-run" shows full headers for easier diagnosis.
225  * "git merge-ours" is now built-in.
227  * "git svn" learned "info" and "show-externals" subcommands.
229  * "git svn" run from a subdirectory failed to read settings from the
230    .git/config.
232  * "git svn" learned --use-log-author option, which picks up more
233    descriptive name from From: and Signed-off-by: lines in the commit
234    message.
236  * "git status" from a subdirectory now shows relative paths which makes
237    copy-and-pasting for git-checkout/git-add/git-rm easier.
239  * "git checkout" from and to detached HEAD leaves a bit more
240    information in the reflog.
242  * In addition there are quite a few internal clean-ups. Notably
244    - many fork/exec have been replaced with run-command API,
245      brought from the msysgit effort.
247    - introduction and more use of the option parser API.
249    - enhancement and more use of the strbuf API.
252 Fixes since v1.5.3
253 ------------------
255 All of the fixes in v1.5.3 maintenance series are included in
256 this release, unless otherwise noted.
258 These fixes are only in v1.5.4 and not backported to v1.5.3 maintenance
259 series.
261  * "git svn" talking with the SVN over http will correctly quote branch
262    and project names.
264  * "git config" did not work correctly on platforms that define
265    REG_NOMATCH to an even number.
268 exec >/var/tmp/1
269 O=v1.5.3.7-1111-gd9f4059
270 echo O=`git describe refs/heads/master`
271 git shortlog --no-merges $O..refs/heads/master ^refs/heads/maint