diff mbox series

[iproute2] iplink_can: print_usage: typo fix, add missing spaces

Message ID 20220212132727.3710-1-mailhol.vincent@wanadoo.fr (mailing list archive)
State Accepted
Delegated to: Stephen Hemminger
Headers show
Series [iproute2] iplink_can: print_usage: typo fix, add missing spaces | expand

Checks

Context Check Description
netdev/tree_selection success Not a local patch

Commit Message

Vincent Mailhol Feb. 12, 2022, 1:27 p.m. UTC
The can help menu misses three spaces for the TDCV, TDCO and TDCF
parameters, making the closing curly bracket unaligned.

For reference, before this patch:

| $ ip link help can
| Usage: ip link set DEVICE type can
| 	[ bitrate BITRATE [ sample-point SAMPLE-POINT] ] |
| 	[ tq TQ prop-seg PROP_SEG phase-seg1 PHASE-SEG1
|  	  phase-seg2 PHASE-SEG2 [ sjw SJW ] ]
|
| 	[ dbitrate BITRATE [ dsample-point SAMPLE-POINT] ] |
| 	[ dtq TQ dprop-seg PROP_SEG dphase-seg1 PHASE-SEG1
|  	  dphase-seg2 PHASE-SEG2 [ dsjw SJW ] ]
| 	[ tdcv TDCV tdco TDCO tdcf TDCF ]
|
| 	[ loopback { on | off } ]
| 	[ listen-only { on | off } ]
| 	[ triple-sampling { on | off } ]
| 	[ one-shot { on | off } ]
| 	[ berr-reporting { on | off } ]
| 	[ fd { on | off } ]
| 	[ fd-non-iso { on | off } ]
| 	[ presume-ack { on | off } ]
| 	[ cc-len8-dlc { on | off } ]
| 	[ tdc-mode { auto | manual | off } ]
|
| 	[ restart-ms TIME-MS ]
| 	[ restart ]
|
| 	[ termination { 0..65535 } ]
|
| 	Where: BITRATE	:= { NUMBER in bps }
| 		  SAMPLE-POINT	:= { 0.000..0.999 }
| 		  TQ		:= { NUMBER in ns }
| 		  PROP-SEG	:= { NUMBER in tq }
| 		  PHASE-SEG1	:= { NUMBER in tq }
| 		  PHASE-SEG2	:= { NUMBER in tq }
| 		  SJW		:= { NUMBER in tq }
| 		  TDCV		:= { NUMBER in tc}
| 		  TDCO		:= { NUMBER in tc}
| 		  TDCF		:= { NUMBER in tc}
| 		  RESTART-MS	:= { 0 | NUMBER in ms }

... and after this patch:

| $ ip link help can
| Usage: ip link set DEVICE type can
| 	[ bitrate BITRATE [ sample-point SAMPLE-POINT] ] |
| 	[ tq TQ prop-seg PROP_SEG phase-seg1 PHASE-SEG1
|  	  phase-seg2 PHASE-SEG2 [ sjw SJW ] ]
|
| 	[ dbitrate BITRATE [ dsample-point SAMPLE-POINT] ] |
| 	[ dtq TQ dprop-seg PROP_SEG dphase-seg1 PHASE-SEG1
|  	  dphase-seg2 PHASE-SEG2 [ dsjw SJW ] ]
| 	[ tdcv TDCV tdco TDCO tdcf TDCF ]
|
| 	[ loopback { on | off } ]
| 	[ listen-only { on | off } ]
| 	[ triple-sampling { on | off } ]
| 	[ one-shot { on | off } ]
| 	[ berr-reporting { on | off } ]
| 	[ fd { on | off } ]
| 	[ fd-non-iso { on | off } ]
| 	[ presume-ack { on | off } ]
| 	[ cc-len8-dlc { on | off } ]
| 	[ tdc-mode { auto | manual | off } ]
|
| 	[ restart-ms TIME-MS ]
| 	[ restart ]
|
| 	[ termination { 0..65535 } ]
|
| 	Where: BITRATE	:= { NUMBER in bps }
| 		  SAMPLE-POINT	:= { 0.000..0.999 }
| 		  TQ		:= { NUMBER in ns }
| 		  PROP-SEG	:= { NUMBER in tq }
| 		  PHASE-SEG1	:= { NUMBER in tq }
| 		  PHASE-SEG2	:= { NUMBER in tq }
| 		  SJW		:= { NUMBER in tq }
| 		  TDCV		:= { NUMBER in tc }
| 		  TDCO		:= { NUMBER in tc }
| 		  TDCF		:= { NUMBER in tc }
| 		  RESTART-MS	:= { 0 | NUMBER in ms }

