can: bittiming: fix documentation for struct can_tdc
authorMarc Kleine-Budde <mkl@pengutronix.de>
Wed, 16 Jun 2021 09:55:26 +0000 (11:55 +0200)
committerMarc Kleine-Budde <mkl@pengutronix.de>
Sun, 25 Jul 2021 09:36:25 +0000 (11:36 +0200)
This patch fixes a typo in the documentation for struct can_tdc::tdcv.
The number "0" refers to automatic mode not the letter "O".

Further two grammar errors in the documentation for struct can_tdc are
fixed.

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)")
Link: https://lore.kernel.org/r/20210616095922.2430415-1-mkl@pengutronix.de
Link: https://lore.kernel.org/r/20210616124057.60723-1-mailhol.vincent@wanadoo.fr
Co-developed-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>
Signed-off-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>
Acked-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>
Signed-off-by: Marc Kleine-Budde <mkl@pengutronix.de>
include/linux/can/bittiming.h

index ae7a341..9de6e90 100644 (file)
@@ -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:
  *
- *       O: 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.