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

[Bagas Sanjaya]

On Wed, Mar 13, 2024 at 11:34:31PM +0100, 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@xxxxxxxxx>
> ---
>  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
> +====================
> +
> +Overview
> +=========================
> +
<snipped>...
> +Multi-frame transport support
> +--------------------------
> +

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

Attachment: signature.asc
Description: PGP signature