Fixes: 0c263d7c36ff ("iplink_can: add new CAN FD bittiming parameters:
Transmitter Delay Compensat ion (TDC)")
Signed-off-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>
---
 ip/iplink_can.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Marc Kleine-Budde Feb. 12, 2022, 4:04 p.m. UTC | #1
On 12.02.2022 22:27:27, Vincent Mailhol wrote:
> The can help menu misses three spaces for the TDCV, TDCO and TDCF
> parameters, making the closing curly bracket unaligned.
> 
> For reference, before this patch:
> 
> | $ ip link help can
> | Usage: ip link set DEVICE type can
> | 	[ bitrate BITRATE [ sample-point SAMPLE-POINT] ] |
> | 	[ tq TQ prop-seg PROP_SEG phase-seg1 PHASE-SEG1
> |  	  phase-seg2 PHASE-SEG2 [ sjw SJW ] ]
> |
> | 	[ dbitrate BITRATE [ dsample-point SAMPLE-POINT] ] |
> | 	[ dtq TQ dprop-seg PROP_SEG dphase-seg1 PHASE-SEG1
> |  	  dphase-seg2 PHASE-SEG2 [ dsjw SJW ] ]
> | 	[ tdcv TDCV tdco TDCO tdcf TDCF ]
> |
> | 	[ loopback { on | off } ]
> | 	[ listen-only { on | off } ]
> | 	[ triple-sampling { on | off } ]
> | 	[ one-shot { on | off } ]
> | 	[ berr-reporting { on | off } ]
> | 	[ fd { on | off } ]
> | 	[ fd-non-iso { on | off } ]
> | 	[ presume-ack { on | off } ]
> | 	[ cc-len8-dlc { on | off } ]
> | 	[ tdc-mode { auto | manual | off } ]
> |
> | 	[ restart-ms TIME-MS ]
> | 	[ restart ]
> |
> | 	[ termination { 0..65535 } ]
> |
> | 	Where: BITRATE	:= { NUMBER in bps }
> | 		  SAMPLE-POINT	:= { 0.000..0.999 }
> | 		  TQ		:= { NUMBER in ns }
> | 		  PROP-SEG	:= { NUMBER in tq }
> | 		  PHASE-SEG1	:= { NUMBER in tq }
> | 		  PHASE-SEG2	:= { NUMBER in tq }
> | 		  SJW		:= { NUMBER in tq }
> | 		  TDCV		:= { NUMBER in tc}
> | 		  TDCO		:= { NUMBER in tc}
> | 		  TDCF		:= { NUMBER in tc}
> | 		  RESTART-MS	:= { 0 | NUMBER in ms }
> 
> ... and after this patch:
> 
> | $ ip link help can
> | Usage: ip link set DEVICE type can
> | 	[ bitrate BITRATE [ sample-point SAMPLE-POINT] ] |
> | 	[ tq TQ prop-seg PROP_SEG phase-seg1 PHASE-SEG1
> |  	  phase-seg2 PHASE-SEG2 [ sjw SJW ] ]
> |
> | 	[ dbitrate BITRATE [ dsample-point SAMPLE-POINT] ] |
> | 	[ dtq TQ dprop-seg PROP_SEG dphase-seg1 PHASE-SEG1
> |  	  dphase-seg2 PHASE-SEG2 [ dsjw SJW ] ]
> | 	[ tdcv TDCV tdco TDCO tdcf TDCF ]
> |
> | 	[ loopback { on | off } ]
> | 	[ listen-only { on | off } ]
> | 	[ triple-sampling { on | off } ]
> | 	[ one-shot { on | off } ]
> | 	[ berr-reporting { on | off } ]
> | 	[ fd { on | off } ]
> | 	[ fd-non-iso { on | off } ]
> | 	[ presume-ack { on | off } ]
> | 	[ cc-len8-dlc { on | off } ]
> | 	[ tdc-mode { auto | manual | off } ]
> |
> | 	[ restart-ms TIME-MS ]
> | 	[ restart ]
> |
> | 	[ termination { 0..65535 } ]
> |
> | 	Where: BITRATE	:= { NUMBER in bps }
> | 		  SAMPLE-POINT	:= { 0.000..0.999 }
> | 		  TQ		:= { NUMBER in ns }
> | 		  PROP-SEG	:= { NUMBER in tq }
> | 		  PHASE-SEG1	:= { NUMBER in tq }
> | 		  PHASE-SEG2	:= { NUMBER in tq }
> | 		  SJW		:= { NUMBER in tq }
> | 		  TDCV		:= { NUMBER in tc }
> | 		  TDCO		:= { NUMBER in tc }
> | 		  TDCF		:= { NUMBER in tc }
> | 		  RESTART-MS	:= { 0 | NUMBER in ms }
> 
> Fixes: 0c263d7c36ff ("iplink_can: add new CAN FD bittiming parameters:
> Transmitter Delay Compensat ion (TDC)")
> Signed-off-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>

Acked-by: Marc Kleine-Budde <mkl@pengutronix.de>

regards,
Marc
diff mbox series

Patch

diff --git a/ip/iplink_can.c b/ip/iplink_can.c
index 6ea02a2a..0e670a6c 100644
--- a/ip/iplink_can.c
+++ b/ip/iplink_can.c
@@ -53,9 +53,9 @@  static void print_usage(FILE *f)
 		"\t	  PHASE-SEG1	:= { NUMBER in tq }\n"
 		"\t	  PHASE-SEG2	:= { NUMBER in tq }\n"
 		"\t	  SJW		:= { NUMBER in tq }\n"
-		"\t	  TDCV		:= { NUMBER in tc}\n"
-		"\t	  TDCO		:= { NUMBER in tc}\n"
-		"\t	  TDCF		:= { NUMBER in tc}\n"
+		"\t	  TDCV		:= { NUMBER in tc }\n"
+		"\t	  TDCO		:= { NUMBER in tc }\n"
+		"\t	  TDCF		:= { NUMBER in tc }\n"
 		"\t	  RESTART-MS	:= { 0 | NUMBER in ms }\n"
 		);
 }