Skip to contentSkip to conversation

bridge: fixes regarding the colorized output

PATCH Applied Gokul Sivakumar 2 participants 5 messages Aug 17, 2021 – Aug 18, 2021

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

v3 cover bridge: fixes regarding the colorized output

v3:
- Remove the unnecessary is_json_context() condition checks from patch 2/3 as the print_string() call is used with the argument PRINT_FP.

v2:
- Replace the 2 newly introduced fprintf() func calls with print_string() to address Stephen's suggestion.

For the bridge cmd, the "colorize output" cmd line option's usage and the corresponding output does not seem to be consistent with the usage and the output of the "ip" cmds.

Example 1: As per the "colorize output" cmd line option documented in the man pages man/man8/ip.8 & man/man8/bridge.8, using "-c" with "ip" or the "bridge" should colorize the output. But this is working only with the "ip" cmd and for the "bridge" cmd, the option "-col" / "-colo" / "-color" needs to be used instead of just "-c".

Example 2: After fixing the inconsistency mentioned in Example 1,
- Running the cmd "$ ip -c neigh", will give the following output where the "172.16.12.250", "bridge0" & "04:d9:f5:c1:0c:74" fields are highlighted and not the fixed keywords "dev" & "lladdr".

172.16.12.250 dev bridge0 lladdr 04:d9:f5:c1:0c:74 REACHABLE

- But running the cmd "$ bridge -c fdb", will give the following output where "00:00:00:00:00:00", "dev", "vxlan100", "dst" & "2001:db8:2::1" are highlighted, even though "dev" & "dst" keywords are static.

00:00:00:00:00:00 dev vxlan100 dst 2001:db8:2::1 self permanent

Also fix a typo in man/man8/bridge.8 to change "-c[lor]" into "-c[olor]".

Gokul Sivakumar (3):
bridge: reorder cmd line arg parsing to let "-c" detected as "color"
option
bridge: fdb: don't colorize the "dev" & "dst" keywords in "bridge -c
fdb"
man: bridge: fix the typo to change "-c[lor]" into "-c[olor]" in man
page

 bridge/bridge.c   |  2 +-
 bridge/fdb.c      | 11 ++++++++---
 man/man8/bridge.8 |  2 +-
 3 files changed, 10 insertions(+), 5 deletions(-)
Signature · 1 line
2.25.1
#1 lore raw

PATCH v3 1/3 bridge: reorder cmd line arg parsing to let "-c" detected as "color" option

As per the man/man8/bridge.8 page, the shorthand cmd line arg "-c" can be used to colorize the bridge cmd output. But while parsing the args in while loop, matches() detects "-c" as "-compressedvlans" instead of "-color", so fix this by doing the check for "-color" option first before checking for "-compressedvlans".

---
 bridge/bridge.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
bridge/bridge.c +1 -1
index f7bfe0b5..48b0e7f8 100644
@@ -149,9 +149,9 @@ main(int argc, char **argv)
 			NEXT_ARG();
 			if (netns_switch(argv[1]))
 				exit(-1);
+		} else if (matches_color(opt, &color)) {
 		} else if (matches(opt, "-compressvlans") == 0) {
 			++compress_vlans;
-		} else if (matches_color(opt, &color)) {
 		} else if (matches(opt, "-force") == 0) {
 			++force;
 		} else if (matches(opt, "-json") == 0) {
Signature · 1 line
2.25.1
#2 lore raw

PATCH v3 2/3 bridge: fdb: don't colorize the "dev" & "dst" keywords in "bridge -c fdb"

In reply to Gokul Sivakumar

To be consistent with the colorized output of "ip" command and to increase readability, stop highlighting the "dev" & "dst" keywords in the colorized output of "bridge -c fdb" cmd.

Example: in the following "bridge -c fdb" entry, only "00:00:00:00:00:00", "vxlan100" and "2001:db8:2::1" fields should be highlighted in color.

00:00:00:00:00:00 dev vxlan100 dst 2001:db8:2::1 self permanent

---
 bridge/fdb.c | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)
bridge/fdb.c +8 -3
index 37465e46..8912f092 100644
@@ -192,10 +192,13 @@ int print_fdb(struct nlmsghdr *n, void *arg)
 				   "mac", "%s ", lladdr);
 	}
 
-	if (!filter_index && r->ndm_ifindex)
+	if (!filter_index && r->ndm_ifindex) {
+		print_string(PRINT_FP, NULL, "dev ", NULL);
+
 		print_color_string(PRINT_ANY, COLOR_IFNAME,
-				   "ifname", "dev %s ",
+				   "ifname", "%s ",
 				   ll_index_to_name(r->ndm_ifindex));
+	}
 
 	if (tb[NDA_DST]) {
 		int family = AF_INET;
@@ -208,9 +211,11 @@ int print_fdb(struct nlmsghdr *n, void *arg)
 				  RTA_PAYLOAD(tb[NDA_DST]),
 				  RTA_DATA(tb[NDA_DST]));
 
+		print_string(PRINT_FP, NULL, "dst ", NULL);
+
 		print_color_string(PRINT_ANY,
 				   ifa_family_color(family),
-				    "dst", "dst %s ", dst);
+				   "dst", "%s ", dst);
 	}
 
 	if (vid)
Signature · 1 line
2.25.1
#3 lore raw

PATCH v3 3/3 man: bridge: fix the typo to change "-c[lor]" into "-c[olor]" in man page

In reply to Gokul Sivakumar
Fixes 3a1ca9a5b ("bridge: update man page for new color and json changes")
---
 man/man8/bridge.8 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
man/man8/bridge.8 +1 -1
index eec7df43..db83a2a6 100644
@@ -22,7 +22,7 @@ bridge \- show / manipulate bridge addresses and devices
 \fB\-s\fR[\fItatistics\fR] |
 \fB\-n\fR[\fIetns\fR] name |
 \fB\-b\fR[\fIatch\fR] filename |
-\fB\-c\fR[\folor\fR] |
+\fB\-c\fR[\fIolor\fR] |
 \fB\-p\fR[\fIretty\fR] |
 \fB\-j\fR[\fIson\fR] |
 \fB\-o\fR[\fIneline\fr] }
Signature · 1 line
2.25.1
#4 lore raw
In reply to Gokul Sivakumar
This series was applied to iproute2/iproute2.git (refs/heads/main):

Hello:

This series was applied to iproute2/iproute2.git (refs/heads/main):

Quoted 9 lines · On Tue, 17 Aug 2021 22:58:04 +0530 you wrote:

v3:
- Remove the unnecessary is_json_context() condition checks from patch 2/3 as the print_string() call is used with the argument PRINT_FP.

v2:
- Replace the 2 newly introduced fprintf() func calls with print_string() to address Stephen's suggestion.

[...]

Here is the summary with links:
- [iproute2,v3,1/3] bridge: reorder cmd line arg parsing to let "-c" detected as "color" option

    https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/commit/?id=82149efee939
  - [iproute2,v3,2/3] bridge: fdb: don't colorize the "dev" & "dst" keywords in "bridge -c fdb"
    https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/commit/?id=057d3c6d378b
  - [iproute2,v3,3/3] man: bridge: fix the typo to change "-c[lor]" into "-c[olor]" in man page
    https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/commit/?id=10ecd126900b

You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html