Change git-gc documentation to reflect gc.packrefs implementation.
[git.git] / Documentation / RelNotes-1.5.4.txt
blobc05de3d1d82d95a97264366f05e85913e524254d
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.
10  * As git-commit and git-status have been rewritten, "git runstatus"
11    helper script lost all its users and has been removed.
14 Deprecation notices
15 -------------------
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:
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.
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.
31    - Use of dashed forms with "PATH=$(git --exec-path):$PATH; export
32      PATH" early in your script is not deprecated with this change.
34   Users are strongly encouraged to adjust their habits and scripts now
35   to prepare for this.
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.
42  * "git lost-found" was deprecated in favor of "git fsck"'s --lost-found
43    option, and will be removed in the future.
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.
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.
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.
61 Updates since v1.5.3
62 --------------------
64  * Comes with much improved gitk.
66  * Comes with "git gui" 0.9.1 with i18n.
68  * gitk is now merged as a subdirectory of git.git project, in
69    preparation for its i18n.
71  * progress displays from many commands are a lot nicer to the eye.
72    Transfer commands show throughput data.
74  * many commands that pay attention to per-directory .gitignore now do
75    so lazily, which makes the usual case go much faster.
77  * Output processing for '--pretty=format:<user format>' has been
78    optimized.
80  * Rename detection of diff family while detecting exact matches has
81    been greatly optimized.
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.
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".
91  * "git diff" Porcelain now respects diff.external configuration, which
92    is another way to specify GIT_EXTERNAL_DIFF.
94  * "git diff" can be told to use different prefixes other than
95    "a/" and "b/" e.g. "git diff --src-prefix=l/ --dst-prefix=k/".
97  * "git diff" sometimes did not quote paths with funny
98    characters properly.
100  * "git log" (and any revision traversal commands) misbehaved
101    when --diff-filter is given but was not asked to actually
102    produce diff.
104  * HTTP proxy can be specified per remote repository using
105    remote.*.httpproxy configuration, or global http.proxy configuration
106    variable.
108  * Various Perforce importer updates.
110  * Example update and post-receive hooks have been improved.
112  * Any command that wants to take a commit object name can now use
113    ":/string" syntax to name a commit.
115  * "git reset" is now built-in and its output can be squelched with -q.
117  * "git reset --hard" does not make any sense in a bare
118    repository, but did not error out; fixed.
120  * "git send-email" can optionally talk over ssmtp and use SMTP-AUTH.
122  * "git rebase" learned --whitespace option.
124  * In "git rebase", when you decide not to replay a particular change
125    after the command stopped with a conflict, you can say "git rebase
126    --skip" without first running "git reset --hard", as the command now
127    runs it for you.
129  * "git rebase --interactive" mode can now work on detached HEAD.
131  * Other minor to serious bugs in "git rebase -i" have been fixed.
133  * "git rebase" now detaches head during its operation, so after a
134    successful "git rebase" operation, the reflog entry branch@{1} for
135    the current branch points at the commit before the rebase was
136    started.
138  * "git rebase -i" also triggers rerere to help your repeated merges.
140  * "git merge" can call the "post-merge" hook.
142  * "git pack-objects" can optionally run deltification with multiple
143    threads.
145  * "git archive" can optionally substitute keywords in files marked with
146    export-subst attribute.
148  * "git cherry-pick" made a misguided attempt to repeat the original
149    command line in the generated log message, when told to cherry-pick a
150    commit by naming a tag that points at it.  It does not anymore.
152  * "git for-each-ref" learned %(xxxdate:<dateformat>) syntax to show the
153    various date fields in different formats.
155  * "git gc --auto" is a low-impact way to automatically run a variant of
156    "git repack" that does not lose unreferenced objects (read: safer
157    than the usual one) after the user accumulates too many loose
158    objects.
160  * "git clean" has been rewritten in C.
162  * You need to explicitly set clean.requireForce to "false" to allow
163    "git clean" without -f to do any damage (lack of the configuration
164    variable used to mean "do not require -f option to lose untracked
165    files", but we now use the safer default).
167  * The kinds of whitespace errors "git diff" and "git apply" notice (and
168    fix) can be controlled via 'core.whitespace' configuration variable
169    and 'whitespace' attribute in .gitattributes file.
171  * "git push" learned --dry-run option to show what would happen if a
172    push is run.
174  * "git push" does not update a tracking ref on the local side when the
175    remote refused to update the corresponding ref.
177  * "git push" learned --mirror option.  This is to push the local refs
178    one-to-one to the remote, and deletes refs from the remote that do
179    not exist anymore in the repository on the pushing side.
181  * "git push" can remove a corrupt ref at the remote site with the usual
182    ":ref" refspec.
184  * "git remote" knows --mirror mode.  This is to set up configuration to
185    push into a remote repository to store local branch heads to the same
186    branch on the remote side, and remove branch heads locally removed
187    from local repository at the same time.  Suitable for pushing into a
188    back-up repository.
190  * "git remote" learned "rm" subcommand.
192  * "git cvsserver" can be run via "git shell".  Also, "cvs" is
193    recognized as a synonym for "git cvsserver", so that CVS users
194    can be switched to git just by changing their login shell.
196  * "git cvsserver" acts more like receive-pack by running post-receive
197    and post-update hooks.
199  * "git am" and "git rebase" are far less verbose.
201  * "git pull" learned to pass --[no-]ff option to underlying "git
202    merge".
204  * "git pull --rebase" is a different way to integrate what you fetched
205    into your current branch.
207  * "git fast-export" produces datastream that can be fed to fast-import
208    to reproduce the history recorded in a git repository.
210  * "git add -i" takes pathspecs to limit the set of files to work on.
212  * "git add -p" is a short-hand to go directly to the selective patch
213    subcommand in the interactive command loop and to exit when done.
215  * "git add -i" UI has been colorized.  The interactive prompt
216    and menu can be colored by setting color.interactive
217    configuration.  The diff output (including the hunk picker)
218    are colored with color.diff configuration.
220  * "git commit --allow-empty" allows you to create a single-parent
221    commit that records the same tree as its parent, overriding the usual
222    safety valve.
224  * "git commit --amend" can amend a merge that does not change the tree
225    from its first parent.
227  * "git commit" used to unconditionally strip comment lines that
228    began with '#' and removed excess blank lines.  This
229    behaviour has been made configurable.
231  * "git commit" has been rewritten in C.
233  * "git stash random-text" does not create a new stash anymore.  It was
234    a UI mistake.  Use "git stash save random-text", or "git stash"
235    (without extra args) for that.
237  * "git stash clear extra-text" does not clear the whole stash
238    anymore.  It is tempting to expect "git stash clear stash@{2}"
239    to drop only a single named stash entry, and it is rude to
240    discard everything when that is asked (but not provided).
242  * "git prune --expire <time>" can exempt young loose objects from
243    getting pruned.
245  * "git branch --contains <commit>" can list branches that are
246    descendants of a given commit.
248  * "git log" learned --early-output option to help interactive GUI
249    implementations.
251  * "git bisect" learned "skip" action to mark untestable commits.
253  * "git bisect visualize" learned a shorter synonym "git bisect view".
255  * "git bisect visualize" runs "git log" in a non-windowed
256    environments.  It also can be told what command to run (e.g. "git
257    bisect visualize tig").
259  * "git format-patch" learned "format.numbered" configuration variable
260    to automatically turn --numbered option on when more than one commits
261    are formatted.
263  * "git ls-files" learned "--exclude-standard" to use the canned set of
264    exclude files.
266  * "git tag -a -f existing" begins the editor session using the existing
267    annotation message.
269  * "git tag -m one -m bar" (multiple -m options) behaves similarly to
270    "git commit"; the parameters to -m options are formatted as separate
271    paragraphs.
273  * The format "git show" outputs an annotated tag has been updated to
274    include "Tagger: " and "Date: " lines from the tag itself.  Strictly
275    speaking this is a backward incompatible change, but this is a
276    reasonable usability fix and people's scripts shouldn't have been
277    relying on the exact output from "git show" Porcelain anyway.
279  * "git cvsimport" did not notice errors from underlying "cvsps"
280    and produced a corrupt import silently.
282  * "git cvsexportcommit" learned -w option to specify and switch to the
283    CVS working directory.
285  * "git checkout" from a subdirectory learned to use "../path" to allow
286    checking out a path outside the current directory without cd'ing up.
288  * "git checkout" from and to detached HEAD leaves a bit more
289    information in the reflog.
291  * "git send-email --dry-run" shows full headers for easier diagnosis.
293  * "git merge-ours" is now built-in.
295  * "git svn" learned "info" and "show-externals" subcommands.
297  * "git svn" run from a subdirectory failed to read settings from the
298    .git/config.
300  * "git svn" learned --use-log-author option, which picks up more
301    descriptive name from From: and Signed-off-by: lines in the commit
302    message.
304  * "git svn" wasted way too much disk to record revision mappings
305    between svn and git; a new representation that is much more compact
306    for this information has been introduced to correct this.
308  * "git svn" left temporary index files it used without cleaning them
309    up; this was corrected.
311  * "git status" from a subdirectory now shows relative paths, which
312    makes copy-and-pasting for git-checkout/git-add/git-rm easier.  The
313    traditional behaviour to show the full path relative to the top of
314    the work tree can be had by setting status.relativepaths
315    configuration variable to false.
317  * "git blame" kept text for each annotated revision in core needlessly;
318    this has been corrected.
320  * "git shortlog" learned to default to HEAD when the standard input is
321    a terminal and the user did not give any revision parameter.
323  * "git shortlog" learned "-e" option to show e-mail addresses as well as
324    authors' names.
326  * "git help" learned "-w" option to show documentation in browsers.
328  * In addition there are quite a few internal clean-ups. Notably
330    - many fork/exec have been replaced with run-command API,
331      brought from the msysgit effort.
333    - introduction and more use of the option parser API.
335    - enhancement and more use of the strbuf API.
338 Fixes since v1.5.3
339 ------------------
341 All of the fixes in v1.5.3 maintenance series are included in
342 this release, unless otherwise noted.
344 These fixes are only in v1.5.4 and not backported to v1.5.3 maintenance
345 series.
347  * The way "git diff --check" behaves is much more consistent with the way
348    "git apply --whitespace=warn" works.
350  * "git svn" talking with the SVN over http will correctly quote branch
351    and project names.
353  * "git config" did not work correctly on platforms that define
354    REG_NOMATCH to an even number.
356  * Recent versions of AsciiDoc 8 has a change to break our
357    documentation; a workaround has been implemented.
360 exec >/var/tmp/1
361 O=v1.5.4-rc2-59-g2370781
362 echo O=`git describe refs/heads/master`
363 git shortlog --no-merges $O..refs/heads/master ^refs/heads/maint