diff mbox

mac80211: fix kernel-doc comments in mac80211.h

Message ID 555a4e12.e323700a.26a6.ffff9e65@mx.google.com (mailing list archive)
State Not Applicable
Delegated to: Johannes Berg
Headers show

Commit Message

Andrey Konovalov May 18, 2015, 8:39 p.m. UTC
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 <andrey.konovalov@linaro.org>
---
 include/net/mac80211.h |    6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Johannes Berg May 20, 2015, 1:03 p.m. UTC | #1
On Mon, 2015-05-18 at 23:39 +0300, andrey.konovalov@linaro.org 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

--
To unsubscribe from this list: send the line "unsubscribe linux-wireless" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Ben Hutchings May 27, 2015, 11:30 p.m. UTC | #2
On Wed, 2015-05-20 at 15:03 +0200, Johannes Berg wrote:
> On Mon, 2015-05-18 at 23:39 +0300, andrey.konovalov@linaro.org 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.
Johannes Berg May 28, 2015, 7 a.m. UTC | #3
On Thu, 2015-05-28 at 00:30 +0100, Ben Hutchings wrote:
> On Wed, 2015-05-20 at 15:03 +0200, Johannes Berg wrote:
> > On Mon, 2015-05-18 at 23:39 +0300, andrey.konovalov@linaro.org 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.

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

--
To unsubscribe from this list: send the line "unsubscribe linux-wireless" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Ben Hutchings May 28, 2015, 12:34 p.m. UTC | #4
On Thu, 2015-05-28 at 09:00 +0200, Johannes Berg wrote:
> On Thu, 2015-05-28 at 00:30 +0100, Ben Hutchings wrote:
> > On Wed, 2015-05-20 at 15:03 +0200, Johannes Berg wrote:
> > > On Mon, 2015-05-18 at 23:39 +0300, andrey.konovalov@linaro.org 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.
> 
> 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.
Johannes Berg May 28, 2015, 12:36 p.m. UTC | #5
On Thu, 2015-05-28 at 13:34 +0100, Ben Hutchings wrote:

> 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

--
To unsubscribe from this list: send the line "unsubscribe linux-wireless" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Randy Dunlap June 1, 2015, 2:51 a.m. UTC | #6
On 05/28/15 05:36, Johannes Berg wrote:
> On Thu, 2015-05-28 at 13:34 +0100, Ben Hutchings wrote:
> 
>> 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
> 
> --

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

Patch

diff --git a/include/net/mac80211.h b/include/net/mac80211.h
index b4bef11..dbb5f33 100644
--- a/include/net/mac80211.h
+++ b/include/net/mac80211.h
@@ -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
  */