[PATCH] regulato: remove unnecessary indentation from driver.h's comments

[PATCH] regulato: remove unnecessary indentation from driver.h's comments

[Yanteng Si]

Fix doc build warning as:

linux-next/Documentation/driver-api/regulator:166: ./include/linux/regulator/driver.h:96: WARNING: Unexpected indentation.
linux-next/Documentation/driver-api/regulator:166: ./include/linux/regulator/driver.h:98: WARNING: Block quote ends without a blank line; unexpected unindent.

Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
---
 include/linux/regulator/driver.h | 13 ++++++-------
 1 file changed, 6 insertions(+), 7 deletions(-)

diff --git a/include/linux/regulator/driver.h b/include/linux/regulator/driver.h
index 66219b174a8a..f777e259facd 100644
--- a/include/linux/regulator/driver.h
+++ b/include/linux/regulator/driver.h
@@ -92,13 +92,12 @@ enum regulator_detection_severity {
  *	levels of severity.
  *	REGULATOR_SEVERITY_PROT should automatically shut down the regulator(s).
  *	REGULATOR_SEVERITY_ERR should indicate that over-current situation is
- *		caused by an unrecoverable error but HW does not perform
- *		automatic shut down.
- *	REGULATOR_SEVERITY_WARN should indicate situation where hardware is
- *		still believed to not be damaged but that a board sepcific
- *		recovery action is needed. If lim_uA is 0 the limit should not
- *		be changed but the detection should just be enabled/disabled as
- *		is requested.
+ *	caused by an unrecoverable error but HW does not perform automatic shut
+ *	down.
+ *	REGULATOR_SEVERITY_WARN should indicate situation where hardware is still
+ *	believed to not be damaged but that a board sepcific recovery action is needed.
+ *	If lim_uA is 0 the limit should not be changed but the detection should
+ *	just be enabled/disabled as is requested.
  * @set_over_voltage_protection: Support enabling of and setting limits for over
  *	voltage situation detection. Detection can be configured for same
  *	severities as over current protection. Units of uV.
-- 
2.27.0

Re: [PATCH] regulato: remove unnecessary indentation from driver.h's comments

[Mark Brown]

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

On Sun, Dec 05, 2021 at 09:15:03PM +0800, Yanteng Si wrote:

>   *	REGULATOR_SEVERITY_PROT should automatically shut down the regulator(s).
>   *	REGULATOR_SEVERITY_ERR should indicate that over-current situation is
> - *		caused by an unrecoverable error but HW does not perform
> - *		automatic shut down.
> - *	REGULATOR_SEVERITY_WARN should indicate situation where hardware is
> - *		still believed to not be damaged but that a board sepcific
> - *		recovery action is needed. If lim_uA is 0 the limit should not
> - *		be changed but the detection should just be enabled/disabled as
> - *		is requested.
> + *	caused by an unrecoverable error but HW does not perform automatic shut
> + *	down.
> + *	REGULATOR_SEVERITY_WARN should indicate situation where hardware is still

This is obviously making things worse - it's creating inconsistent
indentation within the list.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: [PATCH] regulato: remove unnecessary indentation from driver.h's comments

[yanteng si]

Mark Brown <broonie@kernel.org> 于2021年12月6日周一 21:24写道：
>
> On Sun, Dec 05, 2021 at 09:15:03PM +0800, Yanteng Si wrote:
>
> >   *   REGULATOR_SEVERITY_PROT should automatically shut down the regulator(s).
> >   *   REGULATOR_SEVERITY_ERR should indicate that over-current situation is
> > - *           caused by an unrecoverable error but HW does not perform
> > - *           automatic shut down.
> > - *   REGULATOR_SEVERITY_WARN should indicate situation where hardware is
> > - *           still believed to not be damaged but that a board sepcific
> > - *           recovery action is needed. If lim_uA is 0 the limit should not
> > - *           be changed but the detection should just be enabled/disabled as
> > - *           is requested.
> > + *   caused by an unrecoverable error but HW does not perform automatic shut
> > + *   down.
> > + *   REGULATOR_SEVERITY_WARN should indicate situation where hardware is still
>
> This is obviously making things worse - it's creating inconsistent
> indentation within the list.
Sorry, I will try to fix it in the right way。

Thanks,
Yanteng