[PATCH 05/17] devfreq: devfreq.h: get rid of some doc warnings

[PATCH 05/17] devfreq: devfreq.h: get rid of some doc warnings

[Mauro Carvalho Chehab]

Mark "void *data" as literal, in order to avoid those doc warnings:

	./include/linux/devfreq.h:156: WARNING: Inline emphasis start-string without end-string.
	./include/linux/devfreq.h:259: WARNING: Inline emphasis start-string without end-string.
	./include/linux/devfreq.h:279: WARNING: Inline emphasis start-string without end-string.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 include/linux/devfreq.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/include/linux/devfreq.h b/include/linux/devfreq.h
index 82630fafacde..57e871a559a9 100644
--- a/include/linux/devfreq.h
+++ b/include/linux/devfreq.h
@@ -158,7 +158,7 @@ struct devfreq_stats {
  * functions except for the context of callbacks defined in struct
  * devfreq_governor, the governor should protect its access with the
  * struct mutex lock in struct devfreq. A governor may use this mutex
- * to protect its own private data in void *data as well.
+ * to protect its own private data in ``void *data`` as well.
  */
 struct devfreq {
 	struct list_head node;
@@ -256,7 +256,7 @@ struct devfreq *devfreq_get_devfreq_by_phandle(struct device *dev, int index);
 
 #if IS_ENABLED(CONFIG_DEVFREQ_GOV_SIMPLE_ONDEMAND)
 /**
- * struct devfreq_simple_ondemand_data - void *data fed to struct devfreq
+ * struct devfreq_simple_ondemand_data - ``void *data`` fed to struct devfreq
  *	and devfreq_add_device
  * @upthreshold:	If the load is over this value, the frequency jumps.
  *			Specify 0 to use the default. Valid value = 0 to 100.
@@ -276,7 +276,7 @@ struct devfreq_simple_ondemand_data {
 
 #if IS_ENABLED(CONFIG_DEVFREQ_GOV_PASSIVE)
 /**
- * struct devfreq_passive_data - void *data fed to struct devfreq
+ * struct devfreq_passive_data - ``void *data`` fed to struct devfreq
  *	and devfreq_add_device
  * @parent:	the devfreq instance of parent device.
  * @get_target_freq:	Optional callback, Returns desired operating frequency
-- 
2.24.1

Re: [PATCH 05/17] devfreq: devfreq.h: get rid of some doc warnings

[Chanwoo Choi]

On 3/17/20 11:54 PM, Mauro Carvalho Chehab wrote:
> Mark "void *data" as literal, in order to avoid those doc warnings:
> 
> 	./include/linux/devfreq.h:156: WARNING: Inline emphasis start-string without end-string.
> 	./include/linux/devfreq.h:259: WARNING: Inline emphasis start-string without end-string.
> 	./include/linux/devfreq.h:279: WARNING: Inline emphasis start-string without end-string.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
>  include/linux/devfreq.h | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/include/linux/devfreq.h b/include/linux/devfreq.h
> index 82630fafacde..57e871a559a9 100644
> --- a/include/linux/devfreq.h
> +++ b/include/linux/devfreq.h
> @@ -158,7 +158,7 @@ struct devfreq_stats {
>   * functions except for the context of callbacks defined in struct
>   * devfreq_governor, the governor should protect its access with the
>   * struct mutex lock in struct devfreq. A governor may use this mutex
> - * to protect its own private data in void *data as well.
> + * to protect its own private data in ``void *data`` as well.
>   */
>  struct devfreq {
>  	struct list_head node;
> @@ -256,7 +256,7 @@ struct devfreq *devfreq_get_devfreq_by_phandle(struct device *dev, int index);
>  
>  #if IS_ENABLED(CONFIG_DEVFREQ_GOV_SIMPLE_ONDEMAND)
>  /**
> - * struct devfreq_simple_ondemand_data - void *data fed to struct devfreq
> + * struct devfreq_simple_ondemand_data - ``void *data`` fed to struct devfreq
>   *	and devfreq_add_device
>   * @upthreshold:	If the load is over this value, the frequency jumps.
>   *			Specify 0 to use the default. Valid value = 0 to 100.
> @@ -276,7 +276,7 @@ struct devfreq_simple_ondemand_data {
>  
>  #if IS_ENABLED(CONFIG_DEVFREQ_GOV_PASSIVE)
>  /**
> - * struct devfreq_passive_data - void *data fed to struct devfreq
> + * struct devfreq_passive_data - ``void *data`` fed to struct devfreq
>   *	and devfreq_add_device
>   * @parent:	the devfreq instance of parent device.
>   * @get_target_freq:	Optional callback, Returns desired operating frequency
> 

Applied it. Thanks.

-- 
Best Regards,
Chanwoo Choi
Samsung Electronics