2014-05-02 14:40:22

by Masanari Iida

[permalink] [raw]
Subject: [Patch] cfg80211/mac80211: Fix warning on make xmldocs caused by cfg80211.h

This patch fix a warning on make xmldocs.
The symptom happened on linux-next as of 0502.
Not on Linus's tree.
Because a pach 2beb6dab2d799ee8934cb0801845e551ad8c70f2
which causes this symptom exist only on linux-next.

Masanari Iida (1):
cfg80211/mac80211: Fix warning on make xmldocs caused by cfg80211.h

include/net/cfg80211.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

--
2.0.0.rc1.15.g7e76a2f



2014-05-03 06:15:37

by Luciano Coelho

[permalink] [raw]
Subject: Re: [PATCH] cfg80211/mac80211: Fix warning on make xmldocs caused by cfg80211.h

Hi,

On Fri, 2014-05-02 at 23:39 +0900, Masanari Iida wrote:
> Following error messages caused by wrong description.
>
> Warning(include/net/cfg80211.h:461): No description found
> for parameter 'nl80211_iftype'
>
> Change "iftype" to "nl80211_iftype" fix the errors.
>
> Signed-off-by: Masanari Iida <[email protected]>
> ---
> include/net/cfg80211.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/net/cfg80211.h b/include/net/cfg80211.h
> index 7eae46c..695c562 100644
> --- a/include/net/cfg80211.h
> +++ b/include/net/cfg80211.h
> @@ -452,7 +452,7 @@ bool cfg80211_chandef_usable(struct wiphy *wiphy,
> * cfg80211_chandef_dfs_required - checks if radar detection is required
> * @wiphy: the wiphy to validate against
> * @chandef: the channel definition to check
> - * @iftype: the interface type as specified in &enum nl80211_iftype
> + * @nl80211_iftype: the interface type as specified in &enum nl80211_iftype
> * Returns:
> * 1 if radar detection is required, 0 if it is not, < 0 on error
> */

A better way to fix this would be to add "iftype" to the function
prototype, since we don't usually use nameless arguments:

diff --git a/include/net/cfg80211.h b/include/net/cfg80211.h
index 43c674e..f9e7373 100644
--- a/include/net/cfg80211.h
+++ b/include/net/cfg80211.h
@@ -458,7 +458,7 @@ bool cfg80211_chandef_usable(struct wiphy *wiphy,
*/
int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
const struct cfg80211_chan_def *chandef,
- enum nl80211_iftype);
+ enum nl80211_iftype iftype);

/**
* ieee80211_chandef_rate_flags - returns rate flags for a channel

--
Cheers,
Luca.



2014-05-07 15:49:20

by Masanari Iida

[permalink] [raw]
Subject: Re: [PATCH] cfg80211/mac80211: Fix warning on make xmldocs caused by cfg80211.h

Hi,
Your patch fixed the symptom.
I have tested it on linux-next as of 7th/May.
Thank you.

Tested-by: Masanari Iida <[email protected]>

Regards,
Masanari

On Sat, May 3, 2014 at 3:15 PM, Luciano Coelho <[email protected]> wrote:
> Hi,
>
> A better way to fix this would be to add "iftype" to the function
> prototype, since we don't usually use nameless arguments:
>
> diff --git a/include/net/cfg80211.h b/include/net/cfg80211.h
> index 43c674e..f9e7373 100644
> --- a/include/net/cfg80211.h
> +++ b/include/net/cfg80211.h
> @@ -458,7 +458,7 @@ bool cfg80211_chandef_usable(struct wiphy *wiphy,
> */
> int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
> const struct cfg80211_chan_def *chandef,
> - enum nl80211_iftype);
> + enum nl80211_iftype iftype);
>
> /**
> * ieee80211_chandef_rate_flags - returns rate flags for a channel
>
> --
> Cheers,
> Luca.
>

2014-05-02 14:40:21

by Masanari Iida

[permalink] [raw]
Subject: [PATCH] cfg80211/mac80211: Fix warning on make xmldocs caused by cfg80211.h

Following error messages caused by wrong description.

Warning(include/net/cfg80211.h:461): No description found
for parameter 'nl80211_iftype'

Change "iftype" to "nl80211_iftype" fix the errors.

Signed-off-by: Masanari Iida <[email protected]>
---
include/net/cfg80211.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/net/cfg80211.h b/include/net/cfg80211.h
index 7eae46c..695c562 100644
--- a/include/net/cfg80211.h
+++ b/include/net/cfg80211.h
@@ -452,7 +452,7 @@ bool cfg80211_chandef_usable(struct wiphy *wiphy,
* cfg80211_chandef_dfs_required - checks if radar detection is required
* @wiphy: the wiphy to validate against
* @chandef: the channel definition to check
- * @iftype: the interface type as specified in &enum nl80211_iftype
+ * @nl80211_iftype: the interface type as specified in &enum nl80211_iftype
* Returns:
* 1 if radar detection is required, 0 if it is not, < 0 on error
*/
--
2.0.0.rc1.15.g7e76a2f