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

6 messages from 2012-09-16 to 2012-09-18. Participants: Philip Oakley, Junio C Hamano.
Thread: https://gitlist.dev/t/31555

## Philip Oakley, 2012-09-16 10:57

Subject: [PATCH 3/8] Doc: Improve shallow depth wording
Message-ID: <1347793083-4136-4-git-send-email-philipoakley@iee.org>
URL: https://gitlist.dev/e/1347793083-4136-4-git-send-email-philipoakley%40iee.org

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

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
-- 
1.7.8.msysgit.0

```

## Junio C Hamano, 2012-09-17 05:46

Subject: Re: [PATCH 3/8] Doc: Improve shallow depth wording
Message-ID: <7vlig9w6a7.fsf@alter.siamese.dyndns.org>
URL: https://gitlist.dev/e/7vlig9w6a7.fsf%40alter.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.

>
> 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

```

## Philip Oakley, 2012-09-17 21:56

Subject: Re: [PATCH 3/8] Doc: Improve shallow depth wording
Message-ID: <F4AAD7C9987D4985AAB6D3F5810ED6C3@PhilipOakley>
URL: https://gitlist.dev/e/F4AAD7C9987D4985AAB6D3F5810ED6C3%40PhilipOakley
In-Reply-To: <7vlig9w6a7.fsf@alter.siamese.dyndns.org>

```
From: "Junio C Hamano" <gitster@pobox.com>
> 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).

Accepted. My mistake - will correct.

>             Splitting the tail-end of the sentence into a separate
> sentence does make it easier to read, though.
>

Philip 

```

## Junio C Hamano, 2012-09-18 20:36

Subject: Re: [PATCH 3/8] Doc: Improve shallow depth wording
Message-ID: <7vmx0nkr06.fsf@alter.siamese.dyndns.org>
URL: https://gitlist.dev/e/7vmx0nkr06.fsf%40alter.siamese.dyndns.org
In-Reply-To: <7vlig9w6a7.fsf@alter.siamese.dyndns.org>

```
Junio C Hamano <gitster@pobox.com> writes:

> 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.

Will add ',' locally and queue; no need to resend.

Thanks.

```

## Philip Oakley, 2012-09-18 21:30

Subject: Re: [PATCH 3/8] Doc: Improve shallow depth wording
Message-ID: <060D2B93282044BBB6189F04CB34E828@PhilipOakley>
URL: https://gitlist.dev/e/060D2B93282044BBB6189F04CB34E828%40PhilipOakley
In-Reply-To: <7vmx0nkr06.fsf@alter.siamese.dyndns.org>

```
From: "Junio C Hamano" <gitster@pobox.com>
> Junio C Hamano <gitster@pobox.com> writes:
>
>> 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.
>
> Will add ',' locally and queue; no need to resend.
>
> Thanks.

And the simple corrections to patches 5/6/7 ? Shall I send?
Philip 

```

## Junio C Hamano, 2012-09-18 21:54

Subject: Re: [PATCH 3/8] Doc: Improve shallow depth wording
Message-ID: <7vwqzrj8tp.fsf@alter.siamese.dyndns.org>
URL: https://gitlist.dev/e/7vwqzrj8tp.fsf%40alter.siamese.dyndns.org
In-Reply-To: <060D2B93282044BBB6189F04CB34E828@PhilipOakley>

```
"Philip Oakley" <philipoakley@iee.org> writes:

> And the simple corrections to patches 5/6/7 ? Shall I send?

Juggling topics from many people, it is hard to keep track of how
many out of how many patches in the original series are still
relevant, so I would appreciate [PATCH vn N/M] with revamped values
for n, N and M as appropriate ;-)

```
