userguide: explain rule types and categorization - v11 #12487
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add documentation about the rule types introduced by commit 2696fda. Add doc tags around code definitions that are referenced in the docs. Task #https://redmine.openinfosecfoundation.org/issues/7031
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #12487 +/- ##
=======================================
Coverage 80.55% 80.56%
=======================================
Files 925 925
Lines 259303 259303
=======================================
+ Hits 208886 208897 +11
+ Misses 50417 50406 -11
Flags with carried forward coverage won't be shown. Click here to find out more. |
|
Information: QA ran without warnings. Pipeline 24379 |
victorjulien
approved these changes
Jan 28, 2025
Merged
|
Merged in #12492, thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add documentation about the rule types introduced by commit 2696fda.
Add doc tags around code definitions that are referenced in the docs.
Task #https://redmine.openinfosecfoundation.org/issues/7031
Previous PR: #12411
Link to ticket: https://redmine.openinfosecfoundation.org/issues/
https://redmine.openinfosecfoundation.org/issues/7031
Compiled docs: https://suri-rtd-test.readthedocs.io/en/doc-sigtypes-et-properties-v11/rules/rule-types.html
Describe changes:
REQUIRE_PACKETandREQUIRE_STREAMflagsIP Onlyrule type description, removing mention ofports, as those don't affect rule type-- adjust rule emphasis markup to better reflect the correct description
-- add one more
ip_onlyrule (that isn't in the SV PR as it was added after its submission),Provide values to any of the below to override the defaults.
SV_BRANCH=OISF/suricata-verify#2259