diff mbox series

doc: update release notes for default KNI carries status

Message ID 20181105172844.72228-1-ferruh.yigit@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers show
Series doc: update release notes for default KNI carries status | expand

Checks

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

Commit Message

Ferruh Yigit Nov. 5, 2018, 5:28 p.m. UTC
Commit 89397a01ce4a ("kni: set default carrier state of interface")
changes the KNI interface default carrier status. Which prevents traffic
flow by default and may break some existing usage / testing.

Document this behavior change in release notes.

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
Cc: Dan Gora <dg@adax.com>
---
 doc/guides/rel_notes/release_18_11.rst | 7 +++++++
 1 file changed, 7 insertions(+)

Comments

Dan Gora Nov. 5, 2018, 6:12 p.m. UTC | #1
Hi Ferruh,

On Mon, Nov 5, 2018 at 3:28 PM Ferruh Yigit <ferruh.yigit@intel.com> wrote:
>
> Commit 89397a01ce4a ("kni: set default carrier state of interface")
> changes the KNI interface default carrier status. Which prevents traffic
> flow by default and may break some existing usage / testing.
>
> Document this behavior change in release notes.
>
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>

Sorry about this.. I guess I should have done this with the patch series...

The changes here don't include the new module parameter to the KNI
kernel module.  I'll send a new release note patch in a few minutes
which hopefully covers everything.  I guess the test plan
documentation needs to be updated as well, but I don't know where
those documents live.  Are they separate from the main DPDK source?


thanks
dan
Ferruh Yigit Nov. 5, 2018, 6:21 p.m. UTC | #2
On 11/5/2018 6:12 PM, Dan Gora wrote:
> Hi Ferruh,
> 
> On Mon, Nov 5, 2018 at 3:28 PM Ferruh Yigit <ferruh.yigit@intel.com> wrote:
>>
>> Commit 89397a01ce4a ("kni: set default carrier state of interface")
>> changes the KNI interface default carrier status. Which prevents traffic
>> flow by default and may break some existing usage / testing.
>>
>> Document this behavior change in release notes.
>>
>> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
> 
> Sorry about this.. I guess I should have done this with the patch series...
> 
> The changes here don't include the new module parameter to the KNI
> kernel module.  I'll send a new release note patch in a few minutes
> which hopefully covers everything.  I guess the test plan
> documentation needs to be updated as well, but I don't know where
> those documents live.  Are they separate from the main DPDK source?

There is no test plan documentation within dpdk repo. There is DTS (dpdk test
suit) in a separate repo [1], which needs to be updated, and indeed this patch
is to point them the change because existing test is failing after changes...

[1]
https://git.dpdk.org/tools/dts/
Dan Gora Nov. 5, 2018, 6:23 p.m. UTC | #3
On Mon, Nov 5, 2018 at 4:21 PM Ferruh Yigit <ferruh.yigit@intel.com> wrote:
> There is no test plan documentation within dpdk repo. There is DTS (dpdk test
> suit) in a separate repo [1], which needs to be updated, and indeed this patch
> is to point them the change because existing test is failing after changes...
>
> [1]
> https://git.dpdk.org/tools/dts/

Should patches for the DTS get sent to this list (dev@dpdk.org) as
well or is there are separate list for those?
Dan Gora Nov. 5, 2018, 6:34 p.m. UTC | #4
On Mon, Nov 5, 2018 at 4:23 PM Dan Gora <dg@adax.com> wrote:
>
> On Mon, Nov 5, 2018 at 4:21 PM Ferruh Yigit <ferruh.yigit@intel.com> wrote:
> > There is no test plan documentation within dpdk repo. There is DTS (dpdk test
> > suit) in a separate repo [1], which needs to be updated, and indeed this patch
> > is to point them the change because existing test is failing after changes...
> >
> > [1]
> > https://git.dpdk.org/tools/dts/
>
> Should patches for the DTS get sent to this list (dev@dpdk.org) as
> well or is there are separate list for those?

Never mind.. It's in the CONTRIBUTING.TXT file.. RTFM, dan..

======
Contributions to DTS should be submitted as git formatted patches to the
DTS mailing list: dts@dpdk.org
======
Thomas Monjalon Nov. 18, 2018, 11:24 p.m. UTC | #5
05/11/2018 18:28, Ferruh Yigit:
> Commit 89397a01ce4a ("kni: set default carrier state of interface")
> changes the KNI interface default carrier status. Which prevents traffic
> flow by default and may break some existing usage / testing.
> 
> Document this behavior change in release notes.
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>

Applied, thanks
diff mbox series

Patch

diff --git a/doc/guides/rel_notes/release_18_11.rst b/doc/guides/rel_notes/release_18_11.rst
index 6ce276b22..69c4d1bf6 100644
--- a/doc/guides/rel_notes/release_18_11.rst
+++ b/doc/guides/rel_notes/release_18_11.rst
@@ -383,6 +383,13 @@  API Changes
   This means ``ethtool "-a|--show-pause", "-s|--change"`` won't work, and
   ``ethtool <iface>`` output will have less information.
 
+* KNI, by default interface carrier status is ``off`` which means there won't be any traffic.
+  It can be set to ``on`` via ``rte_kni_update_link()`` API or via ``sysfs`` interface:
+  ``echo 1 > /sys/class/net/vEth0/carrier``. Note interface should be ``up`` to be able
+  to read/write sysfs interface.
+  When KNI sample application is used ``-m`` parameter can be used to automatically update
+  the carrier status for the interface.
+
 
 ABI Changes
 -----------