[PATCH 0/2] s390: Kconfig: Style cleanups

[PATCH 0/2] s390: Kconfig: Style cleanups

[Juerg Haefliger]

The majority of the Kconfig files use a single tab for basic indentation
and a single tab followed by two whitespaces for help text indentation.
Fix the lines that don't follow this convention.

While at it:
  - Add trailing comments to endif/endmenu statements for better
    readability.

Juerg Haefliger (2):
  s390: Kconfig: Fix indentation and add comments
  s390: Kconfig.debug: Fix indentation

 arch/s390/Kconfig       | 20 ++++++++++----------
 arch/s390/Kconfig.debug | 12 ++++++------
 2 files changed, 16 insertions(+), 16 deletions(-)

-- 
2.32.0

[PATCH 1/2] s390: Kconfig: Fix indentation and add comments

[Juerg Haefliger]

The convention for indentation seems to be a single tab. Help text is
further indented by an additional two whitespaces. Fix the lines that
violate these rules.

While add it, add trailing comments to endmenu statements for better
readability.

Signed-off-by: Juerg Haefliger <juergh@canonical.com>
---
 arch/s390/Kconfig | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/arch/s390/Kconfig b/arch/s390/Kconfig
index e084c72104f8..ae871569dcd6 100644
--- a/arch/s390/Kconfig
+++ b/arch/s390/Kconfig
@@ -607,7 +607,7 @@ config RANDOMIZE_BASE
 	  as a security feature that deters exploit attempts relying on
 	  knowledge of the location of kernel internals.
 
-endmenu
+endmenu # "Processor type and features"
 
 menu "Memory setup"
 
@@ -655,7 +655,7 @@ config STACK_GUARD
 	  The minimum size for the stack guard should be 256 for 31 bit and
 	  512 for 64 bit.
 
-endmenu
+endmenu # "Memory setup"
 
 menu "I/O subsystem"
 
@@ -736,13 +736,13 @@ config VFIO_AP
 	depends on S390_AP_IOMMU && VFIO_MDEV && KVM
 	depends on ZCRYPT
 	help
-		This driver grants access to Adjunct Processor (AP) devices
-		via the VFIO mediated device interface.
+	  This driver grants access to Adjunct Processor (AP) devices
+	  via the VFIO mediated device interface.
 
-		To compile this driver as a module, choose M here: the module
-		will be called vfio_ap.
+	  To compile this driver as a module, choose M here: the module
+	  will be called vfio_ap.
 
-endmenu
+endmenu # "I/O subsystem"
 
 menu "Dump support"
 
@@ -758,7 +758,7 @@ config CRASH_DUMP
 	  This option also enables s390 zfcpdump.
 	  See also <file:Documentation/s390/zfcpdump.rst>
 
-endmenu
+endmenu # "Dump support"
 
 config CCW
 	def_bool y
@@ -902,7 +902,7 @@ config S390_GUEST
 	  Select this option if you want to run the kernel as a guest under
 	  the KVM hypervisor.
 
-endmenu
+endmenu # "Virtualization"
 
 config S390_MODULES_SANITY_TEST_HELPERS
 	def_bool n
@@ -945,4 +945,4 @@ config S390_MODULES_SANITY_TEST
 	  kernel developers working on architecture code.
 
 	  Say N if you are unsure.
-endmenu
+endmenu # "Selftests"
-- 
2.32.0

Re: [PATCH 1/2] s390: Kconfig: Fix indentation and add comments

[Joe Perches]

On Fri, 2022-05-20 at 13:57 +0200, Juerg Haefliger wrote:
> The convention for indentation seems to be a single tab. Help text is
> further indented by an additional two whitespaces. Fix the lines that
> violate these rules.
> 
> While add it, add trailing comments to endmenu statements for better
> readability.
[]
> diff --git a/arch/s390/Kconfig b/arch/s390/Kconfig
[]
> @@ -607,7 +607,7 @@ config RANDOMIZE_BASE
>  	  as a security feature that deters exploit attempts relying on
>  	  knowledge of the location of kernel internals.
>  
> -endmenu
> +endmenu # "Processor type and features"

An endmenu comment is relatively unusual.

$ git grep '^endmenu' -- '*/Kconfig*' | wc -l
394
$ git grep '^endmenu.*#' -- '*/Kconfig*' | wc -l
20

I believe it doesn't really help readability.

