Re: [PATCH 1/1] Documentation: networking: document CAN ISO-TP

Marc Kleine-Budde
2024-03-14T11:20:25Z

[-- Attachment #1: Type: text/plain, Size: 2260 bytes --]

Hello Francesco,

thanks for your contribution! I've some remarks to make it a valid rst
file.

On 13.03.2024 23:34:31, Francesco Valla wrote:
> Document basic concepts, APIs and behaviour of the CAN ISO-TP (ISO
> 15765-2) stack.
>
> Signed-off-by: Francesco Valla <valla.francesco@gmail.com>
> ---
> Documentation/networking/index.rst | 1 +
> Documentation/networking/isotp.rst | 347 +++++++++++++++++++++++++++++
> 2 files changed, 348 insertions(+)
> create mode 100644 Documentation/networking/isotp.rst
>
> diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst
> index 473d72c36d61..ba22acfae389 100644
> --- a/Documentation/networking/index.rst
> +++ b/Documentation/networking/index.rst
> @@ -19,6 +19,7 @@ Contents:
> caif/index
> ethtool-netlink
> ieee802154
> + isotp
> j1939
> kapi
> msg_zerocopy
> diff --git a/Documentation/networking/isotp.rst b/Documentation/networking/isotp.rst
> new file mode 100644
> index 000000000000..d0c49fd1f5c9
> --- /dev/null
> +++ b/Documentation/networking/isotp.rst
> @@ -0,0 +1,347 @@
> +.. SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
> +
> +====================
> +ISO-TP (ISO 15765-2) Transport Protocol
> +====================

Please make the "=" as long as the text it encloses.

> +
> +Overview
> +=========================

Same here

[...]

> +Reception stmin
> +~~~~~~~~~~~~~~~
> +
> +The reception minimum separaton time (stmin) can be forced using the
> +``CAN_ISOTP_RX_STMIN`` optname and providing an stmin value in microseconds as
> +a 32bit unsigned integer; received Consecutive Frames (CF) which timestamps
> +differ less than this value will be ignored:
> +
> +.. code-block:: C
> +
> + uint32_t stmin;
> + ret = setsockopt(s, SOL_CAN_ISOTP, CAN_ISOTP_RX_STMIN, &stmin, sizeof(stmin));
> +
> +Multi-frame transport support
> +--------------------------

same here

regards,
Marc

--
Pengutronix e.K. | Marc Kleine-Budde |
Embedded Linux | https://www.pengutronix.de |
Vertretung Nürnberg | Phone: +49-5121-206917-129 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-9 |

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]