Re: [PATCH] RelNotes/2.0.0.txt: Fix several grammar issues, notably a lack of hyphens, double quotes, or articles

From: Junio C Hamano <gitster@pobox.com>
Date: May 19, 2014, 23:46 UTC
Message-ID: <xmqq1tvpuyas.fsf@gitster.dls.corp.google.com>
In-Reply-To: <1400297434-30254-1-git-send-email-jstjohn@purdue.edu>

"Jason St. John" <jstjohn@purdue.edu> writes:

> Signed-off-by: Jason St. John <jstjohn@purdue.edu>
> ---

Please accept "Thanks" for all the hunks I won't comment below; they looked correct to me.

Show 6 quoted lines

> @@ -53,7 +53,7 @@ Updates since v1.9 series
>  UI, Workflows & Features
>  
>   * The "multi-mail" post-receive hook (in contrib/) has been updated
> -   to a more recent version from the upstream.
> +   to a more recent version from upstream.

Hmph, I have only one multi-mail upstream; shouldn't I call it "the" upstream from my point of view?

Show 6 quoted lines

> @@ -63,12 +63,13 @@ UI, Workflows & Features
>     single strand-of-pearls is broken in its output.
>  
>   * The "rev-parse --parseopt" mechanism used by scripted Porcelains to
> -   parse command line options and to give help text learned to take
> +   parse command-line options and to give help text learned to take

We seem to have 30 "command line option" in Documentation/ vs 16 "command-line option", but this is two words used as an adjective, and it may read better with the dash in between.

Thanks.

Show 8 quoted lines

> @@ -190,20 +191,20 @@ notes for details).
>  
>   * The remote-helper interface to fast-import/fast-export via the
>     transport-helper has been tightened to avoid leaving the import
> -   marks file from a failed/crashed run, as such a file that is out of
> -   sync with the reality confuses a later invocation of itself.
> +   marks file from a failed/crashed run, as such a file that is out-of-
> +   sync with reality confuses a later invocation of itself.

Likewise, but I somehow think this is borderline; the spelling without hyphen is used frequently enough.

Show 7 quoted lines

> @@ -217,7 +218,7 @@ notes for details).
>   * "git diff --no-index -Mq a b" fell into an infinite loop.
>     (merge ad1c3fb jc/fix-diff-no-index-diff-opt-parse later to maint).
>  
> - * "git fetch --prune", when the right-hand-side of multiple fetch
> + * "git fetch --prune", when the right-hand side of multiple fetch
>     refspecs overlap (e.g. storing "refs/heads/*" to

Hmph, I read this as a "right-hand", a multi-word adjective, is used to describe one "side" (the other side being the "left-hand side"). Otherwise, you would be writing command-line-option, no?

> - * Codepaths that parse timestamps in commit objects have been
> + * Code paths that parse timestamps in commit objects have been
>     tightened.
>     (merge f80d1f9 jk/commit-dates-parsing-fix later to maint).

We seem to spell this as one-word in the documentation too often, but "Code path" is the right form, I agree.