diff mbox series

dbus: document more possible BSS/RSA/KeyMgmt values

Message ID 20190123093848.19146-1-lkundrak@v3.sk
State Accepted
Headers show
Series dbus: document more possible BSS/RSA/KeyMgmt values | expand

Commit Message

Lubomir Rintel Jan. 23, 2019, 9:38 a.m. UTC 
This is probably not ideal, since it would be better if it ended up being
autogenerated somehow, but at least it's somewhat of an improvement.

Also added a comment that encourages keeping the docs in sync.

Signed-off-by: Lubomir Rintel <lkundrak@v3.sk>
---
 doc/dbus.doxygen                        | 2 +-
 wpa_supplicant/dbus/dbus_new_handlers.c | 7 ++++++-
 2 files changed, 7 insertions(+), 2 deletions(-)

Comments

Jouni Malinen Jan. 23, 2019, 11:39 p.m. UTC | #1 
On Wed, Jan 23, 2019 at 10:38:49AM +0100, Lubomir Rintel wrote:
> This is probably not ideal, since it would be better if it ended up being
> autogenerated somehow, but at least it's somewhat of an improvement.
> 
> Also added a comment that encourages keeping the docs in sync.

Thanks, applied.
diff mbox series

Patch

diff --git a/doc/dbus.doxygen b/doc/dbus.doxygen
index 87898e411..072ed3486 100644
--- a/doc/dbus.doxygen
+++ b/doc/dbus.doxygen
@@ -2028,7 +2028,7 @@  scan results.
 	<h3>RSN - a{sv} - (read)</h3>
 	<p>RSN information of the BSS. Empty dictionary indicates no RSN support. Dictionary entries are:</p>
 	<table>
-	  <tr><td>KeyMgmt</td><td>as</td><td>Key management suite. Possible array elements: "wpa-psk", "wpa-eap", "wpa-ft-psk", "wpa-ft-eap", "wpa-psk-sha256", "wpa-eap-sha256",</td>
+	  <tr><td>KeyMgmt</td><td>as</td><td>Key management suite. Possible array elements: "wpa-psk", "wpa-ft-psk", "wpa-psk-sha256", "wpa-eap", "wpa-ft-eap", "wpa-eap-sha256", "wpa-eap-suite-b", "wpa-eap-suite-b-192", "wpa-fils-sha256", "wpa-fils-sha384", "wpa-ft-fils-sha256", "wpa-ft-fils-sha384", "sae", "ft-sae", "wpa-none"</td>
 	  <tr><td>Pairwise</td><td>as</td><td>Pairwise cipher suites. Possible array elements: "ccmp", "tkip"</td>
 	  <tr><td>Group</td><td>s</td><td>Group cipher suite. Possible values are: "ccmp", "tkip", "wep104", "wep40"</td>
 	  <tr><td>MgmtGroup</td><td>s</td><td>Mangement frames cipher suite. Possible values are: "aes128cmac"</td>
diff --git a/wpa_supplicant/dbus/dbus_new_handlers.c b/wpa_supplicant/dbus/dbus_new_handlers.c
index d64b9105b..642e57f46 100644
--- a/wpa_supplicant/dbus/dbus_new_handlers.c
+++ b/wpa_supplicant/dbus/dbus_new_handlers.c
@@ -4507,7 +4507,12 @@  static dbus_bool_t wpas_dbus_get_bss_security_prop(
 	if (!wpa_dbus_dict_open_write(&variant_iter, &iter_dict))
 		goto nomem;
 
-	/* KeyMgmt */
+	/*
+	 * KeyMgmt
+	 *
+	 * When ading a new entry here, please take care to extend the
+	 * key_mgmt and keep documentation in doc/dbus.doxygen up to date.
+	 */
 	n = 0;
 	if (ie_data->key_mgmt & WPA_KEY_MGMT_PSK)
 		key_mgmt[n++] = "wpa-psk";