| Message ID | 20200626065738.93412-3-lee.jones@linaro.org |
|---|---|
| State | Accepted |
| Commit | 7cb5f692077e3b91dcb706cbf58d495d066439ce |
| Headers | show |
| Series | None | expand |
On Thu 25 Jun 23:57 PDT 2020, Lee Jones wrote: > W=1 kernel builds report a lack of descriptions for various > enum properties and function arguments. In reality they are > documented, but the formatting was not as expected '@.*:'. > Instead, some weird arg identifiers were used or none at all. > > This change fixes the following warnings: > > drivers/regulator/qcom-rpmh-regulator.c:33: warning: Enum value 'VRM' not described in enum 'rpmh_regulator_type' > drivers/regulator/qcom-rpmh-regulator.c:33: warning: Enum value 'XOB' not described in enum 'rpmh_regulator_type' > drivers/regulator/qcom-rpmh-regulator.c:416: warning: Function parameter or member 'vreg' not described in 'rpmh_regulator_init_vreg' > drivers/regulator/qcom-rpmh-regulator.c:416: warning: Function parameter or member 'dev' not described in 'rpmh_regulator_init_vreg' > drivers/regulator/qcom-rpmh-regulator.c:416: warning: Function parameter or member 'node' not described in 'rpmh_regulator_init_vreg' > drivers/regulator/qcom-rpmh-regulator.c:416: warning: Function parameter or member 'pmic_id' not described in 'rpmh_regulator_init_vreg' > drivers/regulator/qcom-rpmh-regulator.c:416: warning: Function parameter or member 'pmic_rpmh_data' not described in 'rpmh_regulator_init_vreg' > > Cc: Andy Gross <agross@kernel.org> > Cc: Bjorn Andersson <bjorn.andersson@linaro.org> > Cc: linux-arm-msm@vger.kernel.org > Signed-off-by: Lee Jones <lee.jones@linaro.org> Reviewed-by: Bjorn Andersson <bjorn.andersson@linaro.org> Thanks, Bjorn > --- > drivers/regulator/qcom-rpmh-regulator.c | 14 +++++++------- > 1 file changed, 7 insertions(+), 7 deletions(-) > > diff --git a/drivers/regulator/qcom-rpmh-regulator.c b/drivers/regulator/qcom-rpmh-regulator.c > index 79bdc129cb504..08dcc614efa7f 100644 > --- a/drivers/regulator/qcom-rpmh-regulator.c > +++ b/drivers/regulator/qcom-rpmh-regulator.c > @@ -22,9 +22,9 @@ > > /** > * enum rpmh_regulator_type - supported RPMh accelerator types > - * %VRM: RPMh VRM accelerator which supports voting on enable, voltage, > + * @VRM: RPMh VRM accelerator which supports voting on enable, voltage, > * and mode of LDO, SMPS, and BOB type PMIC regulators. > - * %XOB: RPMh XOB accelerator which supports voting on the enable state > + * @XOB: RPMh XOB accelerator which supports voting on the enable state > * of PMIC regulators. > */ > enum rpmh_regulator_type { > @@ -399,13 +399,13 @@ static const struct regulator_ops rpmh_regulator_xob_ops = { > > /** > * rpmh_regulator_init_vreg() - initialize all attributes of an rpmh-regulator > - * vreg: Pointer to the individual rpmh-regulator resource > - * dev: Pointer to the top level rpmh-regulator PMIC device > - * node: Pointer to the individual rpmh-regulator resource > + * @vreg: Pointer to the individual rpmh-regulator resource > + * @dev: Pointer to the top level rpmh-regulator PMIC device > + * @node: Pointer to the individual rpmh-regulator resource > * device node > - * pmic_id: String used to identify the top level rpmh-regulator > + * @pmic_id: String used to identify the top level rpmh-regulator > * PMIC device on the board > - * pmic_rpmh_data: Pointer to a null-terminated array of rpmh-regulator > + * @pmic_rpmh_data: Pointer to a null-terminated array of rpmh-regulator > * resources defined for the top level PMIC device > * > * Return: 0 on success, errno on failure > -- > 2.25.1 >
diff --git a/drivers/regulator/qcom-rpmh-regulator.c b/drivers/regulator/qcom-rpmh-regulator.c index 79bdc129cb504..08dcc614efa7f 100644 --- a/drivers/regulator/qcom-rpmh-regulator.c +++ b/drivers/regulator/qcom-rpmh-regulator.c @@ -22,9 +22,9 @@ /** * enum rpmh_regulator_type - supported RPMh accelerator types - * %VRM: RPMh VRM accelerator which supports voting on enable, voltage, + * @VRM: RPMh VRM accelerator which supports voting on enable, voltage, * and mode of LDO, SMPS, and BOB type PMIC regulators. - * %XOB: RPMh XOB accelerator which supports voting on the enable state + * @XOB: RPMh XOB accelerator which supports voting on the enable state * of PMIC regulators. */ enum rpmh_regulator_type { @@ -399,13 +399,13 @@ static const struct regulator_ops rpmh_regulator_xob_ops = { /** * rpmh_regulator_init_vreg() - initialize all attributes of an rpmh-regulator - * vreg: Pointer to the individual rpmh-regulator resource - * dev: Pointer to the top level rpmh-regulator PMIC device - * node: Pointer to the individual rpmh-regulator resource + * @vreg: Pointer to the individual rpmh-regulator resource + * @dev: Pointer to the top level rpmh-regulator PMIC device + * @node: Pointer to the individual rpmh-regulator resource * device node - * pmic_id: String used to identify the top level rpmh-regulator + * @pmic_id: String used to identify the top level rpmh-regulator * PMIC device on the board - * pmic_rpmh_data: Pointer to a null-terminated array of rpmh-regulator + * @pmic_rpmh_data: Pointer to a null-terminated array of rpmh-regulator * resources defined for the top level PMIC device * * Return: 0 on success, errno on failure
W=1 kernel builds report a lack of descriptions for various enum properties and function arguments. In reality they are documented, but the formatting was not as expected '@.*:'. Instead, some weird arg identifiers were used or none at all. This change fixes the following warnings: drivers/regulator/qcom-rpmh-regulator.c:33: warning: Enum value 'VRM' not described in enum 'rpmh_regulator_type' drivers/regulator/qcom-rpmh-regulator.c:33: warning: Enum value 'XOB' not described in enum 'rpmh_regulator_type' drivers/regulator/qcom-rpmh-regulator.c:416: warning: Function parameter or member 'vreg' not described in 'rpmh_regulator_init_vreg' drivers/regulator/qcom-rpmh-regulator.c:416: warning: Function parameter or member 'dev' not described in 'rpmh_regulator_init_vreg' drivers/regulator/qcom-rpmh-regulator.c:416: warning: Function parameter or member 'node' not described in 'rpmh_regulator_init_vreg' drivers/regulator/qcom-rpmh-regulator.c:416: warning: Function parameter or member 'pmic_id' not described in 'rpmh_regulator_init_vreg' drivers/regulator/qcom-rpmh-regulator.c:416: warning: Function parameter or member 'pmic_rpmh_data' not described in 'rpmh_regulator_init_vreg' Cc: Andy Gross <agross@kernel.org> Cc: Bjorn Andersson <bjorn.andersson@linaro.org> Cc: linux-arm-msm@vger.kernel.org Signed-off-by: Lee Jones <lee.jones@linaro.org> --- drivers/regulator/qcom-rpmh-regulator.c | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) -- 2.25.1