Skip to contentSkip to conversation

mac80211: fix kernel-doc comments in mac80211.h

PATCH In review [email protected] 4 participants 7 messages May 18, 2015 – Jun 1, 2015 mac80211

lore
Share & tools
lore

[email protected]

author
#0 lore raw

PATCH 1/1 mac80211: fix kernel-doc comments in mac80211.h

Commits a818292 "mac80211: convert rssi_callback() to event_callback()" and a940909 "mac80211: notify the driver about authentication status" added two errors and one warning when building docs for the mac80211 driver. Fix the kernel-doc comments so that the documentation targets could be built successfully again.

Signed-off-by Andrey Konovalov <[email protected]>
---
 include/net/mac80211.h |    6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
include/net/mac80211.h +3 -3
index b4bef11..dbb5f33 100644
@@ -354,7 +354,7 @@ enum ieee80211_rssi_event_data {
 };
 
 /**
- * enum ieee80211_rssi_event - data attached to an %RSSI_EVENT
+ * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
  * @data: See &enum ieee80211_rssi_event_data
  */
 struct ieee80211_rssi_event {

@@ -388,7 +388,7 @@ enum ieee80211_mlme_event_status {
 };
 
 /**
- * enum ieee80211_mlme_event - data attached to an %MLME_EVENT
+ * struct ieee80211_mlme_event - data attached to an %MLME_EVENT
  * @data: See &enum ieee80211_mlme_event_data
  * @status: See &enum ieee80211_mlme_event_status
  * @reason: the reason code if applicable

@@ -401,7 +401,7 @@ struct ieee80211_mlme_event {
 
 /**
  * struct ieee80211_event - event to be sent to the driver
- * @type The event itself. See &enum ieee80211_event_type.
+ * @type: The event itself. See &enum ieee80211_event_type.
  * @rssi: relevant if &type is %RSSI_EVENT
  * @mlme: relevant if &type is %AUTH_EVENT
  */
Signature · 1 line
1.7.9.5
maintainer
#1 lore raw
Quoted 5 lines · On Mon, 2015-05-18 at 23:39 +0300, [email protected] wrote:

Commits a818292 "mac80211: convert rssi_callback() to event_callback()" and a940909 "mac80211: notify the driver about authentication status" added two errors and one warning when building docs for the mac80211 driver. Fix the kernel-doc comments so that the documentation targets could be built successfully again.

This was already fixed.

johannes

#2 lore raw
Quoted 8 lines · Johannes Berg
Quoted 5 lines · On Mon, 2015-05-18 at 23:39 +0300, [email protected] wrote:

Commits a818292 "mac80211: convert rssi_callback() to event_callback()" and a940909 "mac80211: notify the driver about authentication status" added two errors and one warning when building docs for the mac80211 driver. Fix the kernel-doc comments so that the documentation targets could be built successfully again.

This was already fixed.

It's been one week and this is still broken in Linus's tree. There was a fix for some of the other warnings, but I don't see these errors fixed anywhere.

Ben.

Signature · 2 lines
Ben Hutchings
It is a miracle that curiosity survives formal education. - Albert Einstein
maintainer
#3 lore raw
Quoted 8 lines · Ben Hutchings
Quoted 7 lines · Johannes Berg
Quoted 5 lines · On Mon, 2015-05-18 at 23:39 +0300, [email protected] wrote:

Commits a818292 "mac80211: convert rssi_callback() to event_callback()" and a940909 "mac80211: notify the driver about authentication status" added two errors and one warning when building docs for the mac80211 driver. Fix the kernel-doc comments so that the documentation targets could be built successfully again.

Quoted 5 lines
Quoted 1 line

This was already fixed.

It's been one week and this is still broken in Linus's tree. There was a fix for some of the other warnings, but I don't see these errors fixed anywhere.

Yeah, somehow I put this into my -next pile... Given how late we are, I don't think I want to change that now though.

johannes

#4 lore raw
Quoted 9 lines · Johannes Berg
Quoted 8 lines · Ben Hutchings
Quoted 7 lines · Johannes Berg
Quoted 5 lines · On Mon, 2015-05-18 at 23:39 +0300, [email protected] wrote:

Commits a818292 "mac80211: convert rssi_callback() to event_callback()" and a940909 "mac80211: notify the driver about authentication status" added two errors and one warning when building docs for the mac80211 driver. Fix the kernel-doc comments so that the documentation targets could be built successfully again.

Quoted 8 lines
Quoted 5 lines
Quoted 1 line

This was already fixed.

It's been one week and this is still broken in Linus's tree. There was a fix for some of the other warnings, but I don't see these errors fixed anywhere.

Yeah, somehow I put this into my -next pile... Given how late we are, I don't think I want to change that now though.

It's a build failure so it should go upstream now.

I ran into this while packaging Linux 4.1 for Debian, and had to debug and fix it again, so that's now three people who have had to spend time on this.

Ben.

Signature · 2 lines
Ben Hutchings
It is a miracle that curiosity survives formal education. - Albert Einstein
maintainer
#5 lore raw
Quoted 1 line · Ben Hutchings

It's a build failure so it should go upstream now.

Ok, I was under the impression it's a warning.

I guess I'll just have to send a copy of the commit to 4.1 then - git will sort out getting it twice I suppose.

johannes

#6 lore raw
Quoted 4 lines · Johannes Berg
Quoted 1 line · Ben Hutchings

It's a build failure so it should go upstream now.

Quoted 8 lines

Ok, I was under the impression it's a warning.

I guess I'll just have to send a copy of the commit to 4.1 then - git will sort out getting it twice I suppose.

johannes

--

Still getting this build failure. Please get the fix merged soon.

Signature · 1 line
~Randy