Document what the stage numbers in the :$n:path syntax mean.
[git/dscho.git] / Documentation / RelNotes-1.5.3.txt
blob9c36e8baebfe605c7d2bcfad87d425601aa771ad
1 GIT v1.5.3 Release Notes
2 ========================
4 Updates since v1.5.2
5 --------------------
7 * The commit walkers other than http are officially deprecated,
8   but still supported for now.
10 * The submodule support has Porcelain layer.
12   Note that the current submodule support is minimal and this is
13   deliberately so.  A design decision we made is that operations
14   at the supermodule level do not recurse into submodules by
15   default.  The expectation is that later we would add a
16   mechanism to tell git which submodules the user is interested
17   in, and this information might be used to determine the
18   recursive behaviour of certain commands (e.g. "git checkout"
19   and "git diff"), but currently we haven't agreed on what that
20   mechanism should look like.  Therefore, if you use submodules,
21   you would probably need "git submodule update" on the
22   submodules you care about after running a "git checkout" at
23   the supermodule level.
25 * There are a handful pack-objects changes to help you cope better
26   with repositories with pathologically large blobs in them.
28 * For people who need to import from Perforce, a front-end for
29   fast-import is in contrib/fast-import/.
31 * Comes with git-gui 0.8.0.
33 * Comes with updated gitk.
35 * New commands and options.
37   - "git log --date=<format>" can use more formats: iso8601, rfc2822.
39   - The hunk header output from "git diff" family can be customized
40     with the attributes mechanism.  See gitattributes(5) for details.
42   - "git stash" allows you to quickly save away your work in
43     progress and replay it later on an updated state.
45   - "git rebase" learned an "interactive" mode that let you
46     pick and reorder which commits to rebuild.
48   - "git fsck" can save its findings in $GIT_DIR/lost-found, without a
49     separate invocation of "git lost-found" command.  The blobs stored by
50     lost-found are stored in plain format to allow you to grep in them.
52   - $GIT_WORK_TREE environment variable can be used together with
53     $GIT_DIR to work in a subdirectory of a working tree that is
54     not located at "$GIT_DIR/..".
56   - Giving "--file=<file>" option to "git config" is the same as
57     running the command with GIT_CONFIG=<file> environment.
59   - "git log" learned a new option "--follow", to follow
60     renaming history of a single file.
62   - "git filter-branch" lets you rewrite the revision history of
63     specified branches. You can specify a number of filters to
64     modify the commits, files and trees.
66   - "git cvsserver" learned new options (--base-path, --export-all,
67     --strict-paths) inspired by "git daemon".
69   - "git daemon --base-path-relaxed" can help migrating a repository URL
70     that did not use to use --base-path to use --base-path.
72   - "git commit" can use "-t templatefile" option and commit.template
73     configuration variable to prime the commit message given to you in the
74     editor.
76   - "git submodule" command helps you manage the projects from
77     the superproject that contain them.
79   - In addition to core.compression configuration option,
80     core.loosecompression and pack.compression options can
81     independently tweak zlib compression levels used for loose
82     and packed objects.
84   - "git ls-tree -l" shows size of blobs pointed at by the
85     tree entries, similar to "/bin/ls -l".
87   - "git rev-list" learned --regexp-ignore-case and
88     --extended-regexp options to tweak its matching logic used
89     for --grep fitering.
91   - "git describe --contains" is a handier way to call more
92     obscure command "git name-rev --tags".
94   - "git gc --aggressive" tells the command to spend more cycles
95     to optimize the repository harder.
97   - "git repack" learned a "window-memory" limit which
98     dynamically reduces the window size to stay within the
99     specified memory usage.
101   - "git repack" can be told to split resulting packs to avoid
102     exceeding limit specified with "--max-pack-size".
104   - "git fsck" gained --verbose option.  This is really really
105     verbose but it might help you identify exact commit that is
106     corrupt in your repository.
108   - "git format-patch" learned --numbered-files option.  This
109     may be useful for MH users.
111   - "git format-patch" learned format.subjectprefix configuration
112     variable, which serves the same purpose as "--subject-prefix"
113     option.
115   - "git tag -n -l" shows tag annotations while listing tags.
117   - "git cvsimport" can optionally use the separate-remote layout.
119   - "git blame" can be told to see through commits that change
120     whitespaces and indentation levels with "-w" option.
122   - "git send-email" can be told not to thread the messages when
123     sending out more than one patches.
125   - "git config" learned NUL terminated output format via -z to
126     help scripts.
128   - "git add" learned "--refresh <paths>..." option to selectively refresh
129     the cached stat information.
131   - "git init -q" makes the command quieter.
133 * Updated behavior of existing commands.
135   - "gitweb" can offer multiple snapshot formats.
137     ***NOTE*** Unfortunately, this changes the format of the
138     $feature{snapshot}{default} entry in the per-site
139     configuration file 'gitweb_config.perl'.  It used to be a
140     three-element tuple that describe a single format; with the
141     new configuration item format, you only have to say the name
142     of the format ('tgz', 'tbz2' or 'zip').  Please update the
143     your configuration file accordingly.
145   - "git clone" uses -l (hardlink files under .git) by default when
146     cloning locally.
148   - "git bundle create" can now create a bundle without negative refs,
149     i.e. "everything since the beginning up to certain points".
151   - "git diff" (but not the plumbing level "git diff-tree") now
152     recursively descends into trees by default.
154   - "git diff" does not show differences that come only from
155     stat-dirtiness in the form of "diff --git" header anymore.  When
156     generating a textual diff, it shows a warning message at the end.
158   - The editor to use with many interactive commands can be
159     overridden with GIT_EDITOR environment variable, or if it
160     does not exist, with core.editor configuration variable.  As
161     before, if you have neither, environment variables VISUAL
162     and EDITOR are consulted in this order, and then finally we
163     fall back on "vi".
165   - "git rm --cached" does not complain when removing a newly
166     added file from the index anymore.
168   - Options to "git log" to affect how --grep/--author options look for
169     given strings now have shorter abbreviations.  -i is for ignore case,
170     and -E is for extended regexp.
172   - "git log" learned --log-size to show the number of bytes in
173     the log message part of the output to help qgit.
175   - "git svn dcommit" retains local merge information.
177   - "git svnimport" allows an empty string to be specified as the
178     trunk/ directory.  This is necessary to suck data from a SVN
179     repository that doe not have trunk/ branches/ and tags/ organization
180     at all.
182   - "git config" to set values also honors type flags like --bool
183     and --int.
185   - core.quotepath configuration can be used to make textual git
186     output to emit most of the characters in the path literally.
188   - "git mergetool" chooses its backend more wisely, taking
189     notice of its environment such as use of X, Gnome/KDE, etc.
191   - "gitweb" shows merge commits a lot nicer than before.  The
192     default view uses more compact --cc format, while the UI
193     allows to choose normal diff with any parent.
195   - snapshot files "gitweb" creates from a repository at
196     $path/$project/.git are more useful.  We use $project part
197     in the filename, which we used to discard.
199   - "git cvsimport" creates lightweight tags; there is no
200     interesting information we can record in an annotated tag,
201     and the handcrafted ones the old code created was not
202     properly formed anyway.
204   - "git push" pretends that you immediately fetched back from
205     the remote by updating corresponding remote tracking
206     branches if you have any.
208   - The diffstat given after a merge (or a pull) honors the
209     color.diff configuration.
211   - "git commit --amend" is now compatible with various message source
212     options such as -m/-C/-c/-F.
214   - "git apply --whitespace=strip" removes blank lines added at
215     the end of the file.
217   - "git fetch" over git native protocols with "-v" option shows
218     connection status, and the IP address of the other end, to
219     help diagnosing problems.
221   - We used to have core.legacyheaders configuration, when
222     set to false, allowed git to write loose objects in a format
223     that mimicks the format used by objects stored in packs.  It
224     turns out that this was not so useful.  Although we will
225     continue to read objects written in that format, we do not
226     honor that configuration anymore and create loose objects in
227     the legacy/traditional format.
229   - "--find-copies-harder" option to diff family can now be
230     spelled as "-C -C" for brevity.
232   - "git mailsplit" (hence "git am") can read from Maildir
233     formatted mailboxes.
235   - "git cvsserver" does not barf upon seeing "cvs login"
236     request.
238   - "pack-objects" honors "delta" attribute set in
239     .gitattributes.  It does not attempt to deltify blobs that
240     come from paths with delta attribute set to false.
242   - "new-workdir" script (in contrib) can now be used with a
243     bare repository.
245   - "git mergetool" learned to use gvimdiff.
247   - "gitview" (in contrib) has a better blame interface.
249   - "git log" and friends did not handle a commit log message
250     that is larger than 16kB; they do now.
252   - "--pretty=oneline" output format for "git log" and friends
253     deals with "malformed" commit log messages that have more
254     than one lines in the first paragraph better.  We used to
255     show the first line, cutting the title at mid-sentence; we
256     concatenate them into a single line and treat the result as
257     "oneline".
259   - "git p4import" has been demoted to contrib status.  For
260     a superior option, checkout the "git p4" front end to
261     "git fast-import" (also in contrib).  The man page and p4
262     rpm have been removed as well.
264   - "git mailinfo" (hence "am") now tries to see if the message
265     is in utf-8 first, instead of assuming iso-8859-1, if
266     incoming e-mail does not say what encoding it is in.
268 * Builds
270   - old-style function definitions (most notably, a function
271     without parameter defined with "func()", not "func(void)")
272     have been eradicated.
274   - "git tag" and "git verify-tag" have been rewritten in C.
276 * Performance Tweaks
278   - "git pack-objects" avoids re-deltification cost by caching
279     small enough delta results it creates while looking for the
280     best delta candidates.
282   - "git pack-objects" learned a new heuristcs to prefer delta
283     that is shallower in depth over the smallest delta
284     possible.  This improves both overall packfile access
285     performance and packfile density.
287   - diff-delta code that is used for packing has been improved
288     to work better on big files.
290   - when there are more than one pack files in the repository,
291     the runtime used to try finding an object always from the
292     newest packfile; it now tries the same packfile as we found
293     the object requested the last time, which exploits the
294     locality of references.
296   - verifying pack contents done by "git fsck --full" got boost
297     by carefully choosing the order to verify objects in them.
299   - "git read-tree -m" to read into an already populated index
300     has been optimized vastly.  The effect of this can be seen
301     when switching branches that have differences in only a
302     handful paths.
304   - "git commit paths..." has also been optimized.
307 Fixes since v1.5.2
308 ------------------
310 All of the fixes in v1.5.2 maintenance series are included in
311 this release, unless otherwise noted.
313 * Bugfixes
315   - "gitweb" had trouble handling non UTF-8 text with older
316     Encode.pm Perl module.
319 exec >/var/tmp/1
320 O=v1.5.3-rc4
321 echo O=`git describe refs/heads/master`
322 git shortlog --no-merges $O..refs/heads/master ^refs/heads/maint