[dpdk-stable] [PATCH 4/4] doc/release notes: add note to 17.11 on cleanup

[Harry van Haaren]

This adds a note in the 17.11 release notes, which applies
only to 17.11-stable backport of the rte_service_finalize()
function. The note should be included in 17.11 notes somewhere.

The fix has a minimal code change in order to workaround the issue.

Signed-off-by: Harry van Haaren <harry.van.haaren at intel.com>
---

Cc: vipin.varghese at intel.com

 doc/guides/rel_notes/release_17_11.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/doc/guides/rel_notes/release_17_11.rst b/doc/guides/rel_notes/release_17_11.rst
index 016a08c..acc51b8 100644
--- a/doc/guides/rel_notes/release_17_11.rst
+++ b/doc/guides/rel_notes/release_17_11.rst
@@ -303,6 +303,19 @@ Resolved Issues
   atomic locking of the services has been fixed and refactored for readability.
 
 
+Known Issues
+------------
+
+* **Secondary processes must call rte_service_finalize to cleanup on exit**
+
+  As ``rte_eal_init()`` now allocates hugepage memory to enable service-cores
+  functionality, there is a requirement for applications to call
+  ``rte_service_finalize()`` to free this memory. Primary processes will
+  re-initialize hugepages - so this does not impact them significantly.
+  Secondary processes which start and stop frequently must call this function,
+  in order to not leak hugepage memory.
+
+
 API Changes
 -----------
 
-- 
2.7.4