From: Victor Julien <victor@inliniac.net>
Date: Mon, 11 Nov 2019 15:49:55 +0000 (+0100)
Subject: threading: clarify threadvars fields
X-Git-Tag: suricata-6.0.0-beta1~799
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f1ee176111b72e8d43c2dc3801093bc582b6ac2a;p=thirdparty%2Fsuricata.git

threading: clarify threadvars fields
---

diff --git a/src/threadvars.h b/src/threadvars.h
index 0b0a7acf06..9a9d36ee24 100644
--- a/src/threadvars.h
+++ b/src/threadvars.h
@@ -79,8 +79,11 @@ typedef struct ThreadVars_ {
     void (*InShutdownHandler)(struct ThreadVars_ *);
     void (*tmqh_out)(struct ThreadVars_ *, struct Packet_ *);
 
-    /** slot functions */
+    /** function pointer to the function that runs the packet pipeline for
+     *  this thread. It is passed directly to pthread_create(), hence the
+     *  void pointers in and out. */
     void *(*tm_func)(void *);
+    /** list of of TmSlot objects together forming the packet pipeline. */
     struct TmSlot_ *tm_slots;
     /** pointer to the flowworker in the pipeline. Used as starting point
      *  for injected packets. Can be NULL if the flowworker is not part