Skip to contentSkip to conversation

iio: adc: stm32-adc: Fix docs wrongly marked as kernel-doc

PATCH In review Jonathan Cameron 3 participants 4 messages Apr 28, 2021 – May 3, 2021

Subsystems (2)
lore
Share & tools
lore

Jonathan Cameron

author maintainer
#0 lore raw

PATCH 1/1 iio: adc: stm32-adc: Fix docs wrongly marked as kernel-doc

From: Jonathan Cameron <[email protected]>

W=1 highlights these two cases that are obviously not in kernel-doc format.

---
 drivers/iio/adc/stm32-adc.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/iio/adc/stm32-adc.c +2 -2
index 922af2d75c1e..5088de835bb1 100644
@@ -449,7 +449,7 @@ static const struct stm32_adc_regspec stm32h7_adc_regspec = {
 	.smp_bits = stm32h7_smp_bits,
 };
 
-/**
+/*
  * STM32 ADC registers access routines
  * @adc: stm32 adc instance
  * @reg: reg offset in adc instance
@@ -851,7 +851,7 @@ static int stm32h7_adc_restore_selfcalib(struct iio_dev *indio_dev)
 	return 0;
 }
 
-/**
+/*
  * Fixed timeout value for ADC calibration.
  * worst cases:
  * - low clock frequency
Signature · 1 line
2.31.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 7 lines · Jonathan Cameron

From: Jonathan Cameron <[email protected]>

W=1 highlights these two cases that are obviously not in kernel-doc format.

Hi Jonathan,

I've been a bit surprised but I finally found out the checks have evolved [1].
[1] https://lore.kernel.org/linux-next/[email protected]/T/

It seems it's exposed by commit:
52042e2db452 ("scripts: kernel-doc: validate kernel-doc markup with the actual names")

You can add my:

Thanks,
Fabrice

Quoted 27 lines
---
 drivers/iio/adc/stm32-adc.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/iio/adc/stm32-adc.c +2 -2
index 922af2d75c1e..5088de835bb1 100644
@@ -449,7 +449,7 @@ static const struct stm32_adc_regspec stm32h7_adc_regspec = {
 	.smp_bits = stm32h7_smp_bits,
 };
 
-/**
+/*
  * STM32 ADC registers access routines
  * @adc: stm32 adc instance
  * @reg: reg offset in adc instance
@@ -851,7 +851,7 @@ static int stm32h7_adc_restore_selfcalib(struct iio_dev *indio_dev)
 	return 0;
 }
 
-/**
+/*
  * Fixed timeout value for ADC calibration.
  * worst cases:
  * - low clock frequency
#2 lore raw
Quoted 11 lines · On Thu, 29 Apr 2021 10:16:00 +0200 Fabrice Gasnier…
Quoted 7 lines · Jonathan Cameron

From: Jonathan Cameron <[email protected]>

W=1 highlights these two cases that are obviously not in kernel-doc format.

Hi Jonathan,

Quoted 7 lines

I've been a bit surprised but I finally found out the checks have evolved [1].
[1] https://lore.kernel.org/linux-next/[email protected]/T/

It seems it's exposed by commit:
52042e2db452 ("scripts: kernel-doc: validate kernel-doc markup with the actual names")

Good detective work. I wondered why this one hadn't appeared before yesterday but was too lazy to check :)

Quoted 3 lines

You can add my:

Thanks,

Jonathan

Quoted 31 lines

Thanks,
Fabrice

Quoted 27 lines
---
 drivers/iio/adc/stm32-adc.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/iio/adc/stm32-adc.c +2 -2
index 922af2d75c1e..5088de835bb1 100644
@@ -449,7 +449,7 @@ static const struct stm32_adc_regspec stm32h7_adc_regspec = {
 	.smp_bits = stm32h7_smp_bits,
 };
 
-/**
+/*
  * STM32 ADC registers access routines
  * @adc: stm32 adc instance
  * @reg: reg offset in adc instance
@@ -851,7 +851,7 @@ static int stm32h7_adc_restore_selfcalib(struct iio_dev *indio_dev)
 	return 0;
 }
 
-/**
+/*
  * Fixed timeout value for ADC calibration.
  * worst cases:
  * - low clock frequency
author maintainer
#3 lore raw
Quoted 18 lines · On Thu, 29 Apr 2021 10:22:53 +0100 Jonathan Cameron…
Quoted 15 lines · On Thu, 29 Apr 2021 10:16:00 +0200 Fabrice Gasnier…
Quoted 7 lines · Jonathan Cameron

From: Jonathan Cameron <[email protected]>

W=1 highlights these two cases that are obviously not in kernel-doc format.

Hi Jonathan,

I've been a bit surprised but I finally found out the checks have evolved [1].
[1] https://lore.kernel.org/linux-next/[email protected]/T/

Quoted 10 lines
Quoted 3 lines

It seems it's exposed by commit:
52042e2db452 ("scripts: kernel-doc: validate kernel-doc markup with the actual names")

Good detective work. I wondered why this one hadn't appeared before yesterday but was too lazy to check :)

Quoted 3 lines

You can add my:

Applied to the togreg branch of iio.git and pushed out as testing for the autobuilders to see if we missed anything.

Thanks,

Jonathan

Quoted 37 lines

Thanks,

Jonathan

Quoted 31 lines

Thanks,
Fabrice

Quoted 27 lines
---
 drivers/iio/adc/stm32-adc.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/iio/adc/stm32-adc.c +2 -2
index 922af2d75c1e..5088de835bb1 100644
@@ -449,7 +449,7 @@ static const struct stm32_adc_regspec stm32h7_adc_regspec = {
 	.smp_bits = stm32h7_smp_bits,
 };
 
-/**
+/*
  * STM32 ADC registers access routines
  * @adc: stm32 adc instance
  * @reg: reg offset in adc instance
@@ -851,7 +851,7 @@ static int stm32h7_adc_restore_selfcalib(struct iio_dev *indio_dev)
 	return 0;
 }
 
-/**
+/*
  * Fixed timeout value for ADC calibration.
  * worst cases:
  * - low clock frequency