[PATCH 5/5] RelNotes: wordsmithing

2015-04-23 Thread Michael Haggerty
Make many textual tweaks to the 2.4.0 release notes.

Signed-off-by: Michael Haggerty 
---
 Documentation/RelNotes/2.4.0.txt | 336 ---
 1 file changed, 172 insertions(+), 164 deletions(-)

diff --git a/Documentation/RelNotes/2.4.0.txt b/Documentation/RelNotes/2.4.0.txt
index 7b23ca3..cde64be 100644
--- a/Documentation/RelNotes/2.4.0.txt
+++ b/Documentation/RelNotes/2.4.0.txt
@@ -6,19 +6,19 @@ Backward compatibility warning(s)
 
 This release has a few changes in the user-visible output from
 Porcelain commands. These are not meant to be parsed by scripts, but
-the users still may want to be aware of the changes:
+users still may want to be aware of the changes:
 
- * Output from "git log --decorate" (and "%d" format specifier used in
-   the userformat "--format=" parameter "git log" family of
-   command takes) used to list "HEAD" just like other tips of branch
-   names, separated with a comma in between.  E.g.
+ * The output from "git log --decorate" (and, more generally, the "%d"
+   format specifier used in the "--format=" parameter to the
+   "git log" family of commands) has changed. It used to list "HEAD"
+   just like other branches; e.g.,
 
  $ git log --decorate -1 master
  commit bdb0f6788fa5e3cacc4315e9ff318a27b2676ff4 (HEAD, master)
  ...
 
-   This release updates the output slightly when HEAD refers to the tip
-   of a branch whose name is also shown in the output.  The above is
+   This release changes the output slightly when HEAD refers to a
+   branch whose name is also shown in the output. The above is now
shown as:
 
  $ git log --decorate -1 master
@@ -26,15 +26,15 @@ the users still may want to be aware of the changes:
  ...
 
  * The phrasing "git branch" uses to describe a detached HEAD has been
-   updated to match that of "git status":
+   updated to agree with the phrasing used by "git status":
 
-- When the HEAD is at the same commit as it was originally
+- When HEAD is at the same commit as when it was originally
   detached, they now both show "detached at ".
 
-- When the HEAD has moved since it was originally detached,
-  they now both show "detached from ".
+- When HEAD has moved since it was originally detached, they now
+  both show "detached from ".
 
-Earlier "git branch" always used "from"
+   Previously, "git branch" always used "from".
 
 
 Updates since v2.3
@@ -46,8 +46,9 @@ Ports
platforms with smaller SSIZE_MAX, leading to read(2)/write(2)
failures.
 
- * We did not check the curl library version before using
-   CURLOPT_PROXYAUTH feature that may not exist.
+ * We did not check the curl library version before using the
+   CURLOPT_PROXYAUTH feature, which did not exist in older versions of
+   the library.
 
  * We now detect number of CPUs on older BSD-derived systems.
 
@@ -66,99 +67,105 @@ UI, Workflows & Features
  * "git log --invert-grep --grep=WIP" will show only commits that do
not have the string "WIP" in their messages.
 
- * "git push" has been taught a "--atomic" option that makes push to
-   update more than one ref an "all-or-none" affair.
+ * "git push" has been taught an "--atomic" option that makes a push
+   that updates more than one ref an "all-or-none" affair.
 
- * Extending the "push to deploy" added in 2.3, the behaviour of "git
-   push" when updating the branch that is checked out can now be
-   tweaked by push-to-checkout hook.
+ * Extending the "push to deploy" feature that was added in 2.3, the
+   behaviour of "git push" when updating the branch that is checked
+   out can now be tweaked by a "push-to-checkout" hook.
 
- * Using environment variable LANGUAGE and friends on the client side,
-   HTTP-based transports now send Accept-Language when making requests.
+ * HTTP-based transports now send Accept-Language when making
+   requests. The languages to accept are inferred from environment
+   variables on the client side (LANGUAGE, etc).
 
  * "git send-email" used to accept a mistaken "y" (or "yes") as an
-   answer to "What encoding do you want to use [UTF-8]? " without
-   questioning.  Now it asks for confirmation when the answer looks
-   too short to be a valid encoding name.
+   answer to "What encoding do you want to use [UTF-8]?" without
+   questioning. Now it asks for confirmation when the answer looks too
+   short to be a valid encoding name.
 
  * When "git apply --whitespace=fix" fixed whitespace errors in the
common context lines, the command reports that it did so.
 
- * "git status" now allows the "-v" to be given twice to show the
-   differences that are left in the working tree not to be committed.
+ * "git status" now allows the "-v" option to be given twice, in which
+   case it also shows the differences in the working tree that are not
+   staged to be committed.
 
- * "git cherry-pick" used to clean-up the log message even when it is
-   merely replaying an existing commit.  It now replays the mess

Re: [PATCH 5/5] RelNotes: wordsmithing

2015-04-23 Thread Michael Haggerty
On 04/23/2015 02:27 PM, Michael Haggerty wrote:
> Make many textual tweaks to the 2.4.0 release notes.
> 
> Signed-off-by: Michael Haggerty 
> ---
>  Documentation/RelNotes/2.4.0.txt | 336 
> ---
>  1 file changed, 172 insertions(+), 164 deletions(-)
> 
> diff --git a/Documentation/RelNotes/2.4.0.txt 
> b/Documentation/RelNotes/2.4.0.txt
> index 7b23ca3..cde64be 100644
> --- a/Documentation/RelNotes/2.4.0.txt
> +++ b/Documentation/RelNotes/2.4.0.txt
> [...]

Oh, I just noticed that many of the same blurbs appear in the release
notes for the maintenance versions. Once there is agreement on how many
of the changes to accept, the analogous changes should probably be made
in those other files.

Michael

-- 
Michael Haggerty
mhag...@alum.mit.edu

--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


Re: [PATCH 5/5] RelNotes: wordsmithing

2015-04-23 Thread Junio C Hamano
Michael Haggerty  writes:

> On 04/23/2015 02:27 PM, Michael Haggerty wrote:
>> Make many textual tweaks to the 2.4.0 release notes.
>> 
>> Signed-off-by: Michael Haggerty 
>> ---
>>  Documentation/RelNotes/2.4.0.txt | 336 
>> ---
>>  1 file changed, 172 insertions(+), 164 deletions(-)
>> 
>> diff --git a/Documentation/RelNotes/2.4.0.txt 
>> b/Documentation/RelNotes/2.4.0.txt
>> index 7b23ca3..cde64be 100644
>> --- a/Documentation/RelNotes/2.4.0.txt
>> +++ b/Documentation/RelNotes/2.4.0.txt
>> [...]
>
> Oh, I just noticed that many of the same blurbs appear in the release
> notes for the maintenance versions. Once there is agreement on how many
> of the changes to accept, the analogous changes should probably be made
> in those other files.

Thanks.

FYI, these days the same text appears in

 (1) the topic description in "What's cooking";
 (2) the merge commit for the topic when it is merged to 'next';
 (3) the merge commit for the topic when it is merged to 'master';
 (4) Release notes for the 'master' and 'maint', when it is merged.

So the best time to catch mistakes and to rephrase it is when you
see something questionable in "What's cooking", ideally before it
hits 'next', before it hits 'master'.
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html