From f3902ca423b080cec2170985bd1626e590723893 Mon Sep 17 00:00:00 2001 From: Dan Williams Date: Tue, 24 Mar 2015 12:18:48 -0500 Subject: [PATCH] platform: update code documentation for nm_platform_link_get_physical_port_id() --- src/platform/nm-platform.c | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/platform/nm-platform.c b/src/platform/nm-platform.c index ffa21d2a94..20f5149c8b 100644 --- a/src/platform/nm-platform.c +++ b/src/platform/nm-platform.c @@ -963,9 +963,15 @@ nm_platform_link_get_mtu (int ifindex) } /** - * nm_platform_link_get_mtu: + * nm_platform_link_get_physical_port_id: * @ifindex: Interface index * + * The physical port ID, if present, indicates some unique identifier of + * the parent interface (eg, the physical port of which this link is a child). + * Two links that report the same physical port ID can be assumed to be + * children of the same physical port and may share resources that limit + * their abilities. + * * Returns: physical port ID for the interface, or %NULL on error * or if the interface has no physical port ID. */