diff mbox series

[RFC,v2,01/17] doc: document intention to deprecate RTE_LOGTYPE_USER*

Message ID 20230207230438.1617331-2-stephen@networkplumber.org (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series static logtype removal |

Commit Message

Stephen Hemminger Feb. 7, 2023, 11:04 p.m. UTC 
  These static log types should be deprecated in next stable
release.

Also, remove use of USER1 from example of doing mlockall.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/prog_guide/writing_efficient_code.rst | 3 +--
 doc/guides/rel_notes/deprecation.rst             | 4 ++++
 2 files changed, 5 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/doc/guides/prog_guide/writing_efficient_code.rst b/doc/guides/prog_guide/writing_efficient_code.rst
index e6c26efdd3a3..250e06bd734f 100644
--- a/doc/guides/prog_guide/writing_efficient_code.rst
+++ b/doc/guides/prog_guide/writing_efficient_code.rst
@@ -89,8 +89,7 @@  To avoid these you could pre-load, and lock them into memory with the ``mlockall
 .. code-block:: c
 
     if (mlockall(MCL_CURRENT | MCL_FUTURE)) {
-        RTE_LOG(NOTICE, USER1, "mlockall() failed with error \"%s\"\n",
-                strerror(errno));
+        perror("mlockall");
     }
 
 Communication Between lcores
diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index ac9aa7630b61..935e68134d0e 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -136,3 +136,7 @@  Deprecation Notices
   Its removal has been postponed to let potential users report interest
   in maintaining it.
   In the absence of such interest, this library will be removed in DPDK 23.11.
+
+* rte_log: The pre-defined RTE_LOGTYPE_USER* macros are planned to be
+  deprecated starting with the 23.07 release. Applications should use the
+  dynamic log types available with RTE_LOG_REGISTER instead.