Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Mime-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Content-Type: text/plain; charset=UTF-8
Date:   Mon, 22 May 2023 08:41:51 +0200
Message-Id: <CSSLOC8WDIPE.1WO9BXZQA7A12@otso>
Cc:     "Petr Mladek" <pmladek@suse.com>,
        "Steven Rostedt" <rostedt@goodmis.org>,
        "Sergey Senozhatsky" <senozhatsky@chromium.org>,
        "Rasmus Villemoes" <linux@rasmusvillemoes.dk>,
        "Jonathan Corbet" <corbet@lwn.net>,
        <~postmarketos/upstreaming@lists.sr.ht>,
        <phone-devel@vger.kernel.org>, <linux-doc@vger.kernel.org>,
        <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH] docs: printk-formats: Clarify %*pb format parameters
From:   "Luca Weiss" <luca.weiss@fairphone.com>
To:     "Andy Shevchenko" <andriy.shevchenko@linux.intel.com>
References: <20230516-printk-bitmap-v1-1-d5f810192a10@fairphone.com>
 <ZGT+lJasWhZ0TPRi@smile.fi.intel.com>
In-Reply-To: <ZGT+lJasWhZ0TPRi@smile.fi.intel.com>
Precedence: bulk

On Wed May 17, 2023 at 6:19 PM CEST, Andy Shevchenko wrote:
> On Tue, May 16, 2023 at 08:52:43AM +0200, Luca Weiss wrote:
> > Since it's rather unusual for printk formats to require two parameters,
>
> I don't think this is "unusual".

Well, unusual for me at least. I've never really used anything except
the standard integer types and %px. And I've been contributing to the
kernel since 2017.

> The %*... is very well described in the printf(3) (the meaning of *).
> It applies here for %*p... as well.

The printf(3) man page is never mentioned on this docs page. And even if
it would be mentioned somewhere, I doubt anyone is reading most of the
page when they're just looking for a format specifier for e.g. bitmap.
At least I am not.

>
> > expand the documentation to clearly mention that in the printk format
> > for bitmaps.
> >=20
> > As an extra example, for example from include/net/bluetooth/hci_core.h
> > we have a bitmap DECLARE_BITMAP(dev_flags, __HCI_NUM_FLAGS);
> > This can be printed with ("%*pb", __HCI_NUM_FLAGS, hdev->dev_flags)
>
> I think this change is not needed. But try to convince PRINTK maintainers=
.
> Maybe they will be okay with it if it covers all %*p... cases (like %*ph)=
.

Cannot say I haven't tried :) As I wrote in the initial email I'd be
happy also if someone who knows more about the formats to include some
text for all the %* options so users know what's up.

Regards
Luca