[PATCH 0/2] regulator: add missing descriptions for docs

[PATCH 0/2] regulator: add missing descriptions for docs

[Luis de Bethencourt]

Hi,

I noticed this issues when running make htmldocs. It returns the following
warnings:
.//include/linux/regulator/machine.h:163: warning: No description found for parameter 'over_current_protection'
.//include/linux/regulator/driver.h:205: warning: No description found for parameter 'set_over_current_protection'
.//include/linux/regulator/driver.h:339: warning: No description found for parameter 'csel_reg'
.//include/linux/regulator/driver.h:339: warning: No description found for parameter 'csel_mask'

Thanks,
Luis

Luis de Bethencourt (2):
  regulator: add missing description for set_over_current_protection
  regulator: add missing descriptions in regulator_desc

 include/linux/regulator/driver.h | 5 +++++
 1 file changed, 5 insertions(+)

-- 
2.5.1

[PATCH 1/2] regulator: add missing description for set_over_current_protection

[Luis de Bethencourt]

Operation set_over_current_protection of regulator_ops is missing a
description for documentation.

Fixes: 3a003baeec24 ("regulator: Add over current protection (OCP) support")
Signed-off-by: Luis de Bethencourt <luisbg@osg.samsung.com>
---
 include/linux/regulator/driver.h | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/include/linux/regulator/driver.h b/include/linux/regulator/driver.h
