linux-kernel - Re: [PATCH] PM / devfreq: kernel-doc typo corrections

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <50770E5C.4040302@xenotime.net>
Date:	Thu, 11 Oct 2012 11:22:20 -0700
From:	Randy Dunlap <rdunlap@...otime.net>
To:	Nishanth Menon <nm@...com>
CC:	linux-pm@...r.kernel.org, "Rafael J. Wysocki" <rjw@...k.pl>,
	Kevin Hilman <khilman@...com>,
	MyungJoo Ham <myungjoo.ham@...sung.com>,
	Kyungmin Park <kyungmin.park@...sung.com>,
	linux-kernel@...r.kernel.org
Subject: Re: [PATCH] PM / devfreq: kernel-doc typo corrections

On 10/11/2012 06:39 AM, Nishanth Menon wrote:

> Parameter documentation needs a ':' for scripts/kernel-doc
> to parse properly.
> 
> Minor fixes for ones warned by:
> ./scripts/kernel-doc -text drivers/devfreq/devfreq.c>/dev/null
> 
> Cc: "Rafael J. Wysocki" <rjw@...k.pl>
> Cc: Kevin Hilman <khilman@...com>
> Cc: MyungJoo Ham <myungjoo.ham@...sung.com>
> Cc: Kyungmin Park <kyungmin.park@...sung.com>
> Cc: linux-kernel@...r.kernel.org
> Cc: linux-pm@...r.kernel.org
> 
> Signed-off-by: Nishanth Menon <nm@...com>


Acked-by: Randy Dunlap <rdunlap@...otime.net>

Thanks.

> ---
>  drivers/devfreq/devfreq.c |   22 +++++++++++-----------
>  1 file changed, 11 insertions(+), 11 deletions(-)
> 
> diff --git a/drivers/devfreq/devfreq.c b/drivers/devfreq/devfreq.c
> index 70c31d4..e4d48d2 100644
> --- a/drivers/devfreq/devfreq.c
> +++ b/drivers/devfreq/devfreq.c
> @@ -123,9 +123,9 @@ int update_devfreq(struct devfreq *devfreq)
>  /**
>   * devfreq_notifier_call() - Notify that the device frequency requirements
>   *			   has been changed out of devfreq framework.
> - * @nb		the notifier_block (supposed to be devfreq->nb)
> - * @type	not used
> - * @devp	not used
> + * @nb:		the notifier_block (supposed to be devfreq->nb)
> + * @type:	not used
> + * @devp:	not used
>   *
>   * Called by a notifier that uses devfreq->nb.
>   */
> @@ -431,7 +431,7 @@ err_out:
>  
>  /**
>   * devfreq_remove_device() - Remove devfreq feature from a device.
> - * @devfreq	the devfreq instance to be removed
> + * @devfreq:	the devfreq instance to be removed
>   */
>  int devfreq_remove_device(struct devfreq *devfreq)
>  {
> @@ -641,9 +641,9 @@ module_exit(devfreq_exit);
>  /**
>   * devfreq_recommended_opp() - Helper function to get proper OPP for the
>   *			     freq value given to target callback.
> - * @dev		The devfreq user device. (parent of devfreq)
> - * @freq	The frequency given to target function
> - * @flags	Flags handed from devfreq framework.
> + * @dev:	The devfreq user device. (parent of devfreq)
> + * @freq:	The frequency given to target function
> + * @flags:	Flags handed from devfreq framework.
>   *
>   */
>  struct opp *devfreq_recommended_opp(struct device *dev, unsigned long *freq,
> @@ -674,8 +674,8 @@ struct opp *devfreq_recommended_opp(struct device *dev, unsigned long *freq,
>   * devfreq_register_opp_notifier() - Helper function to get devfreq notified
>   *				   for any changes in the OPP availability
>   *				   changes
> - * @dev		The devfreq user device. (parent of devfreq)
> - * @devfreq	The devfreq object.
> + * @dev:	The devfreq user device. (parent of devfreq)
> + * @devfreq:	The devfreq object.
>   */
>  int devfreq_register_opp_notifier(struct device *dev, struct devfreq *devfreq)
>  {
> @@ -690,8 +690,8 @@ int devfreq_register_opp_notifier(struct device *dev, struct devfreq *devfreq)
>   * devfreq_unregister_opp_notifier() - Helper function to stop getting devfreq
>   *				     notified for any changes in the OPP
>   *				     availability changes anymore.
> - * @dev		The devfreq user device. (parent of devfreq)
> - * @devfreq	The devfreq object.
> + * @dev:	The devfreq user device. (parent of devfreq)
> + * @devfreq:	The devfreq object.
>   *
>   * At exit() callback of devfreq_dev_profile, this must be included if
>   * devfreq_recommended_opp is used.



-- 
~Randy
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/