Would someone please add/fix the kernel-doc warnings?
Warning(include/net/mac80211.h:2979): No description found for parameter 'band'
Warning(include/net/mac80211.h:2383): No description found for parameter 'set_wakeup'
Warning(net/mac80211/sta_info.h:382): No description found for parameter 't_offset_setpoint'
Warning(net/mac80211/sta_info.h:382): No description found for parameter 'ch_type'
Warning(net/mac80211/sta_info.h:382): No description found for parameter 'supports_40mhz'
Warning(net/mac80211/sta_info.h:382): No description found for parameter 't_offset_setpoint'
Warning(net/mac80211/sta_info.h:382): No description found for parameter 'ch_type'
Warning(net/mac80211/sta_info.h:382): No description found for parameter 'supports_40mhz'
Warning(net/mac80211/sta_info.h:382): No description found for parameter 't_offset_setpoint'
Warning(net/mac80211/sta_info.h:382): No description found for parameter 'ch_type'
Warning(net/mac80211/sta_info.h:382): No description found for parameter 'supports_40mhz'
Warning(net/mac80211/sta_info.h:382): No description found for parameter 't_offset_setpoint'
Warning(net/mac80211/sta_info.h:382): No description found for parameter 'ch_type'
Warning(net/mac80211/sta_info.h:382): No description found for parameter 'supports_40mhz'
Warning(net/mac80211/sta_info.h:382): No description found for parameter 't_offset_setpoint'
Warning(net/mac80211/sta_info.h:382): No description found for parameter 'ch_type'
Warning(net/mac80211/sta_info.h:382): No description found for parameter 'supports_40mhz'
thanks,
--
~Randy
On Sat, 2012-06-09 at 10:05 +0200, Johannes Berg wrote:
> On Fri, 2012-06-08 at 16:46 -0700, Randy Dunlap wrote:
> > Would someone please add/fix the kernel-doc warnings?
>
> I'll commit the below patch for these:
D'oh.
mac80211: add some missing kernel-doc
From: Johannes Berg <[email protected]>
Add a few kernel-doc descriptions that were missed
during development.
Reported-by: Randy Dunlap <[email protected]>
Signed-off-by: Johannes Berg <[email protected]>
---
include/net/mac80211.h | 6 ++++++
net/mac80211/sta_info.h | 2 ++
2 files changed, 8 insertions(+)
--- a/include/net/mac80211.h 2012-06-09 10:04:15.000000000 +0200
+++ b/include/net/mac80211.h 2012-06-09 10:04:19.000000000 +0200
@@ -1945,6 +1945,11 @@ enum ieee80211_rate_control_changed {
* to also unregister the device. If it returns 1, then mac80211
* will also go through the regular complete restart on resume.
*
+ * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
+ * modified. The reason is that device_set_wakeup_enable() is
+ * supposed to be called when the configuration changes, not only
+ * in suspend().
+ *
* @add_interface: Called when a netdevice attached to the hardware is
* enabled. Because it is not called for monitor mode devices, @start
* and @stop must be implemented.
@@ -2974,6 +2979,7 @@ __le16 ieee80211_ctstoself_duration(stru
* ieee80211_generic_frame_duration - Calculate the duration field for a frame
* @hw: pointer obtained from ieee80211_alloc_hw().
* @vif: &struct ieee80211_vif pointer from the add_interface callback.
+ * @band: the band to calculate the frame duration on
* @frame_len: the length of the frame.
* @rate: the rate at which the frame is going to be transmitted.
*
--- a/net/mac80211/sta_info.h 2012-06-09 10:04:15.000000000 +0200
+++ b/net/mac80211/sta_info.h 2012-06-09 10:04:19.000000000 +0200
@@ -278,6 +278,8 @@ struct sta_ampdu_mlme {
* @sta: station information we share with the driver
* @sta_state: duplicates information about station state (for debug)
* @beacon_loss_count: number of times beacon loss has triggered
+ * @supports_40mhz: tracks whether the station advertised 40 MHz support
+ * as we overwrite its HT parameters with the currently used value
*/
struct sta_info {
/* General information, mostly static */
On 06/09/2012 01:07 AM, Johannes Berg wrote:
> On Sat, 2012-06-09 at 10:05 +0200, Johannes Berg wrote:
>> On Fri, 2012-06-08 at 16:46 -0700, Randy Dunlap wrote:
>>> Would someone please add/fix the kernel-doc warnings?
>>
>> I'll commit the below patch for these:
>
> D'oh.
>
>
>
> mac80211: add some missing kernel-doc
>
> From: Johannes Berg <[email protected]>
>
> Add a few kernel-doc descriptions that were missed
> during development.
>
> Reported-by: Randy Dunlap <[email protected]>
> Signed-off-by: Johannes Berg <[email protected]>
Johannes,
There are still 2 warnings from sta_info.h after applying
your patch:
Warning(net/mac80211/sta_info.h:384): No description found for parameter 't_offset_setpoint'
Warning(net/mac80211/sta_info.h:384): No description found for parameter 'ch_type'
> ---
> include/net/mac80211.h | 6 ++++++
> net/mac80211/sta_info.h | 2 ++
> 2 files changed, 8 insertions(+)
>
> --- a/include/net/mac80211.h 2012-06-09 10:04:15.000000000 +0200
> +++ b/include/net/mac80211.h 2012-06-09 10:04:19.000000000 +0200
> @@ -1945,6 +1945,11 @@ enum ieee80211_rate_control_changed {
> * to also unregister the device. If it returns 1, then mac80211
> * will also go through the regular complete restart on resume.
> *
> + * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
> + * modified. The reason is that device_set_wakeup_enable() is
> + * supposed to be called when the configuration changes, not only
> + * in suspend().
> + *
> * @add_interface: Called when a netdevice attached to the hardware is
> * enabled. Because it is not called for monitor mode devices, @start
> * and @stop must be implemented.
> @@ -2974,6 +2979,7 @@ __le16 ieee80211_ctstoself_duration(stru
> * ieee80211_generic_frame_duration - Calculate the duration field for a frame
> * @hw: pointer obtained from ieee80211_alloc_hw().
> * @vif: &struct ieee80211_vif pointer from the add_interface callback.
> + * @band: the band to calculate the frame duration on
> * @frame_len: the length of the frame.
> * @rate: the rate at which the frame is going to be transmitted.
> *
> --- a/net/mac80211/sta_info.h 2012-06-09 10:04:15.000000000 +0200
> +++ b/net/mac80211/sta_info.h 2012-06-09 10:04:19.000000000 +0200
> @@ -278,6 +278,8 @@ struct sta_ampdu_mlme {
> * @sta: station information we share with the driver
> * @sta_state: duplicates information about station state (for debug)
> * @beacon_loss_count: number of times beacon loss has triggered
> + * @supports_40mhz: tracks whether the station advertised 40 MHz support
> + * as we overwrite its HT parameters with the currently used value
> */
> struct sta_info {
> /* General information, mostly static */
>
>
>
--
~Randy
On Fri, 2012-06-08 at 16:46 -0700, Randy Dunlap wrote:
> Would someone please add/fix the kernel-doc warnings?
I'll commit the below patch for these:
> Warning(include/net/mac80211.h:2979): No description found for parameter 'band'
> Warning(include/net/mac80211.h:2383): No description found for parameter 'set_wakeup'
> Warning(net/mac80211/sta_info.h:382): No description found for parameter 'supports_40mhz'
For these, however,
> Warning(net/mac80211/sta_info.h:382): No description found for parameter 't_offset_setpoint'
> Warning(net/mac80211/sta_info.h:382): No description found for parameter 'ch_type'
I don't know what they actually should be described as, need a patch
from the mesh people.
johannes
Hi Randy and Johannes,
I have sent a patch adding kernel-docs to these variables just now.
Thanks,
Ashok
On Mon, Jun 11, 2012 at 8:55 AM, Johannes Berg
<[email protected]> wrote:
> On Mon, 2012-06-11 at 08:49 -0700, Randy Dunlap wrote:
>
>> There are still 2 warnings from sta_info.h after applying
>> your patch:
>>
>> Warning(net/mac80211/sta_info.h:384): No description found for parameter 't_offset_setpoint'
>> Warning(net/mac80211/sta_info.h:384): No description found for parameter 'ch_type'
>
> Right, I wasn't sure what the descriptions should be so asked Javier &
> team to address those.
>
> johannes
>
> --
> To unsubscribe from this list: send the line "unsubscribe linux-wireless" in
> the body of a message to [email protected]
> More majordomo info at ?http://vger.kernel.org/majordomo-info.html
On 06/09/2012 01:07 AM, Johannes Berg wrote:
> On Sat, 2012-06-09 at 10:05 +0200, Johannes Berg wrote:
>> On Fri, 2012-06-08 at 16:46 -0700, Randy Dunlap wrote:
>>> Would someone please add/fix the kernel-doc warnings?
>>
>> I'll commit the below patch for these:
>
> D'oh.
>
>
>
> mac80211: add some missing kernel-doc
>
> From: Johannes Berg <[email protected]>
>
> Add a few kernel-doc descriptions that were missed
> during development.
>
> Reported-by: Randy Dunlap <[email protected]>
> Signed-off-by: Johannes Berg <[email protected]>
Acked-by: Randy Dunlap <[email protected]>
Thanks :)
> ---
> include/net/mac80211.h | 6 ++++++
> net/mac80211/sta_info.h | 2 ++
> 2 files changed, 8 insertions(+)
>
> --- a/include/net/mac80211.h 2012-06-09 10:04:15.000000000 +0200
> +++ b/include/net/mac80211.h 2012-06-09 10:04:19.000000000 +0200
> @@ -1945,6 +1945,11 @@ enum ieee80211_rate_control_changed {
> * to also unregister the device. If it returns 1, then mac80211
> * will also go through the regular complete restart on resume.
> *
> + * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
> + * modified. The reason is that device_set_wakeup_enable() is
> + * supposed to be called when the configuration changes, not only
> + * in suspend().
> + *
> * @add_interface: Called when a netdevice attached to the hardware is
> * enabled. Because it is not called for monitor mode devices, @start
> * and @stop must be implemented.
> @@ -2974,6 +2979,7 @@ __le16 ieee80211_ctstoself_duration(stru
> * ieee80211_generic_frame_duration - Calculate the duration field for a frame
> * @hw: pointer obtained from ieee80211_alloc_hw().
> * @vif: &struct ieee80211_vif pointer from the add_interface callback.
> + * @band: the band to calculate the frame duration on
> * @frame_len: the length of the frame.
> * @rate: the rate at which the frame is going to be transmitted.
> *
> --- a/net/mac80211/sta_info.h 2012-06-09 10:04:15.000000000 +0200
> +++ b/net/mac80211/sta_info.h 2012-06-09 10:04:19.000000000 +0200
> @@ -278,6 +278,8 @@ struct sta_ampdu_mlme {
> * @sta: station information we share with the driver
> * @sta_state: duplicates information about station state (for debug)
> * @beacon_loss_count: number of times beacon loss has triggered
> + * @supports_40mhz: tracks whether the station advertised 40 MHz support
> + * as we overwrite its HT parameters with the currently used value
> */
> struct sta_info {
> /* General information, mostly static */
>
>
> --
--
~Randy
On Mon, 2012-06-11 at 08:49 -0700, Randy Dunlap wrote:
> There are still 2 warnings from sta_info.h after applying
> your patch:
>
> Warning(net/mac80211/sta_info.h:384): No description found for parameter 't_offset_setpoint'
> Warning(net/mac80211/sta_info.h:384): No description found for parameter 'ch_type'
Right, I wasn't sure what the descriptions should be so asked Javier &
team to address those.
johannes