[4/4] doc: update release notes for enic

Message ID 20181210182857.13043-5-hyonkim@cisco.com (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers
Series net/enic: minor updates |

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/Intel-compilation success Compilation OK

Commit Message

Hyong Youb Kim (hyonkim) Dec. 10, 2018, 6:28 p.m. UTC
  Signed-off-by: Hyong Youb Kim <hyonkim@cisco.com>
Reviewed-by: John Daley <johndale@cisco.com>
---
 doc/guides/rel_notes/release_19_02.rst | 5 +++++
 1 file changed, 5 insertions(+)
  

Comments

Varghese, Vipin Dec. 11, 2018, 2:44 a.m. UTC | #1
Hi Hyong,

Thanks for sharing the information a query 'is ENIC Poll Mode Driver is been updated too?'(Section 16 under Network Interface Controller). 
a. If yes is it ok to link the patchwork in comment section? 
b. If no, will you be updating the documentation?

Thanks
Vipin Varghese

> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Hyong Youb Kim
> Sent: Monday, December 10, 2018 11:59 PM
> To: Yigit, Ferruh <ferruh.yigit@intel.com>
> Cc: dev@dpdk.org; John Daley <johndale@cisco.com>; Hyong Youb Kim
> <hyonkim@cisco.com>
> Subject: [dpdk-dev] [PATCH 4/4] doc: update release notes for enic
> 
> Signed-off-by: Hyong Youb Kim <hyonkim@cisco.com>
> Reviewed-by: John Daley <johndale@cisco.com>
> ---
>  doc/guides/rel_notes/release_19_02.rst | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/release_19_02.rst
> b/doc/guides/rel_notes/release_19_02.rst
> index a94fa86a7..4c789d2a9 100644
> --- a/doc/guides/rel_notes/release_19_02.rst
> +++ b/doc/guides/rel_notes/release_19_02.rst
> @@ -54,6 +54,11 @@ New Features
>       Also, make sure to start the actual text at the margin.
>       =========================================================
> 
> +* **Updated the enic driver.**
> +
> +  * Added support for ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
> +  * Added the handler to get firmware version string.
> +  * Added support for multicast filtering.
> 
>  Removed Items
>  -------------
> --
> 2.16.2
  
Hyong Youb Kim (hyonkim) Dec. 11, 2018, 4:08 p.m. UTC | #2
On Tue, Dec 11, 2018 at 02:44:43AM +0000, Varghese, Vipin wrote:
> Hi Hyong,
> 
> Thanks for sharing the information a query 'is ENIC Poll Mode Driver is been updated too?'(Section 16 under Network Interface Controller). 
> a. If yes is it ok to link the patchwork in comment section? 
> b. If no, will you be updating the documentation?
> 

Vipin,

I am not planning to update the enic guide, as these changes (fw
version string, multicast filtering) do not need additional
explanations. Did you have something else in mind?

Thanks..
-Hyong
  
Varghese, Vipin Dec. 11, 2018, 4:31 p.m. UTC | #3
Hi Hyong,

snipped
> > Hi Hyong,
> >
> > Thanks for sharing the information a query 'is ENIC Poll Mode Driver is been
> updated too?'(Section 16 under Network Interface Controller).
> > a. If yes is it ok to link the patchwork in comment section?
> > b. If no, will you be updating the documentation?
> >
> 
> Vipin,
> 
> I am not planning to update the enic guide, as these changes (fw version string,
> multicast filtering) do not need additional explanations. Did you have
> something else in mind?

Thanks for sharing the information.

In my humble opinion

In documentation section '16.13. Supported features' states 'Unicast, multicast and broadcast transmission and reception'. So multicast 'filtering' to be added as supported feature or not is upto the individual for the PMD. But as you shared the information ' I am not planning to update the enic guide' I will leave this open to others for comment.

Question: Will there update for test cases for mac filtering been added? Reason the patch set is not covering test case addition. 

> 
> Thanks..
> -Hyong
  
Hyong Youb Kim (hyonkim) Dec. 11, 2018, 4:40 p.m. UTC | #4
On Tue, Dec 11, 2018 at 04:31:50PM +0000, Varghese, Vipin wrote:
> Hi Hyong,
> 
> snipped
> > > Hi Hyong,
> > >
> > > Thanks for sharing the information a query 'is ENIC Poll Mode Driver is been
> > updated too?'(Section 16 under Network Interface Controller).
> > > a. If yes is it ok to link the patchwork in comment section?
> > > b. If no, will you be updating the documentation?
> > >
> > 
> > Vipin,
> > 
> > I am not planning to update the enic guide, as these changes (fw version string,
> > multicast filtering) do not need additional explanations. Did you have
> > something else in mind?
> 
> Thanks for sharing the information.
> 
> In my humble opinion
> 
> In documentation section '16.13. Supported features' states 'Unicast, multicast and broadcast transmission and reception'. So multicast 'filtering' to be added as supported feature or not is upto the individual for the PMD. But as you shared the information ' I am not planning to update the enic guide' I will leave this open to others for comment.

I see what you mean now. Sure, I will send another patch to update
that section later. As is, it is really a duplicate of
doc/guides/nics/features. Not sure if we want to keep maintaining two
copies of the same information.

> 
> Question: Will there update for test cases for mac filtering been added? Reason the patch set is not covering test case addition. 
> 

We have an internal DTS based test case for multicast filtering. Do we
need to mention test cases in commit logs now? I am a bit confused
where this question is coming from..

-Hyong
  
Varghese, Vipin Dec. 11, 2018, 4:49 p.m. UTC | #5
snipped
> > Hi Hyong,
> >
> > snipped
> > > > Hi Hyong,
> > > >
> > > > Thanks for sharing the information a query 'is ENIC Poll Mode
> > > > Driver is been
> > > updated too?'(Section 16 under Network Interface Controller).
> > > > a. If yes is it ok to link the patchwork in comment section?
> > > > b. If no, will you be updating the documentation?
> > > >
> > >
> > > Vipin,
> > >
> > > I am not planning to update the enic guide, as these changes (fw
> > > version string, multicast filtering) do not need additional
> > > explanations. Did you have something else in mind?
> >
> > Thanks for sharing the information.
> >
> > In my humble opinion
> >
> > In documentation section '16.13. Supported features' states 'Unicast,
> multicast and broadcast transmission and reception'. So multicast 'filtering' to
> be added as supported feature or not is upto the individual for the PMD. But
> as you shared the information ' I am not planning to update the enic guide' I
> will leave this open to others for comment.
> 
> I see what you mean now. Sure, I will send another patch to update that
> section later. As is, it is really a duplicate of doc/guides/nics/features. Not sure
> if we want to keep maintaining two copies of the same information.
> 
> >
> > Question: Will there update for test cases for mac filtering been added?
> Reason the patch set is not covering test case addition.
> >
> 
> We have an internal DTS based test case for multicast filtering. Do we need to
> mention test cases in commit logs now? I am a bit confused where this
> question is coming from..

Apologies if the question was not clear, Let me try again 'Is there plan add test cases under dpdk/test/test folder?'

> 
> -Hyong
  
Hyong Youb Kim (hyonkim) Dec. 11, 2018, 5:25 p.m. UTC | #6
On Tue, Dec 11, 2018 at 04:49:26PM +0000, Varghese, Vipin wrote:
> snipped
[...]
> 
> Apologies if the question was not clear, Let me try again 'Is there plan add test cases under dpdk/test/test folder?'

Not in this cycle.

Thanks.
-Hyong
  
Varghese, Vipin Dec. 12, 2018, 2:23 a.m. UTC | #7
> -----Original Message-----
> From: Hyong Youb Kim <hyonkim@cisco.com>
> Sent: Tuesday, December 11, 2018 10:56 PM
> To: Varghese, Vipin <vipin.varghese@intel.com>
> Cc: Yigit, Ferruh <ferruh.yigit@intel.com>; dev@dpdk.org; John Daley
> <johndale@cisco.com>
> Subject: Re: [dpdk-dev] [PATCH 4/4] doc: update release notes for enic
> 
> On Tue, Dec 11, 2018 at 04:49:26PM +0000, Varghese, Vipin wrote:
> > snipped
> [...]
> >
> > Apologies if the question was not clear, Let me try again 'Is there plan add
> test cases under dpdk/test/test folder?'
> 
> Not in this cycle.

Thanks for update, hope we can see some unit test for enabling multicast filtering in upcoming cycles.

> 
> Thanks.
> -Hyong
  

Patch

diff --git a/doc/guides/rel_notes/release_19_02.rst b/doc/guides/rel_notes/release_19_02.rst
index a94fa86a7..4c789d2a9 100644
--- a/doc/guides/rel_notes/release_19_02.rst
+++ b/doc/guides/rel_notes/release_19_02.rst
@@ -54,6 +54,11 @@  New Features
      Also, make sure to start the actual text at the margin.
      =========================================================
 
+* **Updated the enic driver.**
+
+  * Added support for ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
+  * Added the handler to get firmware version string.
+  * Added support for multicast filtering.
 
 Removed Items
 -------------