Linux CAN drivers development
 help / color / mirror / Atom feed
From: Vincent Mailhol <mailhol@kernel.org>
To: netdev@vger.kernel.org,
	Stephen Hemminger <stephen@networkplumber.org>,
	 Marc Kleine-Budde <mkl@pengutronix.de>,
	 Oliver Hartkopp <socketcan@hartkopp.net>,
	David Ahern <dsahern@kernel.org>
Cc: "Rakuram Eswaran" <rakuram.e96@gmail.com>,
	"Stéphane Grosjean" <stephane.grosjean@free.fr>,
	linux-kernel@vger.kernel.org, linux-can@vger.kernel.org,
	"Vincent Mailhol" <mailhol@kernel.org>
Subject: [PATCH iproute2-next v2 3/7] iplink_can: print_usage: describe the CAN bittiming units
Date: Mon, 01 Dec 2025 23:55:11 +0100	[thread overview]
Message-ID: <20251201-canxl-netlink-v2-3-dadfac811872@kernel.org> (raw)
In-Reply-To: <20251201-canxl-netlink-v2-0-dadfac811872@kernel.org>

While the meaning of "bps" or "ns" may be relatively easy to understand,
some of the CAN specific units such as "mtq" (minimum time quanta) may be
harder to understand.

Add a new paragraph to the help menu which describes all the different
units used for the CAN bittiming parameters.

Signed-off-by: Vincent Mailhol <mailhol@kernel.org>
---
Changelog

v1 -> v2:

  - "s/mili second/milisecond/g" and "s/nano second/nanosecond/g"
---
 ip/iplink_can.c | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/ip/iplink_can.c b/ip/iplink_can.c
index ee27659c..d5abc43a 100644
--- a/ip/iplink_can.c
+++ b/ip/iplink_can.c
@@ -60,6 +60,13 @@ static void print_usage(FILE *f)
 		"\t	TDCO		:= { NUMBER in mtq }\n"
 		"\t	TDCF		:= { NUMBER in mtq }\n"
 		"\t	RESTART-MS	:= { 0 | NUMBER in ms }\n"
+		"\n"
+		"\tUnits:\n"
+		"\t	bps	:= bit per second\n"
+		"\t	ms	:= millisecond\n"
+		"\t	mtq	:= minimum time quanta\n"
+		"\t	ns	:= nanosecond\n"
+		"\t	tq	:= time quanta\n"
 		);
 }
 

-- 
2.51.2


  parent reply	other threads:[~2025-12-01 22:56 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-12-01 22:55 [PATCH iproute2-next v2 0/7] iplink_can: add CAN XL support Vincent Mailhol
2025-12-01 22:55 ` [PATCH iproute2-next v2 1/7] iplink_can: print_usage: fix the text indentation Vincent Mailhol
2025-12-01 22:55 ` [PATCH iproute2-next v2 2/7] iplink_can: print_usage: change unit for minimum time quanta to mtq Vincent Mailhol
2025-12-01 22:55 ` Vincent Mailhol [this message]
2025-12-01 22:55 ` [PATCH iproute2-next v2 4/7] iplink_can: add the "restricted" option Vincent Mailhol
2025-12-01 22:55 ` [PATCH iproute2-next v2 5/7] iplink_can: add initial CAN XL interface Vincent Mailhol
2025-12-02  0:38   ` Stephen Hemminger
2025-12-02 22:30     ` Vincent Mailhol
2025-12-01 22:55 ` [PATCH iproute2-next v2 6/7] iplink_can: add CAN XL's "tms" option Vincent Mailhol
2025-12-01 22:55 ` [PATCH iproute2-next v2 7/7] iplink_can: add CAN XL's PWM interface Vincent Mailhol
2025-12-02  9:33 ` [PATCH iproute2-next v2 0/7] iplink_can: add CAN XL support Oliver Hartkopp
2025-12-02 22:50   ` Vincent Mailhol

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=20251201-canxl-netlink-v2-3-dadfac811872@kernel.org \
    --to=mailhol@kernel.org \
    --cc=dsahern@kernel.org \
    --cc=linux-can@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mkl@pengutronix.de \
    --cc=netdev@vger.kernel.org \
    --cc=rakuram.e96@gmail.com \
    --cc=socketcan@hartkopp.net \
    --cc=stephane.grosjean@free.fr \
    --cc=stephen@networkplumber.org \
    /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