From: Jakub Kicinski <kuba@kernel.org>
To: davem@davemloft.net
Cc: netdev@vger.kernel.org, edumazet@google.com, pabeni@redhat.com,
andrew+netdev@lunn.ch, horms@kernel.org, sdf@fomichev.me,
donald.hunter@gmail.com, gal@nvidia.com,
Jakub Kicinski <kuba@kernel.org>
Subject: [PATCH net-next v2 2/7] tools: ynl: cli: wrap the doc text if it's long
Date: Sat, 10 Jan 2026 15:31:37 -0800 [thread overview]
Message-ID: <20260110233142.3921386-3-kuba@kernel.org> (raw)
In-Reply-To: <20260110233142.3921386-1-kuba@kernel.org>
We already use textwrap when printing "doc" section about an attribute,
but only to indent the text. Switch to using fill() to split and indent
all the lines. While at it indent the text by 2 more spaces, so that it
doesn't align with the name of the attribute.
Before (I'm drawing a "box" at ~60 cols here, in an attempt for clarity):
| - irq-suspend-timeout: uint |
| The timeout, in nanoseconds, of how long to suspend irq|
|processing, if event polling finds events |
After:
| - irq-suspend-timeout: uint |
| The timeout, in nanoseconds, of how long to suspend |
| irq processing, if event polling finds events |
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
v2:
- remove the explicit sys.stdout.isatty() check
v1: https://lore.kernel.org/20260109211756.3342477-3-kuba@kernel.org
---
tools/net/ynl/pyynl/cli.py | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/tools/net/ynl/pyynl/cli.py b/tools/net/ynl/pyynl/cli.py
index aa50d42e35ac..dc84619e5518 100755
--- a/tools/net/ynl/pyynl/cli.py
+++ b/tools/net/ynl/pyynl/cli.py
@@ -10,6 +10,7 @@ import json
import os
import pathlib
import pprint
+import shutil
import sys
import textwrap
@@ -101,7 +102,11 @@ RELATIVE_SCHEMA_DIR='../../../../Documentation/netlink'
attr_info += f" -> {nested_set_name}"
if attr.yaml.get('doc'):
- doc_text = textwrap.indent(attr.yaml['doc'], prefix + ' ')
+ doc_prefix = prefix + ' ' * 4
+ term_width = shutil.get_terminal_size().columns
+ doc_text = textwrap.fill(attr.yaml['doc'], width=term_width,
+ initial_indent=doc_prefix,
+ subsequent_indent=doc_prefix)
attr_info += f"\n{doc_text}"
print(attr_info)
--
2.52.0
next prev parent reply other threads:[~2026-01-10 23:31 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-01-10 23:31 [PATCH net-next v2 0/7] tools: ynl: cli: improve the help and doc Jakub Kicinski
2026-01-10 23:31 ` [PATCH net-next v2 1/7] tools: ynl: cli: introduce formatting for attr names in --list-attrs Jakub Kicinski
2026-01-10 23:31 ` Jakub Kicinski [this message]
2026-01-10 23:31 ` [PATCH net-next v2 3/7] tools: ynl: cli: improve --help Jakub Kicinski
2026-01-10 23:31 ` [PATCH net-next v2 4/7] tools: ynl: cli: add --doc as alias to --list-attrs Jakub Kicinski
2026-01-10 23:31 ` [PATCH net-next v2 5/7] tools: ynl: cli: factor out --list-attrs / --doc handling Jakub Kicinski
2026-01-10 23:31 ` [PATCH net-next v2 6/7] tools: ynl: cli: extract the event/notify handling in --list-attrs Jakub Kicinski
2026-01-10 23:31 ` [PATCH net-next v2 7/7] tools: ynl: cli: print reply in combined format if possible Jakub Kicinski
2026-01-11 7:56 ` [PATCH net-next v2 0/7] tools: ynl: cli: improve the help and doc Gal Pressman
2026-01-11 20:19 ` Stanislav Fomichev
2026-01-12 2:05 ` Donald Hunter
2026-01-13 2:27 ` patchwork-bot+netdevbpf
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=20260110233142.3921386-3-kuba@kernel.org \
--to=kuba@kernel.org \
--cc=andrew+netdev@lunn.ch \
--cc=davem@davemloft.net \
--cc=donald.hunter@gmail.com \
--cc=edumazet@google.com \
--cc=gal@nvidia.com \
--cc=horms@kernel.org \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
--cc=sdf@fomichev.me \
/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