From: Cornelia Huck <cohuck@redhat.com>
To: Parav Pandit <parav@mellanox.com>
Cc: "alex.williamson@redhat.com" <alex.williamson@redhat.com>,
Jiri Pirko <jiri@mellanox.com>,
"kwankhede@nvidia.com" <kwankhede@nvidia.com>,
"davem@davemloft.net" <davem@davemloft.net>,
"kvm@vger.kernel.org" <kvm@vger.kernel.org>,
"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
"netdev@vger.kernel.org" <netdev@vger.kernel.org>
Subject: Re: [PATCH v2 5/6] mdev: Update sysfs documentation
Date: Mon, 2 Sep 2019 16:36:58 +0200 [thread overview]
Message-ID: <20190902163658.51fc48d2.cohuck@redhat.com> (raw)
In-Reply-To: <AM0PR05MB4866372C521F59491838C8E4D1BD0@AM0PR05MB4866.eurprd05.prod.outlook.com>
On Fri, 30 Aug 2019 13:10:17 +0000
Parav Pandit <parav@mellanox.com> wrote:
> > -----Original Message-----
> > From: Cornelia Huck <cohuck@redhat.com>
> > Sent: Friday, August 30, 2019 6:19 PM
> > To: Parav Pandit <parav@mellanox.com>
> > Cc: alex.williamson@redhat.com; Jiri Pirko <jiri@mellanox.com>;
> > kwankhede@nvidia.com; davem@davemloft.net; kvm@vger.kernel.org; linux-
> > kernel@vger.kernel.org; netdev@vger.kernel.org
> > Subject: Re: [PATCH v2 5/6] mdev: Update sysfs documentation
> >
> > On Thu, 29 Aug 2019 06:19:03 -0500
> > Parav Pandit <parav@mellanox.com> wrote:
> >
> > > Updated documentation for optional read only sysfs attribute.
> >
> > I'd probably merge this into the patch introducing the attribute.
> >
> Ok. I will spin v3.
>
> > >
> > > Signed-off-by: Parav Pandit <parav@mellanox.com>
> > > ---
> > > Documentation/driver-api/vfio-mediated-device.rst | 5 +++++
> > > 1 file changed, 5 insertions(+)
> > >
> > > diff --git a/Documentation/driver-api/vfio-mediated-device.rst
> > > b/Documentation/driver-api/vfio-mediated-device.rst
> > > index 25eb7d5b834b..0ab03d3f5629 100644
> > > --- a/Documentation/driver-api/vfio-mediated-device.rst
> > > +++ b/Documentation/driver-api/vfio-mediated-device.rst
> > > @@ -270,6 +270,7 @@ Directories and Files Under the sysfs for Each mdev
> > Device
> > > |--- remove
> > > |--- mdev_type {link to its type}
> > > |--- vendor-specific-attributes [optional]
> > > + |--- alias [optional]
> >
> > "optional" implies "not always present" to me, not "might return a read error if
> > not available". Don't know if there's a better way to tag this? Or make it really
> > optional? :)
>
> May be write it as,
>
> alias [ optional when requested by parent ]
I'm not sure what 'optional when requested' is supposed to mean...
maybe something like 'content optional' or so?
>
> >
> > >
> > > * remove (write only)
> > >
> > > @@ -281,6 +282,10 @@ Example::
> > >
> > > # echo 1 > /sys/bus/mdev/devices/$mdev_UUID/remove
> > >
> > > +* alias (read only)
> > > +Whenever a parent requested to generate an alias, each mdev is
> > > +assigned a unique alias by the mdev core. This file shows the alias of the
> > mdev device.
> >
> > It's not really the parent, but the vendor driver requesting this, right? Also,
> At mdev level, it only knows parent->ops structure, whether parent is registered by vendor driver or something else.
Who else is supposed to create the mdev device?
>
> > "each mdev" is a bit ambiguous,
> It is in context of the parent. Sentence is not starting with "each mdev".
> But may be more verbosely written as,
>
> Whenever a parent requested to generate an alias, Each mdev device of such parent is assigned
> unique alias by the mdev core. This file shows the alias of the mdev device.
I'd really leave the parent out of this: this seems more like an
implementation detail. It's more that alias may either contain an
alias, or return a read error if no alias has been generated. Who
requested the alias to be generated is probably not really of interest
to the userspace reader.
>
> > created via that driver. Lastly, if we stick with the "returns an error if not
> > implemented" approach, that should also be mentioned here.
> Ok. Will spin v3 to describe it.
>
> >
> > > +
> > > Mediated device Hot plug
> > > ------------------------
> > >
>
next prev parent reply other threads:[~2019-09-02 14:37 UTC|newest]
Thread overview: 96+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-08-26 20:41 [PATCH 0/4] Introduce variable length mdev alias Parav Pandit
2019-08-26 20:41 ` [PATCH 1/4] mdev: Introduce sha1 based " Parav Pandit
2019-08-27 1:44 ` Alex Williamson
2019-08-27 1:51 ` Alex Williamson
2019-08-27 4:24 ` Parav Pandit
2019-08-27 10:24 ` Cornelia Huck
2019-08-27 11:12 ` Parav Pandit
2019-08-27 11:24 ` Cornelia Huck
2019-08-27 11:33 ` Parav Pandit
2019-08-27 11:41 ` Cornelia Huck
2019-08-27 11:57 ` Parav Pandit
2019-08-27 13:35 ` Cornelia Huck
2019-08-27 16:50 ` Alex Williamson
2019-08-27 11:16 ` Parav Pandit
2019-08-26 20:41 ` [PATCH 2/4] mdev: Make mdev alias unique among all mdevs Parav Pandit
2019-08-26 23:02 ` Mark Bloch
2019-08-27 4:28 ` Parav Pandit
2019-08-27 15:23 ` Alex Williamson
2019-08-27 16:16 ` Parav Pandit
2019-08-27 10:29 ` Cornelia Huck
2019-08-27 11:08 ` Parav Pandit
2019-08-27 11:29 ` Cornelia Huck
2019-08-27 15:28 ` Alex Williamson
2019-08-27 15:39 ` Cornelia Huck
2019-08-27 16:13 ` Parav Pandit
2019-08-27 16:24 ` Alex Williamson
2019-08-27 18:54 ` Parav Pandit
2019-08-26 20:41 ` [PATCH 3/4] mdev: Expose mdev alias in sysfs tree Parav Pandit
2019-08-27 1:53 ` Alex Williamson
2019-08-27 3:30 ` Parav Pandit
2019-08-27 10:47 ` Cornelia Huck
2019-08-27 11:07 ` Parav Pandit
2019-08-27 11:34 ` Cornelia Huck
2019-08-27 11:52 ` Parav Pandit
2019-08-27 11:55 ` Cornelia Huck
2019-08-27 12:00 ` Parav Pandit
2019-08-26 20:41 ` [PATCH 4/4] mtty: Optionally support mtty alias Parav Pandit
2019-08-27 13:11 ` [PATCH 0/4] Introduce variable length mdev alias Parav Pandit
2019-08-27 13:31 ` Cornelia Huck
2019-08-27 17:48 ` Alex Williamson
2019-08-27 18:11 ` Parav Pandit
2019-08-27 19:16 ` [PATCH v1 0/5] " Parav Pandit
2019-08-27 19:16 ` [PATCH v1 1/5] mdev: Introduce sha1 based " Parav Pandit
2019-08-28 21:25 ` Alex Williamson
2019-08-28 21:34 ` Alex Williamson
2019-08-29 9:07 ` Parav Pandit
2019-08-29 9:06 ` Parav Pandit
2019-08-27 19:16 ` [PATCH v1 2/5] mdev: Make mdev alias unique among all mdevs Parav Pandit
2019-08-28 21:36 ` Alex Williamson
2019-08-29 9:07 ` Parav Pandit
2019-08-27 19:16 ` [PATCH v1 3/5] mdev: Expose mdev alias in sysfs tree Parav Pandit
2019-08-27 19:16 ` [PATCH v1 4/5] mdev: Update sysfs documentation Parav Pandit
2019-08-27 19:16 ` [PATCH v1 5/5] mtty: Optionally support mtty alias Parav Pandit
2019-08-29 11:18 ` [PATCH v2 0/6] Introduce variable length mdev alias Parav Pandit
2019-08-29 11:18 ` [PATCH v2 1/6] mdev: Introduce sha1 based " Parav Pandit
2019-08-29 12:26 ` Yunsheng Lin
2019-08-30 2:27 ` Parav Pandit
2019-08-30 9:17 ` Cornelia Huck
2019-08-30 12:33 ` Parav Pandit
2019-08-30 12:39 ` Cornelia Huck
2019-08-30 12:58 ` Parav Pandit
2019-08-30 14:02 ` Cornelia Huck
2019-08-30 15:45 ` Parav Pandit
2019-09-02 14:46 ` Cornelia Huck
2019-09-03 3:47 ` Parav Pandit
2019-08-29 11:19 ` [PATCH v2 2/6] mdev: Make mdev alias unique among all mdevs Parav Pandit
2019-08-29 12:31 ` Yunsheng Lin
2019-08-30 12:40 ` Cornelia Huck
2019-08-30 12:59 ` Parav Pandit
2019-08-29 11:19 ` [PATCH v2 3/6] mdev: Expose mdev alias in sysfs tree Parav Pandit
2019-08-29 11:19 ` [PATCH v2 4/6] mdev: Introduce an API mdev_alias Parav Pandit
2019-08-29 11:19 ` [PATCH v2 5/6] mdev: Update sysfs documentation Parav Pandit
2019-08-30 12:49 ` Cornelia Huck
2019-08-30 13:10 ` Parav Pandit
2019-09-02 14:36 ` Cornelia Huck [this message]
2019-09-03 3:53 ` Parav Pandit
2019-08-29 11:19 ` [PATCH v2 6/6] mtty: Optionally support mtty alias Parav Pandit
2019-09-02 4:24 ` [PATCH v3 0/5] Introduce variable length mdev alias Parav Pandit
2019-09-02 4:24 ` [PATCH v3 1/5] mdev: Introduce sha1 based " Parav Pandit
2019-09-17 10:03 ` Cornelia Huck
2019-09-02 4:24 ` [PATCH v3 2/5] mdev: Make mdev alias unique among all mdevs Parav Pandit
2019-09-17 10:04 ` Cornelia Huck
2019-09-02 4:24 ` [PATCH v3 3/5] mdev: Expose mdev alias in sysfs tree Parav Pandit
2019-09-17 10:08 ` Cornelia Huck
2019-09-02 4:24 ` [PATCH v3 4/5] mdev: Introduce an API mdev_alias Parav Pandit
2019-09-17 10:10 ` Cornelia Huck
2019-09-02 4:24 ` [PATCH v3 5/5] mtty: Optionally support mtty alias Parav Pandit
2019-09-09 20:42 ` [PATCH v3 0/5] Introduce variable length mdev alias Parav Pandit
2019-09-11 13:56 ` Alex Williamson
2019-09-11 15:30 ` Parav Pandit
2019-09-11 16:29 ` Cornelia Huck
2019-09-11 16:38 ` Parav Pandit
2019-09-13 21:32 ` Alex Williamson
2019-09-13 23:19 ` Parav Pandit
2019-09-17 10:13 ` Cornelia Huck
2019-09-18 17:15 ` Parav Pandit
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=20190902163658.51fc48d2.cohuck@redhat.com \
--to=cohuck@redhat.com \
--cc=alex.williamson@redhat.com \
--cc=davem@davemloft.net \
--cc=jiri@mellanox.com \
--cc=kvm@vger.kernel.org \
--cc=kwankhede@nvidia.com \
--cc=linux-kernel@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=parav@mellanox.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).