[PATCH] drivers: base: platform.c: Fix warning on make htmldocs

[PATCH] drivers: base: platform.c: Fix warning on make htmldocs

[Marcos Paulo Souza]

The function arch_setup_pdev_archdata has a parameter called pdev, but the 
documentation of the function documents a dev parameter. By changing the 
documentation parameter to pdev fix this warning.

Signed-off-by: Marcos Paulo de Souza <marcos.mage@gmail.com>

---
 drivers/base/platform.c |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/drivers/base/platform.c b/drivers/base/platform.c
index 0cad9c7..99a5272 100644
--- a/drivers/base/platform.c
+++ b/drivers/base/platform.c
@@ -33,7 +33,7 @@ EXPORT_SYMBOL_GPL(platform_bus);
 
 /**
  * arch_setup_pdev_archdata - Allow manipulation of archdata before its used
- * @dev: platform device
+ * @pdev: platform device
  *
  * This is called before platform_device_add() such that any pdev_archdata may
  * be setup before the platform_notifier is called.  So if a user needs to
-- 
1.7.4.1

Re: [PATCH] drivers: base: platform.c: Fix warning on make htmldocs

[Randy Dunlap]

On Mon, 15 Aug 2011 13:02:11 -0300 (BRT) Marcos Paulo Souza wrote:

> 
> The function arch_setup_pdev_archdata has a parameter called pdev, but the 
> documentation of the function documents a dev parameter. By changing the 
> documentation parameter to pdev fix this warning.
> 
> Signed-off-by: Marcos Paulo de Souza <marcos.mage@gmail.com>
> 
> ---
>  drivers/base/platform.c |    2 +-
>  1 files changed, 1 insertions(+), 1 deletions(-)
> 
> diff --git a/drivers/base/platform.c b/drivers/base/platform.c
> index 0cad9c7..99a5272 100644
> --- a/drivers/base/platform.c
> +++ b/drivers/base/platform.c
> @@ -33,7 +33,7 @@ EXPORT_SYMBOL_GPL(platform_bus);
>  
>  /**
>   * arch_setup_pdev_archdata - Allow manipulation of archdata before its used
> - * @dev: platform device
> + * @pdev: platform device
>   *
>   * This is called before platform_device_add() such that any pdev_archdata may
>   * be setup before the platform_notifier is called.  So if a user needs to
> -- 

This is already fixed in linux-next.  It's probably a good idea to
check linux-next for fixes etc.

Thanks,
---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***