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

Francesco Valla
2024-03-15T16:36:53Z

On Fri, Mar 15, 2024 at 11:55:04AM +0700, Bagas Sanjaya wrote:

<snip>
>
> htmldocs build reports new warnings:
>
> /home/bagas/repo/linux-kernel/Documentation/networking/isotp.rst:3: WARNING: Title overline too short.
>
> ====================
> ISO-TP (ISO 15765-2) Transport Protocol
> ====================
> /home/bagas/repo/linux-kernel/Documentation/networking/isotp.rst:275: WARNING: Title underline too short.
>
> Multi-frame transport support
> --------------------------
> /home/bagas/repo/linux-kernel/Documentation/networking/isotp.rst:275: WARNING: Title underline too short.
>
> Multi-frame transport support
> --------------------------
>
> I have applied the fixup:
>
> ---- >8 ----
> diff --git a/Documentation/networking/isotp.rst b/Documentation/networking/isotp.rst
> index d0c49fd1f5c976..a104322ddb6c5e 100644
> --- a/Documentation/networking/isotp.rst
> +++ b/Documentation/networking/isotp.rst
> @@ -1,11 +1,11 @@
> .. SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
>
> -====================
> +=======================================
> ISO-TP (ISO 15765-2) Transport Protocol
> -====================
> +=======================================
>
> Overview
> -=========================
> +========
>
> ISO-TP, also known as ISO 15765-2 from the ISO standard it is defined in, is a
> transport protocol specifically defined for diagnostic communication on CAN.
> @@ -272,7 +272,7 @@ differ less than this value will be ignored:
> ret = setsockopt(s, SOL_CAN_ISOTP, CAN_ISOTP_RX_STMIN, &stmin, sizeof(stmin));
>
> Multi-frame transport support
> ---------------------------
> +-----------------------------
>
> The ISO-TP stack contained inside the Linux kernel supports the multi-frame
> transport mechanism defined by the standard, with the following contraints:
>
> Thanks.
>
> --
> An old man doll... just what I always wanted! - Clara

Thank you! Fixes (along with some rework) will be applied to the v2.

Regards,
Francesco