threads / patch / 31555

patch, 8 partsDoc: Improve shallow depth wording

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

## tl;dr

6 messages between Sep 16, 2012 and Sep 18, 2012. Diffs are folded; open one to read it.

replies: 5people: 2as markdown or json

Philip Oakley· Sep 16, 2012, 10:57 UTC · lore

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>
Show changes to Documentation/technical/pack-protocol.txt +5 −3
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· Sep 17, 2012, 05:46 UTC · re: Philip Oakley · lore

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

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
Philip Oakley· Sep 17, 2012, 21:56 UTC · re: Junio C Hamano · lore

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

From: "Junio C Hamano" <gitster@pobox.com>
Show 9 quoted lines
> 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· Sep 18, 2012, 20:36 UTC · re: Junio C Hamano · lore

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

Junio C Hamano <gitster@pobox.com> writes:
Show 9 quoted lines
> 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· Sep 18, 2012, 21:30 UTC · re: Junio C Hamano · lore

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

From: "Junio C Hamano" <gitster@pobox.com>
Show 16 quoted lines
> 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· Sep 18, 2012, 21:54 UTC · re: Philip Oakley · lore

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

"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 ;-)

← back to recent threads