From: Vincent Mailhol <mailhol@kernel.org>
To: Oliver Hartkopp <socketcan@hartkopp.net>,
Marc Kleine-Budde <mkl@pengutronix.de>
Cc: Simon Horman <horms@kernel.org>, Paolo Abeni <pabeni@redhat.com>,
"David S. Miller" <davem@davemloft.net>,
Eric Dumazet <edumazet@google.com>,
Jakub Kicinski <kuba@kernel.org>,
Paolo Abeni <pabeni@redhat.com>, Simon Horman <horms@kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
Geert Uytterhoeven <geert@linux-m68k.org>,
linux-can@vger.kernel.org, netdev@vger.kernel.org,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Vincent Mailhol <mailhol@kernel.org>
Subject: [PATCH v2 0/2] can: add Transmitter Delay Compensation (TDC) documentation
Date: Mon, 13 Oct 2025 19:10:21 +0900 [thread overview]
Message-ID: <20251013-can-fd-doc-v2-0-5d53bdc8f2ad@kernel.org> (raw)
TDC was added to the kernel in 2021 but I never took time to update
the documentation. The year is now 2025... As we say: "better late
than never"!
The first patch is a small clean up which fixes an incorrect statement
concerning the CAN DLC, the second patch is the real thing and adds
the documentation of how to use the ip tool to configure the TDC.
Signed-off-by: Vincent Mailhol <mailhol@kernel.org>
---
Changes in v2:
- Fix below "make htmldocs" error:
can.rst:1484: ERROR: Unexpected indentation. [docutils]
- Change from "Bullet lists" to "Definition lists" format.
Link to v1: https://lore.kernel.org/r/20251012-can-fd-doc-v1-0-86cc7d130026@kernel.org
---
Vincent Mailhol (2):
can: remove false statement about 1:1 mapping between DLC and length
can: add Transmitter Delay Compensation (TDC) documentation
Documentation/networking/can.rst | 71 +++++++++++++++++++++++++++++++++++++---
1 file changed, 67 insertions(+), 4 deletions(-)
---
base-commit: cb6649f6217c0331b885cf787f1d175963e2a1d2
change-id: 20251012-can-fd-doc-692e7bdd6369
Best regards,
--
Vincent Mailhol <mailhol@kernel.org>
next reply other threads:[~2025-10-13 10:10 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-10-13 10:10 Vincent Mailhol [this message]
2025-10-13 10:10 ` [PATCH v2 1/2] can: remove false statement about 1:1 mapping between DLC and length Vincent Mailhol
2025-10-13 10:10 ` [PATCH v2 2/2] can: add Transmitter Delay Compensation (TDC) documentation Vincent Mailhol
2025-10-13 12:13 ` Simon Horman
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20251013-can-fd-doc-v2-0-5d53bdc8f2ad@kernel.org \
--to=mailhol@kernel.org \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=edumazet@google.com \
--cc=geert@linux-m68k.org \
--cc=horms@kernel.org \
--cc=kuba@kernel.org \
--cc=linux-can@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mkl@pengutronix.de \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
--cc=socketcan@hartkopp.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).