* [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* Re: [PATCH] can: bittiming: fix two grammar mistakes in documentation for struct can_tdc
2021-06-16 12:40 [PATCH] can: bittiming: fix two grammar mistakes in documentation for struct can_tdc Vincent Mailhol
@ 2021-06-16 13:33 ` Marc Kleine-Budde
2021-06-16 16:18 ` Vincent MAILHOL
0 siblings, 1 reply; 4+ messages in thread
From: Marc Kleine-Budde @ 2021-06-16 13:33 UTC (permalink / raw)
To: Vincent Mailhol; +Cc: linux-can
[-- Attachment #1: Type: text/plain, Size: 1991 bytes --]
On 16.06.2021 21:40:57, Vincent Mailhol wrote:
> 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.
Makes sense. I've added you as Co-developed-by:
| can: bittiming: fix documentation for struct can_tdc::tdcv
|
| 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>
regards,
Marc
--
Pengutronix e.K. | Marc Kleine-Budde |
Embedded Linux | https://www.pengutronix.de |
Vertretung West/Dortmund | Phone: +49-231-2826-924 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 4+ messages in thread* Re: [PATCH] can: bittiming: fix two grammar mistakes in documentation for struct can_tdc
2021-06-16 13:33 ` Marc Kleine-Budde
@ 2021-06-16 16:18 ` Vincent MAILHOL
2021-06-17 10:56 ` Marc Kleine-Budde
0 siblings, 1 reply; 4+ messages in thread
From: Vincent MAILHOL @ 2021-06-16 16:18 UTC (permalink / raw)
To: Marc Kleine-Budde; +Cc: linux-can
On Wed. 16 Jun 2021 at 22:33, Marc Kleine-Budde <mkl@pengutronix.de> wrote:
>
> On 16.06.2021 21:40:57, Vincent Mailhol wrote:
> > 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.
>
> Makes sense. I've added you as Co-developed-by:
Great, thank you!
> | can: bittiming: fix documentation for struct can_tdc::tdcv
One nitpick: the title should become
| can: bittiming: fix documentation for struct can_tdc
(without the ::tdcv) because the last fix is on tdco.
> | 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>
>
> regards,
> Marc
>
> --
> Pengutronix e.K. | Marc Kleine-Budde |
> Embedded Linux | https://www.pengutronix.de |
> Vertretung West/Dortmund | Phone: +49-231-2826-924 |
> Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2021-06-17 10:56 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-06-16 12:40 [PATCH] can: bittiming: fix two grammar mistakes in documentation for struct can_tdc Vincent Mailhol
2021-06-16 13:33 ` Marc Kleine-Budde
2021-06-16 16:18 ` Vincent MAILHOL
2021-06-17 10:56 ` Marc Kleine-Budde
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.