[PATCH] can: bittiming: fix two grammar mistakes in documentation for struct can_tdc

* [PATCH] can: bittiming: fix two grammar mistakes in documentation for struct can_tdc
@ 2021-06-16 12:40 Vincent Mailhol
  2021-06-16 13:33 ` Marc Kleine-Budde
  0 siblings, 1 reply; 4+ messages in thread
From: Vincent Mailhol @ 2021-06-16 12:40 UTC (permalink / raw)
  To: Marc Kleine-Budde, linux-can; +Cc: Vincent Mailhol

This patch fixes two grammar errors in the documentation for struct
can_tdc.

First grammar error: add a missing third person 's'.

Second grammar error: replace "such as" by "such that". The intent is
to give a condition, not an example.

Fixes: 289ea9e4ae59 ("can: add new CAN FD bittiming parameters: Transmitter Delay Compensation (TDC)")
Signed-off-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>
---
Hi Marc,

If that makes sense to you, feel free to squash this in your other
patch.
---
 include/linux/can/bittiming.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/linux/can/bittiming.h b/include/linux/can/bittiming.h
index d61d8716345e..9de6e9053e34 100644
--- a/include/linux/can/bittiming.h
+++ b/include/linux/can/bittiming.h
@@ -37,7 +37,7 @@
  *	quanta, from when the bit is sent on the TX pin to when it is
  *	received on the RX pin of the transmitter. Possible options:
  *
- *	  0: automatic mode. The controller dynamically measure @tdcv
+ *	  0: automatic mode. The controller dynamically measures @tdcv
  *	  for each transmitted CAN FD frame.
  *
  *	  Other values: manual mode. Use the fixed provided value.
@@ -45,7 +45,7 @@
  * @tdco: Transmitter Delay Compensation Offset. Offset value, in time
  *	quanta, defining the distance between the start of the bit
  *	reception on the RX pin of the transceiver and the SSP
- *	position such as SSP = @tdcv + @tdco.
+ *	position such that SSP = @tdcv + @tdco.
  *
  *	If @tdco is zero, then TDC is disabled and both @tdcv and
  *	@tdcf should be ignored.
-- 
2.31.1


^ permalink raw reply related	[flat|nested] 4+ messages in thread