[PATCH] docs: Remove space-before-label guidance from CodingStyle

[PATCH] docs: Remove space-before-label guidance from CodingStyle

[Jonathan Corbet]

Recent discussion has made it clear that there is no community consensus
on this particular rule.  Remove it now, lest it inspire yet another set
of unwanted "cleanup" patches.

This partially reverts 865a1caa4b6b (CodingStyle: Clarify and complete
chapter 7).

Cc: Jean Delvare <jdelvare@suse.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
---
 Documentation/CodingStyle | 7 ++-----
 1 file changed, 2 insertions(+), 5 deletions(-)

diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
index 852253c932fe..9c61c039ccd9 100644
--- a/Documentation/CodingStyle
+++ b/Documentation/CodingStyle
@@ -451,9 +451,6 @@ Avoid using GW-BASIC names like ``err1:`` and
``err2:``, as you would have to renumber them if you ever add or remove
exit paths, and they make correctness difficult to verify anyway.
 
-It is advised to indent labels with a single space (not tab), so that
-``diff -p`` does not confuse labels with functions.
-
 The rationale for using gotos is:
 
 - unconditional statements are easier to understand and follow
@@ -481,7 +478,7 @@ The rationale for using gotos is:
 			goto out_buffer;
 		}
 		...
-	 out_free_buffer:
+	out_free_buffer:
 		kfree(buffer);
 		return result;
 	}
@@ -490,7 +487,7 @@ A common type of bug to be aware of is ``one err
bugs`` which look like this: 
 .. code-block:: c
 
-	 err:
+	err:
 		kfree(foo->bar);
 		kfree(foo);
 		return ret;
-- 
2.7.4

Re: [PATCH] docs: Remove space-before-label guidance from CodingStyle

[Joe Perches]

On Wed, 2016-09-21 at 15:54 -0600, Jonathan Corbet wrote:
> Recent discussion has made it clear that there is no community consensus
> on this particular rule.  Remove it now, lest it inspire yet another set
> of unwanted "cleanup" patches.

Thanks.  I believe it's better to remove this one too.

Re: [PATCH] docs: Remove space-before-label guidance from CodingStyle

[Jean Delvare]

Hi Jonathan,

On Wed, 21 Sep 2016 15:54:01 -0600, Jonathan Corbet wrote:
> Recent discussion has made it clear that there is no community consensus
> on this particular rule.  Remove it now, lest it inspire yet another set
> of unwanted "cleanup" patches.
> 
> This partially reverts 865a1caa4b6b (CodingStyle: Clarify and complete
> chapter 7).
> (...)
> @@ -481,7 +478,7 @@ The rationale for using gotos is:
>  			goto out_buffer;
>  		}
>  		...
> -	 out_free_buffer:
> +	out_free_buffer:
>  		kfree(buffer);
>  		return result;
>  	}
> @@ -490,7 +487,7 @@ A common type of bug to be aware of is ``one err
> bugs`` which look like this: 
>  .. code-block:: c
>  
> -	 err:
> +	err:
>  		kfree(foo->bar);
>  		kfree(foo);
>  		return ret;

There are 2 more occurrences after this point, which you probably want
to change too.

-- 
Jean Delvare
SUSE L3 Support