From: jason taylor Date: Fri, 15 Jul 2022 19:27:19 +0000 (+0000) Subject: doc: add clarity to rule msg tips X-Git-Tag: suricata-7.0.0-beta1~356 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=38a179d89d907ea63ce5d004a3615454f49daf15;p=thirdparty%2Fsuricata.git doc: add clarity to rule msg tips Signed-off-by: jason taylor --- diff --git a/doc/userguide/rules/meta.rst b/doc/userguide/rules/meta.rst index dc1fbd0116..f8593a001a 100644 --- a/doc/userguide/rules/meta.rst +++ b/doc/userguide/rules/meta.rst @@ -26,9 +26,9 @@ To continue the example of the previous chapter, this is the keyword in action i .. tip:: - It is convention to make the first part of the signature uppercase and show the class of the signature. + It is a standard practice in rule writing to make the first part of the signature uppercase and to indicate the class of the signature. - It is also convention that ``msg`` is made the first keyword in the signature. + It is also a standard practice that ``msg`` is the first keyword in the signature. .. note:: The following characters must be escaped inside the msg: ``;`` ``\`` ``"``