[PATCH v4 0/1] Documentation: networking: document ISO 15765-2

Francesco Valla posted 1 patch 2 weeks, 4 days ago
Documentation/networking/index.rst      |   1 +
Documentation/networking/iso15765-2.rst | 386 ++++++++++++++++++++++++
MAINTAINERS                             |   1 +
3 files changed, 388 insertions(+)
create mode 100644 Documentation/networking/iso15765-2.rst
[PATCH v4 0/1] Documentation: networking: document ISO 15765-2
Posted by Francesco Valla 2 weeks, 4 days ago
While the in-kernel ISO 15765-2 (ISO-TP) stack is fully functional and
easy to use, no documentation exists for it.

This patch adds such documentation, containing the very basics of the
protocol, the APIs and a basic example.

Thanks,
Francesco

---
Changes in v4:
 - fix typos
 - collect a Reviewed-by 

Changes in v3:
 - drop the :2016 version suffix, as in the mean time ISO 15765-2:2024
   has been released (and is thus referenced as the referenced
   specification)
 - add details on mixed addressing (all the paragraph about the addressing
   format has been reworked)
 - align some descriptions to the specification
 - miscellaneous fixes
 - collected a Reviewed-by

Changes in v2:
 - rename (and re-title) documentation to to align it with KConfig option,
   using ISO 15765-2:2016 instead of ISO-TP (the latter is still used for
   brevity inside the document)
 - address review comments
 - solve warnings coming from checkpatch and make htmldocs

Francesco Valla (1):
  Documentation: networking: document ISO 15765-2

 Documentation/networking/index.rst      |   1 +
 Documentation/networking/iso15765-2.rst | 386 ++++++++++++++++++++++++
 MAINTAINERS                             |   1 +
 3 files changed, 388 insertions(+)
 create mode 100644 Documentation/networking/iso15765-2.rst

-- 
2.44.0
Re: [PATCH v4 0/1] Documentation: networking: document ISO 15765-2
Posted by Marc Kleine-Budde 2 weeks ago
On 01.05.2024 11:24:12, Francesco Valla wrote:
> While the in-kernel ISO 15765-2 (ISO-TP) stack is fully functional and
> easy to use, no documentation exists for it.
> 
> This patch adds such documentation, containing the very basics of the
> protocol, the APIs and a basic example.

Applied to linux-can-next.

Thanks,
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   |