From: Juliana Fajardini <jufajardini@gmail.com>
Date: Fri, 18 Feb 2022 19:21:23 +0000 (+0000)
Subject: devguide: clarify style guide for getframe funcs
X-Git-Tag: suricata-7.0.0-beta1~860
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6c616d84b18dbc518c4107f0fe6c7386a3d4e5f2;p=thirdparty%2Fsuricata.git

devguide: clarify style guide for getframe funcs

As the GetFrameIdByName can be probed, we must warn developers not to
leave any output in them, or misleading messages could be printed.

Task #5129
---

diff --git a/doc/devguide/extending/app-layer/app-layer-frames.rst b/doc/devguide/extending/app-layer/app-layer-frames.rst
index 2c246adcb7..115532162c 100644
--- a/doc/devguide/extending/app-layer/app-layer-frames.rst
+++ b/doc/devguide/extending/app-layer/app-layer-frames.rst
@@ -190,6 +190,8 @@ Register relevant callbacks (note that the actual functions will also have to be
     :end-before: /* app-layer-frame-documentation tag end: registering relevant callbacks
     :dedent: 8
 
+.. note:: The ``GetFrameIdByName`` functions can be "probed", so they should not generate any output or that could be misleading (for instance, Suricata generating a log message stating that a valid frame type is unknown).
+
 Visual context
 ==============