[PATCH] base: power: runtime.c: Remove a unnecessary space

[PATCH] base: power: runtime.c: Remove a unnecessary space

[Sebastian Fricke]

Remove a redundant space to improve the quality of the comment.

Signed-off-by: Sebastian Fricke <sebastian.fricke@posteo.net>
---
Side-note:
I found this while reading the code, I don't believe it is important but
I thought it doesn't hurt to fix it.
---
 drivers/base/power/runtime.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/base/power/runtime.c b/drivers/base/power/runtime.c
index 18b82427d0cb..499434b84171 100644
--- a/drivers/base/power/runtime.c
+++ b/drivers/base/power/runtime.c
@@ -786,7 +786,7 @@ static int rpm_resume(struct device *dev, int rpmflags)
 	}
 
 	/*
-	 * See if we can skip waking up the parent.  This is safe only if
+	 * See if we can skip waking up the parent. This is safe only if
 	 * power.no_callbacks is set, because otherwise we don't know whether
 	 * the resume will actually succeed.
 	 */
-- 
2.25.1

Re: [PATCH] base: power: runtime.c: Remove a unnecessary space

[Joe Perches]

On Sun, 2021-04-18 at 06:08 +0000, Sebastian Fricke wrote:
> Remove a redundant space to improve the quality of the comment.

I think this patch is not useful.

It's not redundant.

Two spaces after a period is commonly used to separate sentences.
It's especially common when used with fixed pitch fonts.

A trivial grep seems to show it's used about 50K times in comments.
Though single space after period may be used about twice as often.

$ git grep '^\s*\*.*\.  [A-Z]' | wc -l
54439
$ git grep '^\s*\*.*\. [A-Z]' | wc -l
110003

For drivers/base/power/runtime.c, that 2 space after period style is used 
dozens of times and changing a single instance of it isn't very useful.

> ---
> Side-note:
> I found this while reading the code, I don't believe it is important but
> I thought it doesn't hurt to fix it.
> ---
>  drivers/base/power/runtime.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/base/power/runtime.c b/drivers/base/power/runtime.c
> index 18b82427d0cb..499434b84171 100644
> --- a/drivers/base/power/runtime.c
> +++ b/drivers/base/power/runtime.c
> @@ -786,7 +786,7 @@ static int rpm_resume(struct device *dev, int rpmflags)
>  	}
>  
> 
>  	/*
> -	 * See if we can skip waking up the parent.  This is safe only if
> +	 * See if we can skip waking up the parent. This is safe only if
>  	 * power.no_callbacks is set, because otherwise we don't know whether
>  	 * the resume will actually succeed.
>  	 */

Re: [PATCH] base: power: runtime.c: Remove a unnecessary space

[Sebastian Fricke]

Hey Joe,

On 18.04.2021 00:09, Joe Perches wrote:
>On Sun, 2021-04-18 at 06:08 +0000, Sebastian Fricke wrote:
>> Remove a redundant space to improve the quality of the comment.
>
>I think this patch is not useful.
>
>It's not redundant.

Thank you, I actually found this pattern a few more times but I wanted
to check first if this is a mistake or chosen consciously.

Sorry for the noise.

>
>Two spaces after a period is commonly used to separate sentences.
>It's especially common when used with fixed pitch fonts.
>
>A trivial grep seems to show it's used about 50K times in comments.
>Though single space after period may be used about twice as often.
>
>$ git grep '^\s*\*.*\.  [A-Z]' | wc -l
>54439
>$ git grep '^\s*\*.*\. [A-Z]' | wc -l
>110003
>
>For drivers/base/power/runtime.c, that 2 space after period style is used
>dozens of times and changing a single instance of it isn't very useful.

True and if I understand you correctly you would rather keep it as is
right?

Greetings,
Sebastian

>
>> ---
>> Side-note:
>> I found this while reading the code, I don't believe it is important but
>> I thought it doesn't hurt to fix it.
>> ---
>>  drivers/base/power/runtime.c | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/drivers/base/power/runtime.c b/drivers/base/power/runtime.c
>> index 18b82427d0cb..499434b84171 100644
>> --- a/drivers/base/power/runtime.c
>> +++ b/drivers/base/power/runtime.c
>> @@ -786,7 +786,7 @@ static int rpm_resume(struct device *dev, int rpmflags)
>>  	}
>>  
>>
>>  	/*
>> -	 * See if we can skip waking up the parent.  This is safe only if
>> +	 * See if we can skip waking up the parent. This is safe only if
>>  	 * power.no_callbacks is set, because otherwise we don't know whether
>>  	 * the resume will actually succeed.
>>  	 */
>
>

