From: "Burakov, Anatoly" <anatoly.burakov@intel.com>
To: "Iremonger, Bernard" <bernard.iremonger@intel.com>,
"dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH v1 1/1] doc: clarify vfio doc for built-in modules
Date: Wed, 27 Oct 2021 16:35:53 +0100 [thread overview]
Message-ID: <47997792-2cfe-7b48-2b6d-0bd115401332@intel.com> (raw)
In-Reply-To: <DM6PR11MB28909E12B069C98F8D3BAFFEEFB89@DM6PR11MB2890.namprd11.prod.outlook.com>
On 14-Oct-21 8:47 PM, Iremonger, Bernard wrote:
>
> Hi Anatoly,
>
>> -----Original Message-----
>> From: dev <dev-bounces@dpdk.org> On Behalf Of Anatoly Burakov
>> Sent: Thursday, October 14, 2021 1:53 PM
>> To: dev@dpdk.org
>> Subject: [dpdk-dev] [PATCH v1 1/1] doc: clarify vfio doc for built-in modules
>>
>> Currently, the documentation only contains instructions for enabling SRIOV
>> support for VFIO compiled as a module, but doesn't have any instructions on
>> how to do the same for cases where VFIO is built-in.
>> Add these instructions.
>>
>> Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
>> ---
>> doc/guides/linux_gsg/linux_drivers.rst | 6 ++++++
>> 1 file changed, 6 insertions(+)
>>
>> diff --git a/doc/guides/linux_gsg/linux_drivers.rst
>> b/doc/guides/linux_gsg/linux_drivers.rst
>> index c6b6881ea2..2dd711bb37 100644
>> --- a/doc/guides/linux_gsg/linux_drivers.rst
>> +++ b/doc/guides/linux_gsg/linux_drivers.rst
>> @@ -65,6 +65,12 @@ The token will be used for all PF and VF ports within
>> the application.
>>
>> sudo modprobe vfio-pci enable_sriov=1
>>
>> + Alternatively, pass the ``enable_sriov`` parameter through the ``sysfs`` if
>> the module is already loaded or is built-in:
>
> Probably better to wrap above line as quite long.
>
I believe the general consensus on docs is that we should leave the
lines to be long.
>> +
>> + .. code-block:: console
>> +
>> + echo 1 | sudo tee /sys/module/vfio_pci/parameters/enable_sriov
>> +
>> #. Bind the PCI devices to ``vfio-pci`` driver
>>
>> .. code-block:: console
>> --
>> 2.25.1
>
> ~/dpdk_21_11/devtools# ./check-git-log.sh
> Wrong headline case:
> "doc: clarify vfio doc for built-in modules": vfio --> VFIO
>
> Invalid patch(es) found - checked 1 patch
>
Thanks, will fix in v2!
> Otherwise
> Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
>
--
Thanks,
Anatoly
next prev parent reply other threads:[~2021-10-27 15:39 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-14 12:52 Anatoly Burakov
2021-10-14 15:12 ` Bruce Richardson
2021-10-14 19:47 ` Iremonger, Bernard
2021-10-27 15:35 ` Burakov, Anatoly [this message]
2021-10-27 15:37 ` [dpdk-dev] [PATCH v2 1/1] doc: clarify VFIO " Anatoly Burakov
2021-10-28 8:14 ` David Marchand
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=47997792-2cfe-7b48-2b6d-0bd115401332@intel.com \
--to=anatoly.burakov@intel.com \
--cc=bernard.iremonger@intel.com \
--cc=dev@dpdk.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).