regulator: driver.h: fix regulator_map_* function names
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Tue, 17 Mar 2020 14:54:26 +0000 (15:54 +0100)
committerMark Brown <broonie@kernel.org>
Wed, 18 Mar 2020 21:57:20 +0000 (21:57 +0000)
The toolchain produces a warning on this driver when building
the docs:

./include/linux/regulator/driver.h:284: WARNING: Unknown target name: "regulator_regmap_x_voltage".

While fixing it, we notices that there's no function names
with the above pattern. It seems that some previous patch
renamed it to regulator_map_* instead.

So, change the function name, replacing "x" by "*", with is
a more used way to add a wildcard, and escape those with
``literal`` markup, in order to avoid the toolchain to think
that this is a link to some existing document chapter.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/b9f5687bcf981a88c9d1fd04d759a540fda53a99.1584456635.git.mchehab+huawei@kernel.org
Signed-off-by: Mark Brown <broonie@kernel.org>
include/linux/regulator/driver.h

index 9a911bb5fb61aed06c3f026bb62fcbc0fe3525a5..29d920516e0b842ef3d7049e3c57087ead46e648 100644 (file)
@@ -277,9 +277,9 @@ enum regulator_type {
  * @curr_table: Current limit mapping table (if table based mapping)
  *
  * @vsel_range_reg: Register for range selector when using pickable ranges
- *                 and regulator_regmap_X_voltage_X_pickable functions.
+ *                 and ``regulator_map_*_voltage_*_pickable`` functions.
  * @vsel_range_mask: Mask for register bitfield used for range selector
- * @vsel_reg: Register for selector when using regulator_regmap_X_voltage_
+ * @vsel_reg: Register for selector when using ``regulator_map_*_voltage_*``
  * @vsel_mask: Mask for register bitfield used for selector
  * @vsel_step: Specify the resolution of selector stepping when setting
  *            voltage. If 0, then no stepping is done (requested selector is