RelNotes: spelling and phrasing fixups
Signed-off-by: Marc Branchaud <marcnarc@xiplink.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Marc Branchaud committed
Nov 24, 2016 at 11:59 UTC
aeddbfdfa48443c034a9b28b10dfddf2f71b907f
1 file changed
+72
-76
Documentation/RelNotes/2.11.0.txt
+72
-76
@@ -57,39 +57,40 @@ UI, Workflows & Features
57
58
* Even though "git hash-objects", which is a tool to take an
59
on-filesystem data stream and put it into the Git object store,
60
- allowed to perform the "outside-world-to-Git" conversions (e.g.
60
+ can perform "outside-world-to-Git" conversions (e.g.
61
end-of-line conversions and application of the clean-filter), and
62
- it had the feature on by default from very early days, its reverse
62
+ it has had this feature on by default from very early days, its reverse
63
operation "git cat-file", which takes an object from the Git object
64
- store and externalize for the consumption by the outside world,
64
+ store and externalizes it for consumption by the outside world,
65
lacked an equivalent mechanism to run the "Git-to-outside-world"
66
conversion. The command learned the "--filters" option to do so.
67
68
- * Output from "git diff" can be made easier to read by selecting
68
+ * Output from "git diff" can be made easier to read by intelligently selecting
69
which lines are common and which lines are added/deleted
70
- intelligently when the lines before and after the changed section
71
- are the same. A command line option is added to help with the
72
- experiment to find a good heuristics.
70
+ when the lines before and after the changed section
71
+ are the same. A command line option (--indent-heuristic) and a
72
+ configuration variable (diff.indentHeuristic) are added to help with the
73
+ experiment to find good heuristics.
74
75
* In some projects, it is common to use "[RFC PATCH]" as the subject
76
prefix for a patch meant for discussion rather than application. A
76
- new option "--rfc" is a short-hand for "--subject-prefix=RFC PATCH"
77
+ new format-patch option "--rfc" is a short-hand for "--subject-prefix=RFC PATCH"
78
to help the participants of such projects.
79
79
- * "git add --chmod=+x <pathspec>" added recently only toggled the
80
+ * "git add --chmod={+,-}x <pathspec>" only changed the
81
executable bit for paths that are either new or modified. This has
81
- been corrected to flip the executable bit for all paths that match
82
+ been corrected to change the executable bit for all paths that match
83
the given pathspec.
84
85
* When "git format-patch --stdout" output is placed as an in-body
85
- header and it uses the RFC2822 header folding, "git am" failed to
86
+ header and it uses RFC2822 header folding, "git am" fails to
87
put the header line back into a single logical line. The
88
underlying "git mailinfo" was taught to handle this properly.
89
90
* "gitweb" can spawn "highlight" to show blob contents with
91
(programming) language-specific syntax highlighting, but only
92
when the language is known. "highlight" can however be told
92
- to make the guess itself by giving it "--force" option, which
93
+ to guess the language itself by giving it "--force" option, which
94
has been enabled.
95
96
* "git gui" l10n to Portuguese.
@@ -109,19 +110,19 @@ UI, Workflows & Features
110
history leading to nth parent was looking the other way.
111
112
* In recent versions of cURL, GSSAPI credential delegation is
112
- disabled by default due to CVE-2011-2192; introduce a configuration
113
- to selectively allow enabling this.
113
+ disabled by default due to CVE-2011-2192; introduce a http.delegation
114
+ configuration variable to selectively allow enabling this.
115
(merge 26a7b23429 ps/http-gssapi-cred-delegation later to maint).
116
117
* "git mergetool" learned to honor "-O<orderfile>" to control the
118
order of paths to present to the end user.
119
120
* "git diff/log --ws-error-highlight=<kind>" lacked the corresponding
120
- configuration variable to set it by default.
121
+ configuration variable (diff.wsErrorHighlight) to set it by default.
122
122
- * "git ls-files" learned "--recurse-submodules" option that can be
123
- used to get a listing of tracked files across submodules (i.e. this
124
- only works with "--cached" option, not for listing untracked or
123
+ * "git ls-files" learned the "--recurse-submodules" option
124
+ to get a listing of tracked files across submodules (i.e. this
125
+ only works with the "--cached" option, not for listing untracked or
126
ignored files). This would be a useful tool to sit on the upstream
127
side of a pipe that is read with xargs to work on all working tree
128
files from the top-level superproject.
@@ -130,7 +131,7 @@ UI, Workflows & Features
131
implementations of XDG Secret Service API has been added to
132
contrib/credential/.
133
133
- * The GPG verification status shown in "%G?" pretty format specifier
134
+ * The GPG verification status shown by the "%G?" pretty format specifier
135
was not rich enough to differentiate a signature made by an expired
136
key, a signature made by a revoked key, etc. New output letters
137
have been assigned to express them.
@@ -139,17 +140,17 @@ UI, Workflows & Features
140
learned to turn "git describe" output (e.g. v2.9.3-599-g2376d31787)
141
into clickable links in its output.
142
142
- * When new paths were added by "git add -N" to the index, it was
143
- enough to circumvent the check by "git commit" to refrain from
144
- making an empty commit without "--allow-empty". The same logic
145
- prevented "git status" to show such a path as "new file" in the
143
+ * "git commit" created an empty commit when invoked with an index
144
+ consisting solely of intend-to-add paths (added with "git add -N").
145
+ It now requires the "--allow-empty" option to create such a commit.
146
+ The same logic prevented "git status" from showing such paths as "new files" in the
147
"Changes not staged for commit" section.
148
148
- * The smudge/clean filter API expect an external process is spawned
149
- to filter the contents for each path that has a filter defined. A
149
+ * The smudge/clean filter API spawns an external process
150
+ to filter the contents of each path that has a filter defined. A
151
new type of "process" filter API has been added to allow the first
152
request to run the filter for a path to spawn a single process, and
152
- all filtering need is served by this single process for multiple
153
+ all filtering is served by this single process for multiple
154
paths, reducing the process creation overhead.
155
156
* The user always has to say "stash@{$N}" when naming a single
@@ -173,7 +174,7 @@ Performance, Internal Implementation, Development Support etc.
174
script file "git am" internally uses.
175
(merge a77598e jc/am-read-author-file later to maint).
176
176
- * Lifts calls to exit(2) and die() higher in the callchain in
177
+ * Lift calls to exit(2) and die() higher in the callchain in
178
sequencer.c files so that more helper functions in it can be used
179
by callers that want to handle error conditions themselves.
180
@@ -192,13 +193,13 @@ Performance, Internal Implementation, Development Support etc.
193
does not advertise any refs, but "git fetch" was not prepared to
194
see such an advertisement. When the other side disconnects without
195
giving any ref advertisement, we used to say "there may not be a
195
- repository at that URL", but we may have seen other advertisement
196
+ repository at that URL", but we may have seen other advertisements
197
like "shallow" and ".have" in which case we definitely know that a
198
repository is there. The code to detect this case has also been
199
updated.
200
201
* Some codepaths in "git pack-objects" were not ready to use an
201
- existing pack bitmap; now they are and as the result they have
202
+ existing pack bitmap; now they are and as a result they have
203
become faster.
204
205
* The codepath in "git fsck" to detect malformed tree objects has
@@ -214,7 +215,7 @@ Performance, Internal Implementation, Development Support etc.
215
packfile first.
216
(merge c9af708b1a jk/pack-objects-optim-mru later to maint).
217
217
- * Codepaths involved in interacting alternate object store have
218
+ * Codepaths involved in interacting alternate object stores have
219
been cleaned up.
220
221
* In order for the receiving end of "git push" to inspect the
@@ -222,7 +223,7 @@ Performance, Internal Implementation, Development Support etc.
223
from the sending end need to be made available to the hook and
224
the mechanism for the connectivity check, and this was done
225
traditionally by storing the objects in the receiving repository
225
- and letting "git gc" to expire it. Instead, store the newly
226
+ and letting "git gc" expire them. Instead, store the newly
227
received objects in a temporary area, and make them available by
228
reusing the alternate object store mechanism to them only while we
229
decide if we accept the check, and once we decide, either migrate
@@ -237,7 +238,7 @@ Performance, Internal Implementation, Development Support etc.
238
replaced with a priority queue.
239
240
* "git diff --no-index" codepath has been updated not to try to peek
240
- into .git/ directory that happens to be under the current
241
+ into a .git/ directory that happens to be under the current
242
directory, when we know we are operating outside any repository.
243
244
* Update of the sequencer codebase to make it reusable to reimplement
@@ -251,8 +252,8 @@ Performance, Internal Implementation, Development Support etc.
252
holding onto them. Use O_CLOEXEC flag to open files in various
253
codepaths.
254
254
- * Update "interpret-trailers" machinery and teaches it that people in
255
- real world write all sorts of crufts in the "trailer" that was
255
+ * Update "interpret-trailers" machinery and teach it that people in
256
+ the real world write all sorts of cruft in the "trailer" that was
257
originally designed to have the neat-o "Mail-Header: like thing"
258
and nothing else.
259
@@ -280,7 +281,7 @@ notes for details).
281
has been removed.
282
283
* Having a submodule whose ".git" repository is somehow corrupt
283
- caused a few commands that recurse into submodules loop forever.
284
+ caused a few commands that recurse into submodules to loop forever.
285
286
* "git symbolic-ref -d HEAD" happily removes the symbolic ref, but
287
the resulting repository becomes an invalid one. Teach the command
@@ -308,12 +309,12 @@ notes for details).
309
forgot to update "git gui" to look at the configuration to match
310
this change.
311
311
- * "git add --chmod=+x" added recently lacked documentation, which has
312
+ * "git add --chmod={+,-}x" added recently lacked documentation, which has
313
been corrected.
314
315
* "git log --cherry-pick" used to include merge commits as candidates
316
to be matched up with other commits, resulting a lot of wasted time.
316
- The patch-id generation logic has been updated to ignore merges to
317
+ The patch-id generation logic has been updated to ignore merges and
318
avoid the wastage.
319
320
* The http transport (with curl-multi option, which is the default
@@ -333,20 +334,20 @@ notes for details).
334
line of the next one. This process may have to merge two adjacent
335
hunks, but the code forgot to do so in some cases.
336
336
- * Performance tests done via "t/perf" did not use the same set of
337
+ * Performance tests done via "t/perf" did not use the right
338
build configuration if the user relied on autoconf generated
339
configuration.
340
341
* "git format-patch --base=..." feature that was recently added
341
- showed the base commit information after "-- " e-mail signature
342
+ showed the base commit information after the "-- " e-mail signature
343
line, which turned out to be inconvenient. The base information
344
has been moved above the signature line.
345
346
* More i18n.
347
348
* Even when "git pull --rebase=preserve" (and the underlying "git
348
- rebase --preserve") can complete without creating any new commit
349
- (i.e. fast-forwards), it still insisted on having a usable ident
349
+ rebase --preserve") can complete without creating any new commits
350
+ (i.e. fast-forwards), it still insisted on having usable ident
351
information (read: user.email is set correctly), which was less
352
than nice. As the underlying commands used inside "git rebase"
353
would fail with a more meaningful error message and advice text
@@ -396,7 +397,7 @@ notes for details).
397
* Documentation around tools to import from CVS was fairly outdated.
398
399
* "git clone --recurse-submodules" lost the progress eye-candy in
399
- recent update, which has been corrected.
400
+ a recent update, which has been corrected.
401
402
* A low-level function verify_packfile() was meant to show errors
403
that were detected without dying itself, but under some conditions
@@ -409,23 +410,23 @@ notes for details).
410
to a design bug, which has been fixed.
411
412
* In the codepath that comes up with the hostname to be used in an
412
- e-mail when the user didn't tell us, we looked at ai_canonname
413
+ e-mail when the user didn't tell us, we looked at the ai_canonname
414
field in struct addrinfo without making sure it is not NULL first.
415
416
* "git worktree", even though it used the default_abbrev setting that
416
- ought to be affected by core.abbrev configuration variable, ignored
417
+ ought to be affected by the core.abbrev configuration variable, ignored
418
the variable setting. The command has been taught to read the
419
default set of configuration variables to correct this.
420
421
* "git init" tried to record core.worktree in the repository's
421
- 'config' file when GIT_WORK_TREE environment variable was set and
422
+ 'config' file when the GIT_WORK_TREE environment variable was set and
423
it was different from where GIT_DIR appears as ".git" at its top,
424
but the logic was faulty when .git is a "gitdir:" file that points
425
at the real place, causing trouble in working trees that are
426
managed by "git worktree". This has been corrected.
427
428
* Codepaths that read from an on-disk loose object were too loose in
428
- validating what they are reading is a proper object file and
429
+ validating that they are reading a proper object file and
430
sometimes read past the data they read from the disk, which has
431
been corrected. H/t to Gustavo Grieco for reporting.
432
@@ -434,8 +435,8 @@ notes for details).
435
time, and "git gui" was the last in-tree user of the syntax. This
436
is finally fixed, so that we can move forward with the deprecation.
437
437
- * An author name, that spelled a backslash-quoted double quote in the
438
- human readable part "My \"double quoted\" name", was not unquoted
438
+ * An author name that has a backslash-quoted double quote in the
439
+ human readable part ("My \"double quoted\" name"), was not unquoted
440
correctly while applying a patch from a piece of e-mail.
441
442
* Doc update to clarify what "log -3 --reverse" does.
@@ -449,11 +450,10 @@ notes for details).
450
has been fixed; this did not affect any existing code as nobody
451
tried to write anything after the padding on such a line, though.
452
452
- * The code that parses the format parameter of for-each-ref command
453
+ * The code that parses the format parameter of the for-each-ref command
454
has seen a micro-optimization.
455
455
- * When we started cURL to talk to imap server when a new enough
456
- version of cURL library is available, we forgot to explicitly add
456
+ * When we started to use cURL to talk to an imap server, we forgot to explicitly add
457
imap(s):// before the destination. To some folks, that didn't work
458
and the library tried to make HTTP(s) requests instead.
459
@@ -474,13 +474,12 @@ notes for details).
474
"Give me only the history since that version".
475
(merge cccf74e2da nd/shallow-deepen later to maint).
476
477
- * It is a common mistake to say "git blame --reverse OLD path",
478
- expecting that the command line is dwimmed as if asking how lines
477
+ * "git blame --reverse OLD path" is now DWIMmed to show how lines
478
in path in an old revision OLD have survived up to the current
479
commit.
480
(merge e1d09701a4 jc/blame-reverse later to maint).
481
483
- * http.emptyauth configuration is a way to allow an empty username to
482
+ * The http.emptyauth configuration variable is a way to allow an empty username to
483
pass when attempting to authenticate using mechanisms like
484
Kerberos. We took an unspecified (NULL) username and sent ":"
485
(i.e. no username, no password) to CURLOPT_USERPWD, but did not do
@@ -494,20 +493,20 @@ notes for details).
493
-p <paths>" adds to the current contents of the index to come up
494
with what to commit.
495
497
- * A stray symbolic link in $GIT_DIR/refs/ directory could make name
496
+ * A stray symbolic link in the $GIT_DIR/refs/ directory could make name
497
resolution loop forever, which has been corrected.
498
499
* The "submodule.<name>.path" stored in .gitmodules is never copied
500
to .git/config and such a key in .git/config has no meaning, but
502
- the documentation described it and submodule.<name>.url next to
503
- each other as if both belong to .git/config. This has been fixed.
501
+ the documentation described it next to submodule.<name>.url
502
+ as if both belong to .git/config. This has been fixed.
503
505
- * In a worktree connected to a repository elsewhere, created via "git
504
+ * In a worktree created via "git
505
worktree", "git checkout" attempts to protect users from confusion
506
by refusing to check out a branch that is already checked out in
507
another worktree. However, this also prevented checking out a
509
- branch, which is designated as the primary branch of a bare
510
- reopsitory, in a worktree that is connected to the bare
508
+ branch which is designated as the primary branch of a bare
509
+ repository, in a worktree that is connected to the bare
510
repository. The check has been corrected to allow it.
511
512
* "git rebase" immediately after "git clone" failed to find the fork
@@ -515,7 +514,7 @@ notes for details).
514
515
* When fetching from a remote that has many tags that are irrelevant
516
to branches we are following, we used to waste way too many cycles
518
- when checking if the object pointed at by a tag (that we are not
517
+ checking if the object pointed at by a tag (that we are not
518
going to fetch!) exists in our repository too carefully.
519
520
* Protect our code from over-eager compilers.
@@ -524,27 +523,24 @@ notes for details).
523
"." instead of the branch name; the documentation has been updated
524
to describe it.
525
527
- * A hot-fix for a test added by a recent topic that went to both
528
- 'master' and 'maint' already.
529
-
526
* "git send-email" attempts to pick up valid e-mails from the
531
- trailers, but people in real world write non-addresses there, like
527
+ trailers, but people in the real world write non-addresses there, like
528
"Cc: Stable <add@re.ss> # 4.8+", which broke the output depending
533
- on the availability and vintage of Mail::Address perl module.
529
+ on the availability and vintage of the Mail::Address perl module.
530
(merge dcfafc5214 mm/send-email-cc-cruft-after-address later to maint).
531
536
- * The Travis CI configuration we ship ran the tests with --verbose
532
+ * The Travis CI configuration we ship ran the tests with the --verbose
533
option but this risks non-TAP output that happens to be "ok" to be
534
misinterpreted as TAP signalling a test that passed. This resulted
539
- in unnecessary failure. This has been corrected by introducing a
535
+ in unnecessary failures. This has been corrected by introducing a
536
new mode to run our tests in the test harness to send the verbose
537
output separately to the log file.
538
543
- * Some AsciiDoc formatter mishandles a displayed illustration with
539
+ * Some AsciiDoc formatters mishandle a displayed illustration with
540
tabs in it. Adjust a few of them in merge-base documentation to
541
work around them.
542
547
- * A minor regression fix for "git submodule" that was introduced
543
+ * Fixed a minor regression in "git submodule" that was introduced
544
when more helper functions were reimplemented in C.
545
(merge 77b63ac31e sb/submodule-ignore-trailing-slash later to maint).
546
@@ -553,19 +549,19 @@ notes for details).
549
theoretical world.
550
(merge bb84735c80 rs/ring-buffer-wraparound later to maint).
551
556
- * "git daemon" used fixed-length buffers to turn URL to the
552
+ * "git daemon" used fixed-length buffers to turn URLs to the
553
repository the client asked for into the server side directory
558
- path, using snprintf() to avoid overflowing these buffers, but
554
+ paths, using snprintf() to avoid overflowing these buffers, but
555
allowed possibly truncated paths to the directory. This has been
560
- tightened to reject such a request that causes overlong path to be
561
- required to serve.
556
+ tightened to reject such a request that causes an overlong path to be
557
+ served.
558
(merge 6bdb0083be jk/daemon-path-ok-check-truncation later to maint).
559
560
* Recent update to git-sh-setup (a library of shell functions that
561
are used by our in-tree scripted Porcelain commands) included
562
another shell library git-sh-i18n without specifying where it is,
563
relying on the $PATH. This has been fixed to be more explicit by
568
- prefixing $(git --exec-path) output in front.
564
+ prefixing with $(git --exec-path) output.
565
(merge 1073094f30 ak/sh-setup-dot-source-i18n-fix later to maint).
566
567
* Fix for a racy false-positive test failure.
@@ -578,7 +574,7 @@ notes for details).
574
caused the command to segfault when on an unborn branch.
575
(merge 84679d470d jc/for-each-ref-head-segfault-fix later to maint).
576
581
- * "git rebase -i" did not work well with core.commentchar
577
+ * "git rebase -i" did not work well with the core.commentchar
578
configuration variable for two reasons, both of which have been
579
fixed.
580
(merge 882cd23777 js/rebase-i-commentchar-fix later to maint).