README/help: add info on IPS mode tests creation - v1 #1955
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
It is possible to create a test that runs in IPS mode by just adding ips to its name. But that is not documented. Task #7039
inashivb
reviewed
Jul 5, 2024
Comment on lines
+207
to
+208
| Add `ips` to the test name if you want it to run in IPS mode | ||
| the test is run. |
There was a problem hiding this comment.
nits:
- I'm realizing this README output is quite mature than the actual help output of the script. Maybe we should make it consistent. wdyt?
- Help outputs are generally supposed to be one liners w minimal info. Should such additional info stay in the docs?
There was a problem hiding this comment.
nits:
1. I'm realizing this README output is quite mature than the actual help output of the script. Maybe we should make it consistent. wdyt?
Agreed!
2. Help outputs are generally supposed to be one liners w minimal info. Should such additional info stay in the docs?
I still think that this info should be outputted when we have the help, as I can imagine people would often first refer to the help output before going to the documentation. I can try to make it more concise, somehow, then.
|
Replaced by: #1965 |
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.
It is possible to create a test that runs in IPS mode by just adding
ipsto its name. But that is not documented.Task #7039
Ticket
If your pull request is related to a Suricata ticket, please provide
the full URL to the ticket here so this pull request can monitor
changes to the ticket status:
Redmine ticket:
https://redmine.openinfosecfoundation.org/issues/7039