From: Sergei Shtylyov <sergei.shtylyov@gmail.com>
To: tasleson@redhat.com, linux-scsi@vger.kernel.org,
linux-block@vger.kernel.org, linux-ide@vger.kernel.org
Subject: Re: [v5 01/12] struct device: Add function callback durable_name
Date: Sun, 27 Sep 2020 19:15:18 +0300 [thread overview]
Message-ID: <f276f116-a80c-fb98-0569-d7a6799868d4@gmail.com> (raw)
In-Reply-To: <90ef294c-2f37-2299-6253-68ea27e312b4@redhat.com>
On 27.09.2020 17:22, Tony Asleson wrote:
>>> Function callback and function to be used to write a persistent
>>> durable name to the supplied character buffer. This will be used to add
>>> structured key-value data to log messages for hardware related errors
>>> which allows end users to correlate message and specific hardware.
>>>
>>> Signed-off-by: Tony Asleson <tasleson@redhat.com>
>>> ---
>>> drivers/base/core.c | 24 ++++++++++++++++++++++++
>>> include/linux/device.h | 4 ++++
>>> 2 files changed, 28 insertions(+)
>>>
>>> diff --git a/drivers/base/core.c b/drivers/base/core.c
>>> index 05d414e9e8a4..88696ade8bfc 100644
>>> --- a/drivers/base/core.c
>>> +++ b/drivers/base/core.c
>>> @@ -2489,6 +2489,30 @@ int dev_set_name(struct device *dev, const char
>>> *fmt, ...)
>>> }
>>> EXPORT_SYMBOL_GPL(dev_set_name);
>>> +/**
>>> + * dev_durable_name - Write "DURABLE_NAME"=<durable name> in buffer
>>> + * @dev: device
>>> + * @buffer: character buffer to write results
>>> + * @len: length of buffer
>>> + * @return: Number of bytes written to buffer
>>
>> This is not how the kernel-doc commenta describe the function result,
>> IIRC...
>
> I did my compile with `make W=1` and there isn't any warnings/error
> with source documentation, but the documentation does indeed outline a
IIRC, you only get the warnings when you try to build the kernel-docs.
> different syntax. It's interesting how common the @return syntax is in
> the existing code base.
FWIW, I'm seeing @return: for the 1st time in my Linux tenure (since 2004).
> I'll re-work the function documentation return.
OK, thanks. :-)
> Thanks
MBR, Sergei
next prev parent reply other threads:[~2020-09-27 16:15 UTC|newest]
Thread overview: 35+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-25 16:19 [v5 00/12] Add persistent durable identifier to storage log messages Tony Asleson
2020-09-25 16:19 ` [v5 01/12] struct device: Add function callback durable_name Tony Asleson
2020-09-26 9:08 ` Sergei Shtylyov
2020-09-27 14:22 ` Tony Asleson
2020-09-27 16:15 ` Sergei Shtylyov [this message]
2020-09-29 17:51 ` Christoph Hellwig
2020-09-29 18:04 ` Greg Kroah-Hartman
2020-09-29 22:04 ` Tony Asleson
2020-09-30 7:38 ` Greg Kroah-Hartman
2020-09-30 7:40 ` Greg Kroah-Hartman
2020-09-30 14:35 ` Tony Asleson
2020-10-01 11:48 ` Greg Kroah-Hartman
2020-10-07 20:10 ` Tony Asleson
2020-10-08 4:48 ` Greg Kroah-Hartman
2020-10-08 20:49 ` Martin K. Petersen
2020-10-08 5:54 ` Hannes Reinecke
2020-10-08 6:22 ` Finn Thain
2020-09-25 16:19 ` [v5 02/12] create_syslog_header: Add durable name Tony Asleson
2020-09-25 16:19 ` [v5 03/12] dev_vprintk_emit: Increase hdr size Tony Asleson
2020-09-25 16:19 ` [v5 04/12] scsi: Add durable_name for dev_printk Tony Asleson
2020-09-25 16:19 ` [v5 05/12] nvme: Add durable name " Tony Asleson
2020-09-25 16:19 ` [v5 06/12] libata: Add ata_scsi_durable_name Tony Asleson
2020-09-25 16:19 ` [v5 07/12] libata: Make ata_scsi_durable_name static Tony Asleson
2020-09-26 8:40 ` Sergei Shtylyov
2020-09-26 14:17 ` Tony Asleson
2020-09-26 15:57 ` James Bottomley
2020-09-28 20:35 ` Tony Asleson
2020-09-25 16:19 ` [v5 08/12] Add durable_name_printk Tony Asleson
2020-09-26 23:53 ` Randy Dunlap
2020-09-28 15:52 ` Tony Asleson
2020-09-28 17:32 ` Randy Dunlap
2020-09-25 16:19 ` [v5 09/12] libata: use durable_name_printk Tony Asleson
2020-09-25 16:19 ` [v5 10/12] Add durable_name_printk_ratelimited Tony Asleson
2020-09-25 16:19 ` [v5 11/12] print_req_error: Use durable_name_printk_ratelimited Tony Asleson
2020-09-25 16:19 ` [v5 12/12] buffer_io_error: " Tony Asleson
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=f276f116-a80c-fb98-0569-d7a6799868d4@gmail.com \
--to=sergei.shtylyov@gmail.com \
--cc=linux-block@vger.kernel.org \
--cc=linux-ide@vger.kernel.org \
--cc=linux-scsi@vger.kernel.org \
--cc=tasleson@redhat.com \
/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).