diff mbox series

doc: propose correction rte_bsf64 return type declaration

Message ID 1615418650-19513-1-git-send-email-roretzla@linux.microsoft.com (mailing list archive)
State Superseded, archived
Delegated to: David Marchand
Headers
Series doc: propose correction rte_bsf64 return type declaration |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/travis-robot success travis build: passed
ci/github-robot success github build: passed
ci/intel-Testing success Testing PASS

Commit Message

Tyler Retzlaff March 10, 2021, 11:24 p.m. UTC 
  It is clear from the change that introduced the rte_bsf64 inline
function and an evaluation of usage that the initial revision was
intended to return uint32_t and not int.

It is proposed the return type of int be changed to uint32_t.

-static inline int
+static inline uint32_t
 rte_bsf64(uint64_t v)
 {
        return (uint32_t)__builtin_ctzll(v);
 }

Signed-off-by: Tyler Retzlaff <roretzla@linux.microsoft.com>
---
 doc/guides/rel_notes/deprecation.rst | 3 +++
 1 file changed, 3 insertions(+)
diff mbox series

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 64629e064..7ba86024a 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -17,6 +17,9 @@  Deprecation Notices
 * eal: The function ``rte_eal_remote_launch`` will return new error codes
   after read or write error on the pipe, instead of calling ``rte_panic``.
 
+* eal: The inline function ``rte_bsf64`` will be changed to return ``uint32_t``
+  instead of ``int`` as originally intended.
+
 * rte_atomicNN_xxx: These APIs do not take memory order parameter. This does
   not allow for writing optimized code for all the CPU architectures supported
   in DPDK. DPDK will adopt C11 atomic operations semantics and provide wrappers