Re: [PATCH 1/2] s390: Kconfig: Fix indentation and add comments

[Juerg Haefliger]

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

On Fri, 20 May 2022 10:15:38 -0700
Joe Perches <joe@perches.com> wrote:

> On Fri, 2022-05-20 at 13:57 +0200, Juerg Haefliger wrote:
> > The convention for indentation seems to be a single tab. Help text is
> > further indented by an additional two whitespaces. Fix the lines that
> > violate these rules.
> > 
> > While add it, add trailing comments to endmenu statements for better
> > readability.  
> []
> > diff --git a/arch/s390/Kconfig b/arch/s390/Kconfig  
> []
> > @@ -607,7 +607,7 @@ config RANDOMIZE_BASE
> >  	  as a security feature that deters exploit attempts relying on
> >  	  knowledge of the location of kernel internals.
> >  
> > -endmenu
> > +endmenu # "Processor type and features"  
> 
> An endmenu comment is relatively unusual.
> 
> $ git grep '^endmenu' -- '*/Kconfig*' | wc -l
> 394
> $ git grep '^endmenu.*#' -- '*/Kconfig*' | wc -l
> 20
> 
> I believe it doesn't really help readability.

Thanks for the review. Will send a v2 without that.

...Juerg

> 


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

[PATCH 1/2 v2] s390: Kconfig: Fix indentation

[Juerg Haefliger]

The convention for indentation seems to be a single tab. Help text is
further indented by an additional two whitespaces. Fix the lines that
violate these rules.

Signed-off-by: Juerg Haefliger <juergh@canonical.com>
---
v2:
  Drop trailing endmenu comments.

---
 arch/s390/Kconfig | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/arch/s390/Kconfig b/arch/s390/Kconfig
index e084c72104f8..543e859905df 100644
--- a/arch/s390/Kconfig
+++ b/arch/s390/Kconfig
@@ -736,11 +736,11 @@ config VFIO_AP
 	depends on S390_AP_IOMMU && VFIO_MDEV && KVM
 	depends on ZCRYPT
 	help
-		This driver grants access to Adjunct Processor (AP) devices
-		via the VFIO mediated device interface.
+	  This driver grants access to Adjunct Processor (AP) devices
+	  via the VFIO mediated device interface.
 
-		To compile this driver as a module, choose M here: the module
-		will be called vfio_ap.
+	  To compile this driver as a module, choose M here: the module
+	  will be called vfio_ap.
 
 endmenu
 
-- 
2.32.0

[PATCH 2/2] s390: Kconfig.debug: Fix indentation

[Juerg Haefliger]

The convention for indentation seems to be a single tab. Help text is
further indented by an additional two whitespaces. Fix the lines that
violate these rules.

Signed-off-by: Juerg Haefliger <juergh@canonical.com>
---
 arch/s390/Kconfig.debug | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/arch/s390/Kconfig.debug b/arch/s390/Kconfig.debug
index e94a2a7f6bf4..c4300ea4abf8 100644
--- a/arch/s390/Kconfig.debug
+++ b/arch/s390/Kconfig.debug
@@ -14,9 +14,9 @@ config DEBUG_ENTRY
 	  If unsure, say N.
 
 config CIO_INJECT