Re: [PATCH] base: power: runtime.c: Remove a unnecessary space

[Pavel Machek]

[-- Attachment #1: Type: text/plain, Size: 617 bytes --]

On Sun 2021-04-18 09:11:43, Sebastian Fricke wrote:
> Hey Joe,
> 
> On 18.04.2021 00:09, Joe Perches wrote:
> >On Sun, 2021-04-18 at 06:08 +0000, Sebastian Fricke wrote:
> >>Remove a redundant space to improve the quality of the comment.
> >
> >I think this patch is not useful.
> >
> >It's not redundant.
> 
> Thank you, I actually found this pattern a few more times but I wanted
> to check first if this is a mistake or chosen consciously.

It is okay as it is. No need to remove extra space. No need to add it,
either.

Best regards,
								Pavel
-- 
http://www.livejournal.com/~pavelmachek

[-- Attachment #2: Digital signature --]
[-- Type: application/pgp-signature, Size: 181 bytes --]

Re: [PATCH] base: power: runtime.c: Remove a unnecessary space

[Joe Perches]

On Sun, 2021-04-18 at 09:11 +0000, Sebastian Fricke wrote:
> Hey Joe,

Hi Sebastian.

> On 18.04.2021 00:09, Joe Perches wrote:
> > On Sun, 2021-04-18 at 06:08 +0000, Sebastian Fricke wrote:
> > > Remove a redundant space to improve the quality of the comment.
> > I think this patch is not useful.
> > It's not redundant.
> 
> Thank you, I actually found this pattern a few more times but I wanted
> to check first if this is a mistake or chosen consciously.
[]
> > For drivers/base/power/runtime.c, that 2 space after period style is used
> > dozens of times and changing a single instance of it isn't very useful.

Even in that single file it's not consistent.
It's something like 3:1 for 2 spaces over 1 space after period.

I believe it's done more by habit and author age than anything.
If you learned to type using a typewriter and not a keyboard, then
you likely still use 2 spaces after a period.

> True and if I understand you correctly you would rather keep it as is
> right?

Yes.  IMO: Whitespace in comments like this should not be changed
unless there's some other significant benefit like better alignment.

cheers, Joe

> > > ---
> > > Side-note:
> > > I found this while reading the code, I don't believe it is important but
> > > I thought it doesn't hurt to fix it.
[]
> > > diff --git a/drivers/base/power/runtime.c b/drivers/base/power/runtime.c
[]
> > > @@ -786,7 +786,7 @@ static int rpm_resume(struct device *dev, int rpmflags)
> > >  	}
> > > 
> > >  	/*
> > > -	 * See if we can skip waking up the parent.  This is safe only if
> > > +	 * See if we can skip waking up the parent. This is safe only if
> > >  	 * power.no_callbacks is set, because otherwise we don't know whether
> > >  	 * the resume will actually succeed.
> > >  	 */

Re: [PATCH] base: power: runtime.c: Remove a unnecessary space

[Rafael J. Wysocki]

On Sun, Apr 18, 2021 at 11:22 AM Joe Perches <joe@perches.com> wrote:
>
> On Sun, 2021-04-18 at 09:11 +0000, Sebastian Fricke wrote:
> > Hey Joe,
>
> Hi Sebastian.
>
> > On 18.04.2021 00:09, Joe Perches wrote:
> > > On Sun, 2021-04-18 at 06:08 +0000, Sebastian Fricke wrote:
> > > > Remove a redundant space to improve the quality of the comment.
> > > I think this patch is not useful.
> > > It's not redundant.
> >
> > Thank you, I actually found this pattern a few more times but I wanted
> > to check first if this is a mistake or chosen consciously.

I write a double space after a period ending a sentence as a rule and
it is not a mistake.

> []
> > > For drivers/base/power/runtime.c, that 2 space after period style is used
> > > dozens of times and changing a single instance of it isn't very useful.
>
> Even in that single file it's not consistent.
> It's something like 3:1 for 2 spaces over 1 space after period.
>
> I believe it's done more by habit and author age than anything.
> If you learned to type using a typewriter and not a keyboard, then
> you likely still use 2 spaces after a period.

By habit and because I prefer it this way (I find it somewhat easier
to separate sentences from one another this way).

> > True and if I understand you correctly you would rather keep it as is
> > right?
>
> Yes.  IMO: Whitespace in comments like this should not be changed
> unless there's some other significant benefit like better alignment.

Agreed.