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 2c246adcb7969267a208c0ab120f03ebb0ae81df..115532162c95ad6103688b62b798c4de20577167 100644 (file)
--- 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
 ==============