summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas Haller <thaller@redhat.com>2020-06-29 12:40:26 +0200
committerThomas Haller <thaller@redhat.com>2020-06-29 12:41:15 +0200
commit688695d12d3237bbde0612a8393288aedc86ca55 (patch)
tree1f3834a9598e979e7a81f3ca35c2890484277f3a
parent0b63097801583089874536fcd6b19450e06d0ce3 (diff)
downloadNetworkManager-th/ifcfg-bridge-writer.tar.gz
libnm/doc: clarify values for "bridge.multicast-router"th/ifcfg-bridge-writer
Kernel (sysfs) and iproute2 only use numbers for the multicast_router option. It's confusing that we name the options differently. Anyway, that cannot be changed anymore. Clarify the meanings in the documentation. https://bugzilla.redhat.com/show_bug.cgi?id=1845608
-rw-r--r--clients/common/settings-docs.h.in2
-rw-r--r--libnm-core/nm-setting-bridge.c5
2 files changed, 4 insertions, 3 deletions
diff --git a/clients/common/settings-docs.h.in b/clients/common/settings-docs.h.in
index 7b891500d8..526341a401 100644
--- a/clients/common/settings-docs.h.in
+++ b/clients/common/settings-docs.h.in
@@ -128,7 +128,7 @@
#define DESCRIBE_DOC_NM_SETTING_BRIDGE_MULTICAST_QUERY_INTERVAL N_("Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.")
#define DESCRIBE_DOC_NM_SETTING_BRIDGE_MULTICAST_QUERY_RESPONSE_INTERVAL N_("Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.")
#define DESCRIBE_DOC_NM_SETTING_BRIDGE_MULTICAST_QUERY_USE_IFADDR N_("If enabled the bridge's own IP address is used as the source address for IGMP queries otherwise the default of 0.0.0.0 is used.")
-#define DESCRIBE_DOC_NM_SETTING_BRIDGE_MULTICAST_ROUTER N_("Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work. Supported values are: 'auto', 'disabled', 'enabled'. If not specified the default value is 'auto'.")
+#define DESCRIBE_DOC_NM_SETTING_BRIDGE_MULTICAST_ROUTER N_("Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work. Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).")
#define DESCRIBE_DOC_NM_SETTING_BRIDGE_MULTICAST_SNOOPING N_("Controls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved.")
#define DESCRIBE_DOC_NM_SETTING_BRIDGE_MULTICAST_STARTUP_QUERY_COUNT N_("Set the number of IGMP queries to send during startup phase.")
#define DESCRIBE_DOC_NM_SETTING_BRIDGE_MULTICAST_STARTUP_QUERY_INTERVAL N_("Sets the time (in deciseconds) between queries sent out at startup to determine membership information.")
diff --git a/libnm-core/nm-setting-bridge.c b/libnm-core/nm-setting-bridge.c
index 0595af8730..02ad4f010c 100644
--- a/libnm-core/nm-setting-bridge.c
+++ b/libnm-core/nm-setting-bridge.c
@@ -1973,8 +1973,9 @@ nm_setting_bridge_class_init (NMSettingBridgeClass *klass)
* Sets bridge's multicast router. Multicast-snooping must be enabled
* for this option to work.
*
- * Supported values are: 'auto', 'disabled', 'enabled'.
- * If not specified the default value is 'auto'.
+ * Supported values are: 'auto', 'disabled', 'enabled' to which kernel
+ * assigns the numbers 1, 0, and 2, respectively.
+ * If not specified the default value is 'auto' (1).
**/
/* ---ifcfg-rh---
* property: multicast-router