Skip to contentSkip to conversation

net: remove newlines in NL_SET_ERR_MSG_MOD

PATCH Applied Jacob Keller 2 participants 2 messages May 7, 2020 – May 8, 2020

Subsystems (8)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 net: remove newlines in NL_SET_ERR_MSG_MOD

The NL_SET_ERR_MSG_MOD macro is used to report a string describing an error message to userspace via the netlink extended ACK structure. It should not have a trailing newline.

Add a cocci script which catches cases where the newline marker is present. Using this script, fix the handful of cases which accidentally included a trailing new line.

I couldn't figure out a way to get a patch mode working, so this script only implements context, report, and org.

Cc Jakub Kicinski <[email protected]>
Cc Andy Whitcroft <[email protected]>
Cc Joe Perches <[email protected]>
---
 .../net/ethernet/mellanox/mlx5/core/en_tc.c   |  2 +-
 drivers/net/ethernet/mscc/ocelot_tc.c         |  6 +-
 net/bridge/br_mrp_netlink.c                   |  2 +-
 net/bridge/br_stp_if.c                        |  2 +-
 net/dsa/slave.c                               |  6 +-
 .../coccinelle/misc/newline_in_nl_msg.cocci   | 75 +++++++++++++++++++
 6 files changed, 84 insertions(+), 9 deletions(-)
 create mode 100644 scripts/coccinelle/misc/newline_in_nl_msg.cocci
drivers/net/ethernet/mellanox/mlx5/core/en_tc.c +1 -1
index 77397aa66810..a050808f2128 100644
@@ -1097,7 +1097,7 @@ mlx5e_tc_add_nic_flow(struct mlx5e_priv *priv,
 		if (IS_ERR(priv->fs.tc.t)) {
 			mutex_unlock(&priv->fs.tc.t_lock);
 			NL_SET_ERR_MSG_MOD(extack,
-					   "Failed to create tc offload table\n");
+					   "Failed to create tc offload table");
 			netdev_err(priv->netdev,
 				   "Failed to create tc offload table\n");
 			return PTR_ERR(priv->fs.tc.t);
drivers/net/ethernet/mscc/ocelot_tc.c +3 -3
index d326e231f0ad..b7baf7624e18 100644
@@ -48,7 +48,7 @@ static int ocelot_setup_tc_cls_matchall(struct ocelot_port_private *priv,
 
 		if (priv->tc.police_id && priv->tc.police_id != f->cookie) {
 			NL_SET_ERR_MSG_MOD(extack,
-					   "Only one policer per port is supported\n");
+					   "Only one policer per port is supported");
 			return -EEXIST;
 		}
 
@@ -59,7 +59,7 @@ static int ocelot_setup_tc_cls_matchall(struct ocelot_port_private *priv,
 
 		err = ocelot_port_policer_add(ocelot, port, &pol);
 		if (err) {
-			NL_SET_ERR_MSG_MOD(extack, "Could not add policer\n");
+			NL_SET_ERR_MSG_MOD(extack, "Could not add policer");
 			return err;
 		}
 
@@ -73,7 +73,7 @@ static int ocelot_setup_tc_cls_matchall(struct ocelot_port_private *priv,
 		err = ocelot_port_policer_del(ocelot, port);
 		if (err) {
 			NL_SET_ERR_MSG_MOD(extack,
-					   "Could not delete policer\n");
+					   "Could not delete policer");
 			return err;
 		}
 		priv->tc.police_id = 0;
net/bridge/br_mrp_netlink.c +1 -1
index 503896638be0..397e7f710772 100644
@@ -28,7 +28,7 @@ int br_mrp_parse(struct net_bridge *br, struct net_bridge_port *p,
 	int err;
 
 	if (br->stp_enabled != BR_NO_STP) {
-		NL_SET_ERR_MSG_MOD(extack, "MRP can't be enabled if STP is already enabled\n");
+		NL_SET_ERR_MSG_MOD(extack, "MRP can't be enabled if STP is already enabled");
 		return -EINVAL;
 	}
 
net/bridge/br_stp_if.c +1 -1
index a42850b7eb9a..ba55851fe132 100644
@@ -203,7 +203,7 @@ int br_stp_set_enabled(struct net_bridge *br, unsigned long val,
 
 	if (br_mrp_enabled(br)) {
 		NL_SET_ERR_MSG_MOD(extack,
-				   "STP can't be enabled if MRP is already enabled\n");
+				   "STP can't be enabled if MRP is already enabled");
 		return -EINVAL;
 	}
 
net/dsa/slave.c +3 -3
index fa2634043751..8c93f52e2449 100644
@@ -913,13 +913,13 @@ dsa_slave_add_cls_matchall_police(struct net_device *dev,
 
 	if (!ds->ops->port_policer_add) {
 		NL_SET_ERR_MSG_MOD(extack,
-				   "Policing offload not implemented\n");
+				   "Policing offload not implemented");
 		return -EOPNOTSUPP;
 	}
 
 	if (!ingress) {
 		NL_SET_ERR_MSG_MOD(extack,
-				   "Only supported on ingress qdisc\n");
+				   "Only supported on ingress qdisc");
 		return -EOPNOTSUPP;
 	}
 
@@ -930,7 +930,7 @@ dsa_slave_add_cls_matchall_police(struct net_device *dev,
 	list_for_each_entry(mall_tc_entry, &p->mall_tc_list, list) {
 		if (mall_tc_entry->type == DSA_PORT_MALL_POLICER) {
 			NL_SET_ERR_MSG_MOD(extack,
-					   "Only one port policer allowed\n");
+					   "Only one port policer allowed");
 			return -EEXIST;
 		}
 	}
scripts/coccinelle/misc/newline_in_nl_msg.cocci new file +75 -0

75 lines not on this page · raw message

Signature · 1 line
2.25.2
maintainer Applied
#1 lore raw

From: Jacob Keller <[email protected]>
Date: Wed, 6 May 2020 17:58:27 -0700

Quoted 4 lines

The NL_SET_ERR_MSG_MOD macro is used to report a string describing an error message to userspace via the netlink extended ACK structure. It should not have a trailing newline.

Quoted 8 lines

Add a cocci script which catches cases where the newline marker is present. Using this script, fix the handful of cases which accidentally included a trailing new line.

I couldn't figure out a way to get a patch mode working, so this script only implements context, report, and org.

Applied, thank you.