[v2] doc: add kni changes to release note

Message ID 20181105195413.24431-1-dg@adax.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [v2] doc: add kni changes to release note |

Checks

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

Commit Message

Dan Gora Nov. 5, 2018, 7:54 p.m. UTC
  Add the new module parameter for the KNI kernel module, the new command
line flag for the KNI sample application, and the new API function
'rte_kni_update_link()' to the release note.

Signed-off-by: Dan Gora <dg@adax.com>
---
 doc/guides/rel_notes/release_18_11.rst | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
  

Comments

Ferruh Yigit Nov. 14, 2018, 12:34 a.m. UTC | #1
On 11/5/2018 7:54 PM, Dan Gora wrote:
> Add the new module parameter for the KNI kernel module, the new command
> line flag for the KNI sample application, and the new API function
> 'rte_kni_update_link()' to the release note.
> 
> Signed-off-by: Dan Gora <dg@adax.com>

Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
  
Thomas Monjalon Nov. 18, 2018, 11:17 p.m. UTC | #2
14/11/2018 01:34, Ferruh Yigit:
> On 11/5/2018 7:54 PM, Dan Gora wrote:
> > Add the new module parameter for the KNI kernel module, the new command
> > line flag for the KNI sample application, and the new API function
> > 'rte_kni_update_link()' to the release note.
> > 
> > Signed-off-by: Dan Gora <dg@adax.com>
> 
> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>

Applied, thanks
  

Patch

diff --git a/doc/guides/rel_notes/release_18_11.rst b/doc/guides/rel_notes/release_18_11.rst
index cfa92b8c0..9486faa1f 100644
--- a/doc/guides/rel_notes/release_18_11.rst
+++ b/doc/guides/rel_notes/release_18_11.rst
@@ -301,6 +301,25 @@  New Features
   computation to the NIST Cryptographic Algorithm Validation Program (CAVP)
   test vectors.
 
+* **Updated KNI kernel module, rte_kni library, and KNI sample application.**
+
+  Updated the KNI kernel module with a new kernel module parameter,
+  ``carrier=[on|off]`` to allow the user to control the default carrier
+  state of KNI kernel network interfaces.  The default carrier state
+  is now set to ``off``, so the interfaces cannot be used until the
+  carrier state is set to ``on`` via ``rte_kni_update_link`` or
+  by writing ``1`` to ``/sys/devices/virtual/net/<iface>/carrier``.
+  In previous versions the default carrier state was left undefined.
+  See :doc:`../prog_guide/kernel_nic_interface` for more information.
+
+  Added the new API function ``rte_kni_update_link`` to allow the user
+  to set the carrier state of the KNI kernel network interface.
+
+  Added a new command line flag ``-m`` to the KNI sample application to
+  monitor and automatically reflect the physical NIC carrier state to the
+  KNI kernel network interface with the new ``rte_kni_update_link`` API.
+  See :doc:`../sample_app_ug/kernel_nic_interface` for more information.
+
 
 API Changes
 -----------