Re: [PATCH 3/8] Doc: Improve shallow depth wording

From: Junio C Hamano <gitster@pobox.com>
Date: Sep 17, 2012, 05:46 UTC
Message-ID: <7vlig9w6a7.fsf@alter.siamese.dyndns.org>
In-Reply-To: <1347793083-4136-4-git-send-email-philipoakley@iee.org>

Philip Oakley <philipoakley@iee.org> writes:

> Avoid confusion in compound sentence about the start of the commit set
> and the depth measure. Use two sentences.

Dropping the first ',' after "positive depth" does not seem to make it any easier to read (I personally think it makes it a lot harder to read). Splitting the tail-end of the sentence into a separate sentence does make it easier to read, though.

Show 22 quoted lines

>
> Signed-off-by: Philip Oakley <philipoakley@iee.org>
>
> diff --git a/Documentation/technical/pack-protocol.txt b/Documentation/technical/pack-protocol.txt
> index 49cdc57..fa4acab 100644
> --- a/Documentation/technical/pack-protocol.txt
> +++ b/Documentation/technical/pack-protocol.txt
> @@ -258,9 +258,11 @@ a positive depth, this step is skipped.
>    unshallow-line   =  PKT-LINE("unshallow" SP obj-id)
>  ----
>  
> -If the client has requested a positive depth, the server will compute
> -the set of commits which are no deeper than the desired depth, starting
> -at the client's wants. The server writes 'shallow' lines for each
> +If the client has requested a positive depth the server will compute
> +the set of commits which are no deeper than the desired depth. The set
> +of commits start at the client's wants.
> +
> +The server writes 'shallow' lines for each
>  commit whose parents will not be sent as a result. The server writes
>  an 'unshallow' line for each commit which the client has indicated is
>  shallow, but is no longer shallow at the currently requested depth