From 6c616d84b18dbc518c4107f0fe6c7386a3d4e5f2 Mon Sep 17 00:00:00 2001 From: Juliana Fajardini Date: Fri, 18 Feb 2022 19:21:23 +0000 Subject: [PATCH] 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 --- doc/devguide/extending/app-layer/app-layer-frames.rst | 2 ++ 1 file changed, 2 insertions(+) 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 ============== -- 2.47.2