From: "André Almeida" <andrealmeid@collabora.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: linux-block@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, axboe@kernel.dk,
kernel@collabora.com, krisman@collabora.com
Subject: Re: [PATCH v2 4/4] coding-style: add explanation about pr_fmt macro
Date: Mon, 16 Sep 2019 10:38:50 -0300 [thread overview]
Message-ID: <e8e82c8b-7a2f-e238-a687-8505195ecb39@collabora.com> (raw)
In-Reply-To: <20190914015018.4fa90f28@lwn.net>
On 9/14/19 4:50 AM, Jonathan Corbet wrote:
> On Fri, 13 Sep 2019 19:03:00 -0300
> André Almeida <andrealmeid@collabora.com> wrote:
>
>> The pr_fmt macro is useful to format log messages printed by pr_XXXX()
>> functions. Add text to explain the purpose of it, how to use and an
>> example.
>
> So I've finally had a chance to take a real look at this...
>
>> diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
>> index f4a2198187f9..1a33a933fbd3 100644
>> --- a/Documentation/process/coding-style.rst
>> +++ b/Documentation/process/coding-style.rst
>> @@ -819,7 +819,15 @@ which you should use to make sure messages are matched to the right device
>> and driver, and are tagged with the right level: dev_err(), dev_warn(),
>> dev_info(), and so forth. For messages that aren't associated with a
>> particular device, <linux/printk.h> defines pr_notice(), pr_info(),
>> -pr_warn(), pr_err(), etc.
>> +pr_warn(), pr_err(), etc. It's possible to format pr_XXX() messages using the
>> +macro pr_fmt() to prevent rewriting the style of messages. It should be
>> +defined before ``#include <linux/kernel.h>``, to avoid compiler warning about
>> +redefinitions, or just use ``#undef pr_fmt``. This is particularly useful for
>> +adding the name of the module at the beginning of the message, for instance:
>> +
>> +.. code-block:: c
>> +
>> + #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
>
> Honestly, I think that this is out of scope for a document on coding
> style. That document is already far too long for most people to read, I
> don't think we should load it down with more stuff that isn't directly
> style related.
>
> That said, the information can be useful. I wanted to say that it should
> go with the documentation of the pr_* macros but ... well ... um ... we
> don't seem to have a whole lot of that. Figures.
>
> I suspect this is more than you wanted to sign up for, but...IMO, the right
> thing to do is to fill printk.h with a nice set of kerneldoc comments
> describing how this stuff should be used, then to pull that information
> into the core-api manual, somewhere near our extensive discussion of printk
> formats. It's amazing that we lack docs for something so basic.
>
Thanks for the feedback jon. For now, I'll drop this patch for this
series. In a future patch I'll move this text for
Documentation/core-api/printk-formats.rst and will also add kernel-doc
comments to pr_XXXX() functions.
> Thanks,
>
> jon
>
prev parent reply other threads:[~2019-09-16 13:40 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-09-13 22:02 [PATCH v2 0/4] null_blk: fixes around nr_devices and log improvements André Almeida
2019-09-13 22:02 ` [PATCH v2 1/4] null_blk: do not fail the module load with zero devices André Almeida
2019-09-13 22:15 ` Chaitanya Kulkarni
2019-09-13 22:17 ` Bart Van Assche
2019-09-13 22:37 ` Chaitanya Kulkarni
2019-09-13 22:02 ` [PATCH v2 2/4] null_blk: match the type of parameter nr_devices André Almeida
2019-09-13 22:15 ` Chaitanya Kulkarni
2019-09-13 22:02 ` [PATCH v2 3/4] null_blk: format pr_* logs with pr_fmt André Almeida
2019-09-13 22:16 ` Chaitanya Kulkarni
2019-09-13 22:03 ` [PATCH v2 4/4] coding-style: add explanation about pr_fmt macro André Almeida
2019-09-13 22:18 ` Chaitanya Kulkarni
2019-09-14 7:50 ` Jonathan Corbet
2019-09-16 13:38 ` André Almeida [this message]
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=e8e82c8b-7a2f-e238-a687-8505195ecb39@collabora.com \
--to=andrealmeid@collabora.com \
--cc=axboe@kernel.dk \
--cc=corbet@lwn.net \
--cc=kernel@collabora.com \
--cc=krisman@collabora.com \
--cc=linux-block@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.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;
as well as URLs for NNTP newsgroup(s).