Received-SPF: pass (google.com: domain of linux-kernel+bounces-103166-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45d1:ec00::1 as permitted sender) client-ip=2604:1380:45d1:ec00::1;
Date: Thu, 14 Mar 2024 12:20:10 +0100
From: Marc Kleine-Budde <mkl@pengutronix.de>
To: Francesco Valla <valla.francesco@gmail.com>
Cc: Oliver Hartkopp <socketcan@hartkopp.net>, 
	"David S. Miller" <davem@davemloft.net>, Eric Dumazet <edumazet@google.com>, 
	Jakub Kicinski <kuba@kernel.org>, Paolo Abeni <pabeni@redhat.com>, fabio@redaril.me, 
	linux-can@vger.kernel.org, netdev@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH 1/1] Documentation: networking: document CAN ISO-TP
Message-ID: <20240314-nurture-apricot-d4707bc77a00-mkl@pengutronix.de>
References: <20240313223445.87170-1-valla.francesco@gmail.com>
 <20240313223445.87170-2-valla.francesco@gmail.com>
Precedence: bulk
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
	protocol="application/pgp-signature"; boundary="23lpoqgne2axyrjj"
Content-Disposition: inline
In-Reply-To: <20240313223445.87170-2-valla.francesco@gmail.com>


--23lpoqgne2axyrjj
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

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.
>=20
> 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
>=20
> diff --git a/Documentation/networking/index.rst b/Documentation/networkin=
g/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/networkin=
g/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)
> +
> +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> +ISO-TP (ISO 15765-2) Transport Protocol
> +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D

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

> +
> +Overview
> +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D

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 microseco=
nds as
> +a 32bit unsigned integer; received Consecutive Frames (CF) which timesta=
mps
> +differ less than this value will be ignored:
> +
> +.. code-block:: C
> +
> +    uint32_t stmin;
> +    ret =3D setsockopt(s, SOL_CAN_ISOTP, CAN_ISOTP_RX_STMIN, &stmin, siz=
eof(stmin));
> +
> +Multi-frame transport support
> +--------------------------

same here

regards,
Marc

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

--23lpoqgne2axyrjj
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iQEzBAABCgAdFiEEUEC6huC2BN0pvD5fKDiiPnotvG8FAmXy3WcACgkQKDiiPnot
vG8lzQgAjaKShUuD1SFxYlmma7i0p2rGshpvscLbncWKuBmBQN65xPJAYZ7JOFzC
szKLUoekrIZmvAu519OYEq9uEqAwPg2SLtgjferHxwSLs3h+ovhyvlrXkYVDXuor
vwXpM362eJOIGf8b/LkqkMtrTPmwvZ2QLewJbyf8MUVpCYlYjfkrywZS701hvdok
RetPkO0jKVV5x9+5KJ4F3APspGgZ/rXikZhV2XBMxTshg0OeS1o/+iiZIF1YspYB
xCgS1UmVtx/8nrJeAIwWd3DFOffbccWDM87hj4+egf2uIuBFe/91CxGsGavgpzBB
+qKs9Fw+bAslSu+U0wZ7a/QQUpEUmA==
=K/bN
-----END PGP SIGNATURE-----

--23lpoqgne2axyrjj--