index cd271e8..8ea86dc 100644
--- a/include/linux/regulator/driver.h
+++ b/include/linux/regulator/driver.h
@@ -93,6 +93,9 @@ struct regulator_linear_range {
  * @get_current_limit: Get the configured limit for a current-limited regulator.
  * @set_input_current_limit: Configure an input limit.
  *
+ * @set_over_current_protection: Support capability of automatically shutting
+ *                               down when detecting an over current event.
+ *
  * @set_active_discharge: Set active discharge enable/disable of regulators.
  *
  * @set_mode: Set the configured operating mode for the regulator.
-- 
2.5.1

[PATCH 1/2 v2] regulator: add missing description for set_over_current_protection

[Luis de Bethencourt]

Over current protection is missing descriptions for documentation.


Fixes: 3a003baeec24 ("regulator: Add over current protection (OCP) support")
Signed-off-by: Luis de Bethencourt <luisbg@osg.samsung.com>
---
Hi,

Sorry. I missed this second missing description related to over current
protection in regulator_linear_range struct.

Thanks,
Luis

 include/linux/regulator/driver.h  | 3 +++
 include/linux/regulator/machine.h | 1 +
 2 files changed, 4 insertions(+)

diff --git a/include/linux/regulator/driver.h b/include/linux/regulator/driver.h
index cd271e8..8ea86dc 100644
--- a/include/linux/regulator/driver.h
+++ b/include/linux/regulator/driver.h
@@ -93,6 +93,9 @@ struct regulator_linear_range {
  * @get_current_limit: Get the configured limit for a current-limited regulator.
  * @set_input_current_limit: Configure an input limit.
  *
+ * @set_over_current_protection: Support capability of automatically shutting
+ *                               down when detecting an over current event.
+ *
  * @set_active_discharge: Set active discharge enable/disable of regulators.
  *
  * @set_mode: Set the configured operating mode for the regulator.
diff --git a/include/linux/regulator/machine.h b/include/linux/regulator/machine.h
index 5d627c8..ad3e515 100644
--- a/include/linux/regulator/machine.h
+++ b/include/linux/regulator/machine.h
@@ -97,6 +97,7 @@ struct regulator_state {
  * @ramp_disable: Disable ramp delay when initialising or when setting voltage.
  * @soft_start: Enable soft start so that voltage ramps slowly.
  * @pull_down: Enable pull down when regulator is disabled.
+ * @over_current_protection: Auto disable on over current event.
  *
  * @input_uV: Input voltage for regulator when supplied by another regulator.
  *
-- 
2.5.1

Re: [PATCH 1/2 v2] regulator: add missing description for set_over_current_protection

[Mark Brown]

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

On Wed, Mar 23, 2016 at 11:35:39AM +0000, Luis de Bethencourt wrote:

> Sorry. I missed this second missing description related to over current
> protection in regulator_linear_range struct.

Please don't send new patches in reply to old ones, especially not
individual ones in the middle of a series.  It makes it much harder to
tell what's going on and what current versions of things are.

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

Re: [PATCH 1/2 v2] regulator: add missing description for set_over_current_protection

[Luis de Bethencourt]

On 23/03/16 11:45, Mark Brown wrote:
> On Wed, Mar 23, 2016 at 11:35:39AM +0000, Luis de Bethencourt wrote:
> 
>> Sorry. I missed this second missing description related to over current
>> protection in regulator_linear_range struct.
> 
> Please don't send new patches in reply to old ones, especially not
> individual ones in the middle of a series.  It makes it much harder to
> tell what's going on and what current versions of things are.
> 

My bad. Next time I will send the [v2] as a new thread.

Sorry for making it harder to read,
Luis

Applied "regulator: add missing description for set_over_current_protection" to the regulator tree

[Mark Brown]

The patch

   regulator: add missing description for set_over_current_protection

has been applied to the regulator tree at

   git://git.kernel.org/pub/scm/linux/kernel/git/broonie/regulator.git 

All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.  

You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying
to this mail.

Thanks,
Mark

>From abf2f825d115397944cab91a20c937331d77e37c Mon Sep 17 00:00:00 2001
From: Luis de Bethencourt <luisbg@osg.samsung.com>
Date: Wed, 23 Mar 2016 11:35:39 +0000
Subject: [PATCH] regulator: add missing description for
 set_over_current_protection

Over current protection is missing descriptions for documentation.

Signed-off-by: Luis de Bethencourt <luisbg@osg.samsung.com>
Signed-off-by: Mark Brown <broonie@kernel.org>
---
 include/linux/regulator/driver.h  | 3 +++
 include/linux/regulator/machine.h | 1 +
 2 files changed, 4 insertions(+)

diff --git a/include/linux/regulator/driver.h b/include/linux/regulator/driver.h
index 01d26244a610..1392022fe509 100644
--- a/include/linux/regulator/driver.h
+++ b/include/linux/regulator/driver.h
@@ -93,6 +93,9 @@ struct regulator_linear_range {
  * @get_current_limit: Get the configured limit for a current-limited regulator.
  * @set_input_current_limit: Configure an input limit.
  *
+ * @set_over_current_protection: Support capability of automatically shutting
+ *                               down when detecting an over current event.
+ *
  * @set_active_discharge: Set active discharge enable/disable of regulators.
  *
  * @set_mode: Set the configured operating mode for the regulator.
diff --git a/include/linux/regulator/machine.h b/include/linux/regulator/machine.h
index 5d627c83a630..ad3e5158e586 100644
--- a/include/linux/regulator/machine.h
+++ b/include/linux/regulator/machine.h
@@ -97,6 +97,7 @@ struct regulator_state {
  * @ramp_disable: Disable ramp delay when initialising or when setting voltage.
  * @soft_start: Enable soft start so that voltage ramps slowly.
  * @pull_down: Enable pull down when regulator is disabled.
+ * @over_current_protection: Auto disable on over current event.
  *
  * @input_uV: Input voltage for regulator when supplied by another regulator.
  *
-- 
2.7.0

[PATCH 2/2] regulator: add missing descriptions in regulator_desc

[Luis de Bethencourt]

Members csel_reg and csel_mask of the regulator_desc struct are missing
descriptions for documentation. Adding them.

Fixes: c0ea88b890d6 ("regulator: tps65218: add support for LS3 current regulator")
Signed-off-by: Luis de Bethencourt <luisbg@osg.samsung.com>
---
 include/linux/regulator/driver.h | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/include/linux/regulator/driver.h b/include/linux/regulator/driver.h
index 8ea86dc..1392022 100644
--- a/include/linux/regulator/driver.h
+++ b/include/linux/regulator/driver.h
@@ -258,6 +258,8 @@ enum regulator_type {
  *
  * @vsel_reg: Register for selector when using regulator_regmap_X_voltage_
  * @vsel_mask: Mask for register bitfield used for selector
+ * @csel_reg: Register for TPS65218 LS3 current regulator
+ * @csel_mask: Mask for TPS65218 LS3 current regulator
  * @apply_reg: Register for initiate voltage change on the output when
  *                using regulator_set_voltage_sel_regmap
  * @apply_bit: Register bitfield used for initiate voltage change on the
-- 
2.5.1

Applied "regulator: add missing descriptions in regulator_desc" to the regulator tree

[Mark Brown]

The patch

   regulator: add missing descriptions in regulator_desc

has been applied to the regulator tree at

   git://git.kernel.org/pub/scm/linux/kernel/git/broonie/regulator.git 

All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.  

You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying
to this mail.

Thanks,
Mark

>From d13d3a573be5535123beacd926be38e571097bc5 Mon Sep 17 00:00:00 2001
From: Luis de Bethencourt <luisbg@osg.samsung.com>
Date: Wed, 23 Mar 2016 11:24:47 +0000
Subject: [PATCH] regulator: add missing descriptions in regulator_desc

Members csel_reg and csel_mask of the regulator_desc struct are missing
descriptions for documentation. Adding them.

Signed-off-by: Luis de Bethencourt <luisbg@osg.samsung.com>
Signed-off-by: Mark Brown <broonie@kernel.org>
---
 include/linux/regulator/driver.h | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/include/linux/regulator/driver.h b/include/linux/regulator/driver.h
index cd271e89a7e6..01d26244a610 100644
--- a/include/linux/regulator/driver.h
+++ b/include/linux/regulator/driver.h
@@ -255,6 +255,8 @@ enum regulator_type {
  *
  * @vsel_reg: Register for selector when using regulator_regmap_X_voltage_
  * @vsel_mask: Mask for register bitfield used for selector
+ * @csel_reg: Register for TPS65218 LS3 current regulator
+ * @csel_mask: Mask for TPS65218 LS3 current regulator
  * @apply_reg: Register for initiate voltage change on the output when
  *                using regulator_set_voltage_sel_regmap
  * @apply_bit: Register bitfield used for initiate voltage change on the
-- 
2.7.0