cfg80211: Fix documentation for connect result
authorJouni Malinen <jouni@qca.qualcomm.com>
Thu, 12 Jan 2017 23:12:22 +0000 (01:12 +0200)
committerJohannes Berg <johannes.berg@intel.com>
Fri, 13 Jan 2017 08:47:08 +0000 (09:47 +0100)
commitc88215d7050f065afaed33e9599c2ef4e5e6ee22
treee71c0d4de5864b104c36ebba31c872077d69c957
parent3093ebbeabcdddc9a982950052f2151df43c7aa2
cfg80211: Fix documentation for connect result

The function documentation for cfg80211_connect_bss() and
cfg80211_connect_result() was still claiming that they are used only for
a success case while these functions can now be used to report both
success and various failure cases. The actual use cases were already
described in the connect() documentation.

Update the function specific comments to note the failure cases and also
describe how the special status == -1 case is used in
cfg80211_connect_bss() to indicate a connection timeout based on the
internal implementation in cfg80211_connect_timeout().

Signed-off-by: Jouni Malinen <jouni@qca.qualcomm.com>
[use tabs for indentation]
Signed-off-by: Johannes Berg <johannes.berg@intel.com>
include/net/cfg80211.h