Documentation: user-manual: add information about "git help" at the beginning
[git] / Documentation / RelNotes-1.6.1.txt
1 GIT v1.6.1 Release Notes
2 ========================
3
4 Updates since v1.6.0
5 --------------------
6
7 When some commands (e.g. "git log", "git diff") spawn pager internally, we
8 used to make the pager the parent process of the git command that produces
9 output.  This meant that the exit status of the whole thing comes from the
10 pager, not the underlying git command.  We swapped the order of the
11 processes around and you will see the exit code from the command from now
12 on.
13
14 (subsystems)
15
16 * gitk can call out to git-gui to view "git blame" output; git-gui in turn
17   can run gitk from its blame view.
18
19 * Various git-gui updates including updated translations.
20
21 * Various gitweb updates from repo.or.cz installation.
22
23 (portability)
24
25 * A few test scripts used nonportable "grep" that did not work well on
26   some platforms, e.g. Solaris.
27
28 * Sample pre-auto-gc script has OS X support.
29
30 * Makefile has support for (ancient) FreeBSD 4.9.
31
32 (performance)
33
34 * The underlying diff machinery to produce textual output has been
35   optimized, which would result in faster "git blame" processing.
36
37 * Most of the test scripts (but not the ones that try to run servers)
38   can be run in parallel.
39
40 * Bash completion of refnames in a repository with massive number of
41   refs has been optimized.
42
43 * Cygwin port uses native stat/lstat implementations when applicable,
44   which leads to improved performance.
45
46 * "git push" pays attention to alternate repositories to avoid sending
47   unnecessary objects.
48
49 * "git svn" can rebuild an out-of-date rev_map file.
50
51 (usability, bells and whistles)
52
53 * When you mistype a command name, git helpfully suggests what it guesses
54   you might have meant to say.  help.autocorrect configuration can be set
55   to a non-zero value to accept the suggestion when git can uniquely
56   guess.
57
58 * The packfile machinery hopefully is more robust when dealilng with
59   corrupt packs if redundant objects involved in the corruption are
60   available elsehwere.
61
62 * "git add -N path..." adds the named paths as an empty blob, so that
63   subsequent "git diff" will show a diff as if they are creation events.
64
65 * "git apply" learned --include=paths option, similar to the existing
66   --exclude=paths option.
67
68 * "git bisect" is careful about a user mistake and suggests testing of
69   merge base first when good is not a strict ancestor of bad.
70
71 * "git blame" re-encodes the commit metainfo to UTF-8 from i18n.commitEncoding
72   by default.
73
74 * "git check-attr --stdin" can check attributes for multiple paths.
75
76 * "git checkout --track origin/hack" used to be a syntax error.  It now
77   DWIMs to create a corresponding local branch "hack", i.e. acts as if you
78   said "git checkout --track -b hack origin/hack".
79
80 * "git checkout --ours/--theirs" can be used to check out one side of a
81   conflicting merge during conflict resolution.
82
83 * "git checkout -m" can be used to recreate the initial conflicted state
84   during conflict resolution.
85
86 * "git cherry-pick" can also utilize rerere for conflict resolution.
87
88 * "git clone" learned to be verbose with -v
89
90 * "git commit --author=$name" can look up author name from existing
91   commits.
92
93 * output from "git commit" has been reworded in a more concise and yet
94   more informative way.
95
96 * "git count-objects" reports the on-disk footprint for packfiles and
97   their corresponding idx files.
98
99 * "git daemon" learned --max-connections=<count> option.
100
101 * "git daemon" exports REMOTE_ADDR to record client address, so that
102   spawned programs can act differently on it.
103
104 * "git describe --tags" favours closer lightweight tags than farther
105   annotated tags now.
106
107 * "git diff" learned to mimic --suppress-blank-empty from GNU diff via a
108   configuration option.
109
110 * "git diff" learned to put more sensible hunk headers for Python,
111   HTML and ObjC contents.
112
113 * "git diff" learned to vary the a/ vs b/ prefix depending on what are
114   being compared, controlled by diff.mnemonicprefix configuration.
115
116 * "git diff" learned --dirstat-by-file to count changed files, not number
117   of lines, when summarizing the global picture.
118
119 * "git diff" learned "textconv" filters --- a binary or hard-to-read
120   contents can be munged into human readable form and the difference
121   between the results of the conversion can be viewed (obviously this
122   cannot produce a patch that can be applied, so this is disabled in
123   format-patch among other things).
124
125 * "git diff" hunk header pattern for ObjC has been added.
126
127 * "--cached" option to "git diff has an easier to remember synonym "--staged",
128   to ask "what is the difference between the given commit and the
129   contents staged in the index?"
130
131 * a "textconv" filter that makes binary files textual form for human
132    consumption can be specified as an attribute for paths; "git diff"
133    learnt to make use of it.
134
135 * "git for-each-ref" learned "refname:short" token that gives an
136   unambiguously abbreviated refname.
137
138 * Auto-numbering of the subject lines is the default for "git
139   format-patch" now.
140
141 * "git grep" learned to accept -z similar to GNU grep.
142
143 * "git help" learned to use GIT_MAN_VIEWER environment variable before
144   using "man" program.
145
146 * "git imap-send" can optionally talk SSL.
147
148 * "git index-pack" is more careful against disk corruption while
149   completing a thin pack.
150
151 * "git log --check" and "git log --exit-code" passes their underlying diff
152   status with their exit status code.
153
154 * "git log" learned --simplify-merges, a milder variant of --full-history;
155   "gitk --simplify-merges" is easier to view than with --full-history.
156
157 * "git log" learned "--source" to show what ref each commit was reached
158   from.
159
160 * "git log" also learned "--simplify-by-decration" to show the
161   birds-eye-view of the topology of the history.
162
163 * "git log --pretty=format:" learned "%d" format element that inserts
164   names of tags that point at the commit.
165
166 * "git merge --squash" and "git merge --no-ff" into an unborn branch are
167   noticed as user errors.
168
169 * "git merge -s $strategy" can use a custom built strategy if you have a
170   command "git-merge-$strategy" on your $PATH.
171
172 * "git push" can be told to reject deletion of refs with receive.denyDeletes
173   configuration.
174
175 * "git rebase" honours pre-rebase hook; use --no-verify to bypass it.
176
177 * "git rebase -p" uses interactive rebase machinery now to preserve the merges.
178
179 * "git reflog expire branch" can be used in place of "git reflog expire
180   refs/heads/branch".
181
182 * "git remote show $remote" lists remote branches one-per-line now.
183
184 * when giving up resolving a conflicted merge, "git reset --hard" failed
185   to remove new paths from the working tree. [cherry-pick to 'maint'?]
186
187 * "git submodule foreach" subcommand allows you to iterate over checked
188   out submodules.
189
190 * "git submodule sync" subcommands allows you to update the origin URL
191   recorded in submodule directories from the toplevel .gitmodules file.
192
193 * "git svn branch" can create new branches on the other end.
194
195 * "gitweb" can use more saner PATH_INFO based URL.
196
197 (internal)
198
199 * "git hash-object" learned to lie about the path being hashed, so that
200   correct gitattributes processing can be done while hashing contents
201   stored in a temporary file.
202
203 * various callers of git-merge-recursive avoid forking it as an external
204   process.
205
206 * Git class defined in "Git.pm" can be subclasses a bit more easily.
207
208 * We used to link GNU regex library as a compatibility layer for some
209   platforms, but it turns out it is not necessary on most of them.
210
211 * Some path handling routines used fixed number of buffers used alternately
212   but depending on the call depth, this arrangement led to hard to track
213   bugs.  This issue is being addressed.
214
215
216 Fixes since v1.6.0
217 ------------------
218
219 All of the fixes in v1.6.0.X maintenance series are included in this
220 release, unless otherwise noted.
221
222 * "git add" and "git update-index" incorrectly allowed adding S/F when S
223   is a tracked symlink that points at a directory D that has a path F in
224   it (we still need to fix a similar nonsense when S is a submodule and F
225   is a path in it).
226
227 * "git diff --stdin" used to take two trees on a line and compared them,
228   but we dropped support for such a use case long time ago.  This has
229   been resurrected.
230
231 * Giving 3 or more tree-ish to "git diff" is supposed to show the combined
232   diff from second and subsequent trees to the first one.  b75271d ("git
233   diff <tree>{3,}": do not reverse order of arguments, 2008-10-10) needs
234   to be cherry-picked to 'maint'.
235
236 * "git filter-branch" failed to rewrite a tag name with slashes in it.
237
238 * "git repack" used to grab objects out of packs marked with .keep
239   into a new pack (fix scheduled to be further downmerged to maint).
240
241 * "git push --tags --all $there" failed with generic usage message without
242   telling saying these two options are incompatible.
243
244 * "git log --author/--committer" match used to potentially match the
245   timestamp part, exposing internal implementation detail.  Also these did
246   not work with --fixed-strings match at all.
247
248 * "git tag" did not complain about incompatible combination of options
249   e.g. "tag -l -d" (fix scheduled to be further downmerged to maint).
250
251 * Internal diff machinery had a corner case performance bug that choked on a
252   large file with many repeated contents (fix scheduled to be further cherry-
253   picked to maint).
254
255 --
256 exec >/var/tmp/1
257 O=v1.6.0.4-697-g168d5bd
258 echo O=$(git describe master)
259 git shortlog --no-merges $O..master ^maint