| Message ID | 20200625163614.4001403-4-lee.jones@linaro.org (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Fix a bunch of W=1 warnings in Regulator | expand |
On Thu, Jun 25, 2020 at 05:36:07PM +0100, Lee Jones wrote: > Kerneldoc validation gets confused if syntax isn't "@.*: ". > > Adding the missing colons squashes the following W=1 warnings: > * of_check_coupling_data - Parse rdev's coupling properties and check data > * consistency > - * @rdev - pointer to regulator_dev whose data is checked > + * @rdev: - pointer to regulator_dev whose data is checked It shuts up the warning but are you sure this is going to get formatted well by the tools? We now have a - as the first character in the description which I'm guessing the tools are going to render which won't look great.
On Thu, 25 Jun 2020, Mark Brown wrote: > On Thu, Jun 25, 2020 at 05:36:07PM +0100, Lee Jones wrote: > > Kerneldoc validation gets confused if syntax isn't "@.*: ". > > > > Adding the missing colons squashes the following W=1 warnings: > > > * of_check_coupling_data - Parse rdev's coupling properties and check data > > * consistency > > - * @rdev - pointer to regulator_dev whose data is checked > > + * @rdev: - pointer to regulator_dev whose data is checked > > It shuts up the warning but are you sure this is going to get formatted > well by the tools? We now have a - as the first character in the > description which I'm guessing the tools are going to render which won't > look great. Happy to fix.
diff --git a/drivers/regulator/of_regulator.c b/drivers/regulator/of_regulator.c index 87637eb6bcbcb..292e68c818ea1 100644 --- a/drivers/regulator/of_regulator.c +++ b/drivers/regulator/of_regulator.c @@ -532,7 +532,7 @@ static bool of_coupling_find_node(struct device_node *src, /** * of_check_coupling_data - Parse rdev's coupling properties and check data * consistency - * @rdev - pointer to regulator_dev whose data is checked + * @rdev: - pointer to regulator_dev whose data is checked * * Function checks if all the following conditions are met: * - rdev's max_spread is greater than 0
Kerneldoc validation gets confused if syntax isn't "@.*: ". Adding the missing colons squashes the following W=1 warnings: Signed-off-by: Lee Jones <lee.jones@linaro.org> --- drivers/regulator/of_regulator.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)