[dpdk-dev] [PATCH 1/8] ionic: update documentation and MAINTAINERS

[Andrew Boyer]

> On Nov 3, 2020, at 7:35 AM, Ferruh Yigit <ferruh.yigit at intel.com> wrote:
> 
> On 11/2/2020 6:35 PM, Andrew Boyer wrote:
>> The ionic PMD is being actively maintained.
>> Signed-off-by: Andrew Boyer <aboyer at pensando.io>
>> ---
>>  MAINTAINERS               |  5 +++--
>>  doc/guides/nics/ionic.rst | 13 +++++++------
>>  2 files changed, 10 insertions(+), 8 deletions(-)
>> diff --git a/MAINTAINERS b/MAINTAINERS
>> index 5b390d1d8..7afed5f0a 100644
>> --- a/MAINTAINERS
>> +++ b/MAINTAINERS
>> @@ -842,8 +842,9 @@ F: doc/guides/nics/pfe.rst
>>  F: drivers/net/pfe/
>>  F: doc/guides/nics/features/pfe.ini
>>  -Pensando ionic - UNMAINTAINED
> 
> The trigger to mark PMD unmaintained was it didn't comply with new close dev_ops behavior [1], can you please make that patch before updating the status?

I have the change for this, but we’re not ready to submit yet. This was just the initial batch of harmless stuff. I’ll hold off on removing the status.

> [1]
> https://patches.dpdk.org/project/dpdk/list/?series=12565&state=* <https://patches.dpdk.org/project/dpdk/list/?series=12565&state=*>
> 
>> -M: Alfredo Cardigliano <cardigliano at ntop.org <mailto:cardigliano at ntop.org>>
>> +Pensando ionic
>> +M: Andrew Boyer <aboyer at pensando.io <mailto:aboyer at pensando.io>>
>> +M: Pensando Drivers <drivers at pensando.io <mailto:drivers at pensando.io>>
> 
> Hi Andrew, Welcome.
> 
> I think better to not include the group as maintainer, it is very hard to follow who is behind it and who it actually responsible when a group is added.
> Can we just use actual people for the maintainer?

Does it hurt to have the list there? We can pledge to always have at least one real person. The ‘UNMAINTAINED’ thing above arose because the listed maintainer wasn’t actually a maintainer any more and no one else at the company was able to respond in time. Especially at a startup, it would be nice to have the list as a backup. That’s what we do for the Linux kernel, too.

>>  F: drivers/net/ionic/
>>  F: doc/guides/nics/ionic.rst
>>  F: doc/guides/nics/features/ionic.ini
>> diff --git a/doc/guides/nics/ionic.rst b/doc/guides/nics/ionic.rst
>> index fd32926bf..2a394d15d 100644
>> --- a/doc/guides/nics/ionic.rst
>> +++ b/doc/guides/nics/ionic.rst
>> @@ -1,5 +1,5 @@
>>  ..  SPDX-License-Identifier: (BSD-3-Clause OR GPL-2.0)
>> -    Copyright(c) 2018-2019 Pensando Systems, Inc. All rights reserved.
>> +    Copyright(c) 2018-2020 Pensando Systems, Inc. All rights reserved.
>>    IONIC Driver
>>  ============
>> @@ -7,15 +7,16 @@ IONIC Driver
>>  The ionic driver provides support for Pensando server adapters.
>>  It currently supports the below models:
>>  -- `Naples DSC-25 <https://pensando.io/assets/documents/Naples-25_ProductBrief_10-2019.pdf>`_
>> -- `Naples DSC-100 <https://pensando.io/assets/documents/Naples_100_ProductBrief-10-2019.pdf>`_
>> +- DSC-25 dual-port 25G Distributed Services Card
>> +- DSC-100 dual-port 100G Distributed Services Card
> 
> It was good to have product documentation, I see the old ones are not available now but can it be possible to replace with valid ones instead of removing?

The updated documents are available at the link listed right below (Documents page). I don’t control the URLs on the public-facing web site so it would be better going forward to not list the individual PDFs, IMO.

>>  -Please visit https://pensando.io for more information.
>> +Please visit the Pensando web site at https://pensando.io for more information.
>> +The `Documents <https://pensando.io/documents/>`_ page contains Product Briefs and other product information.
>>    Identifying the Adapter
>>  -----------------------
>>  -To find if one or more Pensando PCI Ethernet devices are installed
>> +To determine if one or more Pensando DSC Ethernet devices are installed
>>  on the host, check for the PCI devices:
>>       .. code-block:: console
>> @@ -28,6 +29,6 @@ on the host, check for the PCI devices:
>>  Building DPDK
>>  -------------
>>  -The ionic PMD driver supports UIO and VFIO, please refer to the
>> +The ionic PMD driver supports UIO and VFIO. Please refer to the
> 
> I think "PMD driver" is wrong since 'PMD' is "poll mode driver"

Send me your SSN number and your code for the ATM machine, and then we’ll talk... <kidding> Will fix

-Andrew