hash: fix doxygen comments

Message ID 1630944163-363580-1-git-send-email-vladimir.medvedkin@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series hash: fix doxygen comments |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/github-robot: build success github build: passed
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS

Commit Message

Vladimir Medvedkin Sept. 6, 2021, 4:02 p.m. UTC
  Fixes: 7574c3ef7428 ("hash: add toeplitz algorithm used by RSS")
Cc: stable@dpdk.org

Signed-off-by: Vladimir Medvedkin <vladimir.medvedkin@intel.com>
---
 lib/hash/rte_thash.h | 13 +++++--------
 1 file changed, 5 insertions(+), 8 deletions(-)
  

Comments

John McNamara Sept. 10, 2021, 9:46 a.m. UTC | #1
> -----Original Message-----
> From: Medvedkin, Vladimir <vladimir.medvedkin@intel.com>
> Sent: Monday, September 6, 2021 5:03 PM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; stable@dpdk.org
> Subject: [PATCH] hash: fix doxygen comments
> 


The git diff makes this look like the ifdef is moving but I see that you are moving the doc into the right place so Doxygen can pick it up.

Acked-by: John McNamara <john.mcnamara@intel.com>
  
Thomas Monjalon Oct. 25, 2021, 4:43 p.m. UTC | #2
10/09/2021 11:46, Mcnamara, John:
> From: Medvedkin, Vladimir <vladimir.medvedkin@intel.com>
> 
> The git diff makes this look like the ifdef is moving but I see that you are moving the doc into the right place so Doxygen can pick it up.
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

title: hash: fix Doxygen comment of Toeplitz file

Applied, thanks.
  

Patch

diff --git a/lib/hash/rte_thash.h b/lib/hash/rte_thash.h
index 6e6861c..b3cedea 100644
--- a/lib/hash/rte_thash.h
+++ b/lib/hash/rte_thash.h
@@ -9,20 +9,17 @@ 
 /**
  * @file
  *
- * toeplitz hash functions.
- */
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/**
  * Software implementation of the Toeplitz hash function used by RSS.
  * Can be used either for packet distribution on single queue NIC
  * or for simulating of RSS computation on specific NIC (for example
  * after GRE header decapsulating)
+ *
  */
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 #include <stdint.h>
 #include <rte_byteorder.h>
 #include <rte_config.h>