netdev - Re: [PATCH net-next 2/7] tools: ynl: cli: wrap the doc text if it's long

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <aWKiqKPYiAeeyhPq@mini-arch>
Date: Sat, 10 Jan 2026 11:04:08 -0800
From: Stanislav Fomichev <stfomichev@...il.com>
To: Jakub Kicinski <kuba@...nel.org>
Cc: davem@...emloft.net, netdev@...r.kernel.org, edumazet@...gle.com,
	pabeni@...hat.com, andrew+netdev@...n.ch, horms@...nel.org,
	donald.hunter@...il.com, gal@...dia.com
Subject: Re: [PATCH net-next 2/7] tools: ynl: cli: wrap the doc text if it's
 long

On 01/09, Jakub Kicinski wrote:
> 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@...nel.org>
> ---
>  tools/net/ynl/pyynl/cli.py | 10 +++++++++-
>  1 file changed, 9 insertions(+), 1 deletion(-)
> 
> diff --git a/tools/net/ynl/pyynl/cli.py b/tools/net/ynl/pyynl/cli.py
> index aa50d42e35ac..e5e71ee4e133 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,14 @@ 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
> +                if sys.stdout.isatty():
> +                    term_width = shutil.get_terminal_size().columns
> +                else:
> +                    term_width = 80
> +                doc_text = textwrap.fill(attr.yaml['doc'], width=term_width,
> +                                         initial_indent=doc_prefix,
> +                                         subsequent_indent=doc_prefix)

Any specific reason you wrap to 80 for !isatty?