Re: [PATCH 1/8] Doc/gitsubmodules: split a sentence for better readability

[Stefan Beller]

On Sat, Jan 6, 2018 at 4:29 PM, Eric Sunshine  wrote:
> On Sat, Jan 6, 2018 at 1:46 PM, Kaartic Sivaraam
>  wrote:
>> Signed-off-by: Kaartic Sivaraam 
>> ---
>> diff --git a/Documentation/gitsubmodules.txt 
>> b/Documentation/gitsubmodules.txt
>> @@ -36,8 +36,8 @@ The `gitlink` entry contains the object name of the commit 
>> that the
>>  The section `submodule.foo.*` in the `.gitmodules` file gives additional
>> -hints to Gits porcelain layer such as where to obtain the submodule via
>> -the `submodule.foo.url` setting.
>> +hints to Gits porcelain layer. For example, the `submodule.foo.url`
>> +setting specifies where to obtain the submodule.
>
> I don't find the original difficult to read (aside, perhaps, from the
> missing comma before "such as"), so I don't feel strongly about this
> change.

Seconded. I am neutral to this change, but as you were keen enough to
come up with the patch, I see no reason to reject it.
Anyway, let's read on!

Thanks,
Stefan

>
> However, since you're touching this, you could apply the s/Gits/Git's/ fix.

Re: [PATCH 1/8] Doc/gitsubmodules: split a sentence for better readability

[Eric Sunshine]

On Sat, Jan 6, 2018 at 1:46 PM, Kaartic Sivaraam
 wrote:
> Signed-off-by: Kaartic Sivaraam 
> ---
> diff --git a/Documentation/gitsubmodules.txt b/Documentation/gitsubmodules.txt
> @@ -36,8 +36,8 @@ The `gitlink` entry contains the object name of the commit 
> that the
>  The section `submodule.foo.*` in the `.gitmodules` file gives additional
> -hints to Gits porcelain layer such as where to obtain the submodule via
> -the `submodule.foo.url` setting.
> +hints to Gits porcelain layer. For example, the `submodule.foo.url`
> +setting specifies where to obtain the submodule.

I don't find the original difficult to read (aside, perhaps, from the
missing comma before "such as"), so I don't feel strongly about this
change.

However, since you're touching this, you could apply the s/Gits/Git's/ fix.

[PATCH 1/8] Doc/gitsubmodules: split a sentence for better readability

[Kaartic Sivaraam]

Signed-off-by: Kaartic Sivaraam 
---
 Documentation/gitsubmodules.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/gitsubmodules.txt b/Documentation/gitsubmodules.txt
index 46cf120f6..bf46b0fb5 100644
--- a/Documentation/gitsubmodules.txt
+++ b/Documentation/gitsubmodules.txt
@@ -36,8 +36,8 @@ The `gitlink` entry contains the object name of the commit 
that the
 superproject expects the submodule’s working directory to be at.
 
 The section `submodule.foo.*` in the `.gitmodules` file gives additional
-hints to Gits porcelain layer such as where to obtain the submodule via
-the `submodule.foo.url` setting.
+hints to Gits porcelain layer. For example, the `submodule.foo.url`
+setting specifies where to obtain the submodule.
 
 Submodules can be used for at least two different use cases:
 
-- 
2.16.0.rc0.223.g4a4ac8367