-       bool "CIO Inject interfaces"
-       depends on DEBUG_KERNEL && DEBUG_FS
-       help
-	This option provides a debugging facility to inject certain artificial events
-	and instruction responses to the CIO layer of Linux kernel. The newly created
-	debugfs user-interfaces will be at /sys/kernel/debug/s390/cio/*
+	bool "CIO Inject interfaces"
+	depends on DEBUG_KERNEL && DEBUG_FS
+	help
+	  This option provides a debugging facility to inject certain artificial events
+	  and instruction responses to the CIO layer of Linux kernel. The newly created
+	  debugfs user-interfaces will be at /sys/kernel/debug/s390/cio/*
-- 
2.32.0

Re: [PATCH 0/2] s390: Kconfig: Style cleanups

[Heiko Carstens]

On Fri, May 20, 2022 at 01:57:06PM +0200, Juerg Haefliger wrote:
> The majority of the Kconfig files use a single tab for basic indentation
> and a single tab followed by two whitespaces for help text indentation.
> Fix the lines that don't follow this convention.
> 
> While at it:
>   - Add trailing comments to endif/endmenu statements for better
>     readability.
> 
> Juerg Haefliger (2):
>   s390: Kconfig: Fix indentation and add comments
>   s390: Kconfig.debug: Fix indentation
> 
>  arch/s390/Kconfig       | 20 ++++++++++----------
>  arch/s390/Kconfig.debug | 12 ++++++------
>  2 files changed, 16 insertions(+), 16 deletions(-)

Both applied (v2 for the first patch). Thanks!

Re: [PATCH 0/2] s390: Kconfig: Style cleanups

[Heiko Carstens]

On Mon, May 23, 2022 at 11:39:31AM +0200, Heiko Carstens wrote:
> On Fri, May 20, 2022 at 01:57:06PM +0200, Juerg Haefliger wrote:
> > The majority of the Kconfig files use a single tab for basic indentation
> > and a single tab followed by two whitespaces for help text indentation.
> > Fix the lines that don't follow this convention.
> > 
> > While at it:
> >   - Add trailing comments to endif/endmenu statements for better
> >     readability.
> > 
> > Juerg Haefliger (2):
> >   s390: Kconfig: Fix indentation and add comments
> >   s390: Kconfig.debug: Fix indentation
> > 
> >  arch/s390/Kconfig       | 20 ++++++++++----------
> >  arch/s390/Kconfig.debug | 12 ++++++------
> >  2 files changed, 16 insertions(+), 16 deletions(-)
> 
> Both applied (v2 for the first patch). Thanks!

..and removed both patches again. Please make sure that your email
addresses match. That is: the email address you use for signing off
and the one you use for sending. Right now there is a mismatch when I
apply your patches in "From:" and "Signed-off-by:".

Please resend.

[PATCH 1/2 v3] s390: Kconfig: Fix indentation

[Juerg Haefliger]

The convention for indentation seems to be a single tab. Help text is
further indented by an additional two whitespaces. Fix the lines that
violate these rules.

Signed-off-by: Juerg Haefliger <juerg.haefliger@canonical.com>
---
v3:
 Change author and sob email addresses to match sender email address.
v2:
  Drop trailing endmenu comments.

---
 arch/s390/Kconfig | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/arch/s390/Kconfig b/arch/s390/Kconfig
index e084c72104f8..543e859905df 100644
--- a/arch/s390/Kconfig
+++ b/arch/s390/Kconfig
@@ -736,11 +736,11 @@ config VFIO_AP
 	depends on S390_AP_IOMMU && VFIO_MDEV && KVM
 	depends on ZCRYPT
 	help
-		This driver grants access to Adjunct Processor (AP) devices
-		via the VFIO mediated device interface.
+	  This driver grants access to Adjunct Processor (AP) devices
+	  via the VFIO mediated device interface.
 
-		To compile this driver as a module, choose M here: the module
-		will be called vfio_ap.
+	  To compile this driver as a module, choose M here: the module
+	  will be called vfio_ap.
 
 endmenu
 
-- 
2.32.0

[PATCH 2/2 v2] s390: Kconfig.debug: Fix indentation

[Juerg Haefliger]

The convention for indentation seems to be a single tab. Help text is
further indented by an additional two whitespaces. Fix the lines that
violate these rules.

Signed-off-by: Juerg Haefliger <juerg.haefliger@canonical.com>
---
v2:
 Change author and sob email addresses to match sender email address.

---
 arch/s390/Kconfig.debug | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/arch/s390/Kconfig.debug b/arch/s390/Kconfig.debug
index e94a2a7f6bf4..c4300ea4abf8 100644
--- a/arch/s390/Kconfig.debug
+++ b/arch/s390/Kconfig.debug
@@ -14,9 +14,9 @@ config DEBUG_ENTRY
 	  If unsure, say N.
 
 config CIO_INJECT
-       bool "CIO Inject interfaces"
-       depends on DEBUG_KERNEL && DEBUG_FS
-       help
-	This option provides a debugging facility to inject certain artificial events
-	and instruction responses to the CIO layer of Linux kernel. The newly created
-	debugfs user-interfaces will be at /sys/kernel/debug/s390/cio/*
+	bool "CIO Inject interfaces"
+	depends on DEBUG_KERNEL && DEBUG_FS
+	help
+	  This option provides a debugging facility to inject certain artificial events
+	  and instruction responses to the CIO layer of Linux kernel. The newly created
+	  debugfs user-interfaces will be at /sys/kernel/debug/s390/cio/*
-- 
2.32.0