linux-toradex.git/Documentation/networking/device_drivers/can, branch master

Documentation: use a source-read extension for the index link boilerplate

2026-01-23T18:59:34+00:00

The root document usually has a special :ref:`genindex` link to the
generated index. This is also the case for Documentation/index.rst. The
other index.rst files deeper in the directory hierarchy usually don't.

For SPHINXDIRS builds, the root document isn't Documentation/index.rst,
but some other index.rst in the hierarchy. Currently they have a
".. only::" block to add the index link when doing SPHINXDIRS html
builds.

This is obviously very tedious and repetitive. The link is also added to
all index.rst files in the hierarchy for SPHINXDIRS builds, not just the
root document.

Put the boilerplate in a sphinx-includes/subproject-index.rst file, and
include it at the end of the root document for subproject builds in an
ad-hoc source-read extension defined in conf.py.

For now, keep having the boilerplate in translations, because this
approach currently doesn't cover translated index link headers.

Cc: Jonathan Corbet 
Cc: Mauro Carvalho Chehab 
Cc: Randy Dunlap 
Signed-off-by: Jani Nikula 
Tested-by: Mauro Carvalho Chehab 
Reviewed-by: Mauro Carvalho Chehab 
[jc: did s/doctree/kern_doc_dir/ ]
Signed-off-by: Jonathan Corbet 
Message-ID: <20260123143149.2024303-1-jani.nikula@intel.com>

docs: networking: document NAPI

2023-03-24T02:47:40+00:00

Add basic documentation about NAPI. We can stop linking to the ancient
doc on the LF wiki.

Link: https://lore.kernel.org/all/20230315223044.471002-1-kuba@kernel.org/
Reviewed-by: Bagas Sanjaya 
Reviewed-by: Toke Høiland-Jørgensen 
Acked-by: Pavel Pisa  # for ctucanfd-driver.rst
Reviewed-by: Tony Nguyen 
Reviewed-by: Florian Fainelli 
Reviewed-by: Stephen Hemminger 
Reviewed-by: Randy Dunlap 
Link: https://lore.kernel.org/r/20230322053848.198452-1-kuba@kernel.org
Signed-off-by: Jakub Kicinski

Documentation: networking: correct spelling

2023-01-31T12:00:47+00:00

Correct spelling problems for Documentation/networking/ as reported
by codespell.

Signed-off-by: Randy Dunlap 
Cc: Jonathan Corbet 
Cc: linux-doc@vger.kernel.org
Cc: Jiri Pirko 
Cc: "David S. Miller" 
Cc: Eric Dumazet 
Cc: Jakub Kicinski 
Cc: Paolo Abeni 
Cc: netdev@vger.kernel.org
Link: https://lore.kernel.org/r/20230129231053.20863-5-rdunlap@infradead.org
Signed-off-by: Paolo Abeni

docs: networking: device drivers: flexcan: fix invalid email

2022-09-06T06:32:12+00:00

The Amarula contact info email address is wrong, so fix it up to use the
correct one.

Signed-off-by: Dario Binacchi 
Link: https://lore.kernel.org/all/20220828134442.794990-1-dario.binacchi@amarulasolutions.com
Signed-off-by: Marc Kleine-Budde

can: can327: CAN/ldisc driver for ELM327 based OBD-II adapters

2022-06-27T15:00:04+00:00

This is the can327 driver. It does a surprisingly good job at turning
ELM327 based OBD-II interfaces into cheap CAN interfaces for simple
homebrew projects.

Please see the included documentation for details and limitations:
Documentation/networking/device_drivers/can/can327.rst

Link: https://lore.kernel.org/all/20220618195031.10975-1-max@enpas.org
Signed-off-by: Max Staudt 
Reviewed-by: Vincent Mailhol 
[mkl: minor coding style improvements]
Signed-off-by: Marc Kleine-Budde

docs: ctucanfd: Use 'kernel-figure' directive instead of 'figure'

2022-05-16T20:11:11+00:00

Two issues were observed in the ReST doc added by commit c3a0addefbde
("docs: ctucanfd: CTU CAN FD open-source IP core documentation.")
with Sphinx versions 2.4.4 and 4.5.0.

The plain "figure" directive broke "make pdfdocs" due to a missing
PDF figure.  For conversion of SVG -> PDF to work, the "kernel-figure"
directive, which is an extension for kernel documentation, should
be used instead.

The directive of "code:: raw" causes a warning from both
"make htmldocs" and "make pdfdocs", which reads:

    [...]/can/ctu/ctucanfd-driver.rst:75: WARNING: Pygments lexer name
    'raw' is not known

A plain literal-block marker should suffice where no syntax
highlighting is intended.

Fix the issues by using suitable directive and marker.

Fixes: c3a0addefbde ("docs: ctucanfd: CTU CAN FD open-source IP core documentation.")
Link: https://lore.kernel.org/all/5986752a-1c2a-5d64-f91d-58b1e6decd17@gmail.com
Signed-off-by: Akira Yokosawa 
Acked-by: Pavel Pisa 
Cc: Martin Jerabek 
Cc: Ondrej Ille 
Cc: Marc Kleine-Budde 
Signed-off-by: Marc Kleine-Budde

docs: networking: device drivers: can: ctucanfd: update author e-mail

2022-05-02T07:24:41+00:00

This patch updates the author's email address.

Link: https://lore.kernel.org/all/e4396244da6b008c671def9f50bb983a10389863.1650816929.git.pisa@cmp.felk.cvut.cz
Cc: Odrej Ille 
Signed-off-by: Pavel Pisa 
[mkl: split into separate patches]
Signed-off-by: Marc Kleine-Budde

docs: networking: device drivers: can: add ctucanfd to index

2022-05-02T07:24:40+00:00

This patch adds the ctucanfd-driver document to the index.

Link: https://lore.kernel.org/all/e4396244da6b008c671def9f50bb983a10389863.1650816929.git.pisa@cmp.felk.cvut.cz
Signed-off-by: Pavel Pisa 
[mkl: split into separate patches]
Signed-off-by: Marc Kleine-Budde

docs: ctucanfd: CTU CAN FD open-source IP core documentation.

2022-04-19T15:12:14+00:00

CTU CAN FD IP core documentation based on Martin Jeřábek's diploma theses
Open-source and Open-hardware CAN FD Protocol Support
https://dspace.cvut.cz/handle/10467/80366
.

Link: https://lore.kernel.org/all/692b965999ff6c272239df0fe1c76b68d02b134d.1647932262.git.pisa@cmp.felk.cvut.cz
Signed-off-by: Pavel Pisa 
Signed-off-by: Martin Jerabek 
Signed-off-by: Ondrej Ille 
Signed-off-by: Marc Kleine-Budde

docs: networking: device drivers: can: add flexcan

2022-01-08T20:22:58+00:00

Add initial documentation for Flexcan driver.

Link: https://lore.kernel.org/all/20220107193105.1699523-8-mkl@pengutronix.de
Signed-off-by: Dario Binacchi 
Signed-off-by: Marc Kleine-Budde