From aed6e28461955ac0428bd1b61e27247eb6b986a7 Mon Sep 17 00:00:00 2001 From: Thomas Haller Date: Tue, 23 Jan 2018 12:24:29 +0100 Subject: [PATCH] trivial: avoid XXX tag and replace by NOTE or FIXME XXX was used to either raise attention (NOTE) or to indicate that this is ugly code that should be fixed (FIXME). The usage was inconsistent. Let's avoid XXX and use either NOTE or FIXME. --- configure.ac | 2 +- libnm-core/nm-setting-vpn.c | 2 +- libnm/nm-object.c | 5 +++-- meson.build | 2 +- src/devices/nm-device-infiniband.c | 2 +- src/devices/nm-device-ip-tunnel.c | 6 +++--- src/devices/nm-device.c | 2 +- src/nm-policy.c | 2 +- src/platform/nm-platform.h | 2 +- src/settings/nm-settings-connection.c | 2 +- src/settings/plugins/ifcfg-rh/nms-ifcfg-rh-reader.c | 2 +- 11 files changed, 15 insertions(+), 14 deletions(-) diff --git a/configure.ac b/configure.ac index d594c6b64e..dd0921725c 100644 --- a/configure.ac +++ b/configure.ac @@ -2,7 +2,7 @@ AC_PREREQ([2.63]) dnl The NM version number dnl -dnl XXX: When incrementing version also: +dnl NOTE: When incrementing version also: dnl - add corresponding NM_VERSION_x_y_z macros in dnl "shared/nm-version-macros.h.in" dnl - update number in meson.build diff --git a/libnm-core/nm-setting-vpn.c b/libnm-core/nm-setting-vpn.c index a733f24dcc..b25a43e3aa 100644 --- a/libnm-core/nm-setting-vpn.c +++ b/libnm-core/nm-setting-vpn.c @@ -302,7 +302,7 @@ foreach_item_helper (NMSettingVpn *self, const char *value; value = g_hash_table_lookup (hash, keys[i]); - /* XXX: note that we call the function with a clone of @key, + /* NOTE: note that we call the function with a clone of @key, * not with the actual key from the dictionary. * * The @value on the other hand, is actually inside our dictionary, diff --git a/libnm/nm-object.c b/libnm/nm-object.c index 758f06bb9d..4fa9b7bd33 100644 --- a/libnm/nm-object.c +++ b/libnm/nm-object.c @@ -608,8 +608,9 @@ handle_object_property (NMObject *self, const char *property_name, GVariant *val object = g_dbus_object_manager_get_object (priv->object_manager, path); if (!object) { /* This is a server bug -- a dangling object path for an object - * that does not exist. */ - /* XXX: We've ignored this before and the server hits the condition + * that does not exist. + * + * NOTE: We've ignored this before and the server hits the condition * more often that it should. Given we're able to recover from * ther error, let's lower the severity of the log message to * avoid unnecessarily bothering the user. This can be removed diff --git a/meson.build b/meson.build index 9786288a44..cd9f83a3ba 100644 --- a/meson.build +++ b/meson.build @@ -1,6 +1,6 @@ project( 'NetworkManager', 'c', -# XXX: When incrementing version also: +# NOTE: When incrementing version also: # - add corresponding NM_VERSION_x_y_z macros in # "shared/nm-version-macros.h.in" # - update number in configure.ac diff --git a/src/devices/nm-device-infiniband.c b/src/devices/nm-device-infiniband.c index 09ad2855b4..91188d1632 100644 --- a/src/devices/nm-device-infiniband.c +++ b/src/devices/nm-device-infiniband.c @@ -433,7 +433,7 @@ create_device (NMDeviceFactory *factory, NM_DEVICE_TYPE_DESC, "InfiniBand", NM_DEVICE_DEVICE_TYPE, NM_DEVICE_TYPE_INFINIBAND, NM_DEVICE_LINK_TYPE, NM_LINK_TYPE_INFINIBAND, - /* XXX: Partition should probably be a different link type! */ + /* NOTE: Partition should probably be a different link type! */ NM_DEVICE_INFINIBAND_IS_PARTITION, is_partition, NULL); } diff --git a/src/devices/nm-device-ip-tunnel.c b/src/devices/nm-device-ip-tunnel.c index 24ee62c3bc..4b31ad704f 100644 --- a/src/devices/nm-device-ip-tunnel.c +++ b/src/devices/nm-device-ip-tunnel.c @@ -98,9 +98,9 @@ ip6tnl_flags_setting_to_plat (NMIPTunnelFlags flags) G_STATIC_ASSERT (NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY == IP6_TNL_F_RCV_DSCP_COPY); G_STATIC_ASSERT (NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK == IP6_TNL_F_USE_ORIG_FWMARK); - /* XXX: "accidentally", the numeric values correspond. - * For flags added in the future, that might no longer - * be the case. */ + /* NOTE: "accidentally", the numeric values correspond. + * For flags added in the future, that might no longer + * be the case. */ return flags & _NM_IP_TUNNEL_FLAG_ALL_IP6TNL; } diff --git a/src/devices/nm-device.c b/src/devices/nm-device.c index b1e9fee329..899e15fe90 100644 --- a/src/devices/nm-device.c +++ b/src/devices/nm-device.c @@ -7906,7 +7906,7 @@ addrconf6_start_with_link_ready (NMDevice *self) g_clear_object (&priv->con_ip6_config); } - /* XXX: These sysctls would probably be better set by the lndp ndisc itself. */ + /* FIXME: These sysctls would probably be better set by the lndp ndisc itself. */ switch (nm_ndisc_get_node_type (priv->ndisc)) { case NM_NDISC_NODE_TYPE_HOST: /* Accepting prefixes from discovered routers. */ diff --git a/src/nm-policy.c b/src/nm-policy.c index 3f1516a823..abdf740dfa 100644 --- a/src/nm-policy.c +++ b/src/nm-policy.c @@ -418,7 +418,7 @@ get_best_ip_device (NMPolicy *self, r = nm_device_get_best_default_route (device, addr_family); if (r) { - /* XXX: the best route might have rt_source NM_IP_CONFIG_SOURCE_VPN, + /* NOTE: the best route might have rt_source NM_IP_CONFIG_SOURCE_VPN, * which means it was injected by a VPN, not added by device. * * In this case, is it really the best device? Why do we even need the best diff --git a/src/platform/nm-platform.h b/src/platform/nm-platform.h index 34b1d8c0a1..1f4230c6c4 100644 --- a/src/platform/nm-platform.h +++ b/src/platform/nm-platform.h @@ -406,7 +406,7 @@ typedef union { * do not exist from the point-of-view of platform users. * Such a route is not alive, according to nmp_object_is_alive(). * - * XXX: currently we ignore all flags except RTM_F_CLONED + * NOTE: currently we ignore all flags except RTM_F_CLONED * and RTNH_F_ONLINK for IPv4. * We also may not properly consider the flags as part of the ID * in route-cmp. */ \ diff --git a/src/settings/nm-settings-connection.c b/src/settings/nm-settings-connection.c index a6de6cf8c1..4dfb602aa2 100644 --- a/src/settings/nm-settings-connection.c +++ b/src/settings/nm-settings-connection.c @@ -2685,7 +2685,7 @@ _autoconnect_retries_set (NMSettingsConnection *self, if (retries) priv->autoconnect_retries_blocked_until = 0; else { - /* XXX: the blocked time must be identical for all connections, otherwise + /* NOTE: the blocked time must be identical for all connections, otherwise * the tracking of resetting the retry count in NMPolicy needs adjustment * in _connection_autoconnect_retries_set() (as it would need to re-evaluate * the next-timeout everytime a connection gets blocked). */ diff --git a/src/settings/plugins/ifcfg-rh/nms-ifcfg-rh-reader.c b/src/settings/plugins/ifcfg-rh/nms-ifcfg-rh-reader.c index d5f3f265af..6b85e6e379 100644 --- a/src/settings/plugins/ifcfg-rh/nms-ifcfg-rh-reader.c +++ b/src/settings/plugins/ifcfg-rh/nms-ifcfg-rh-reader.c @@ -934,7 +934,7 @@ next: : "")); break; case PARSE_LINE_TYPE_FLAG: - /* XXX: the flag (for "onlink") only allows to explictly set "TRUE". + /* NOTE: the flag (for "onlink") only allows to explictly set "TRUE". * There is no way to express an explicit "FALSE" setting * of this attribute, hence, the file format cannot encode * that configuration. */