mirror of
https://github.com/OISF/suricata.git
synced 2026-03-16 23:54:32 -04:00
71e4ca81ef
This section seemed to aim both at PR reviewers and PR authors at the same time, even though some info is probably of low value for contributors. Created new section for PR reviewers and maintainers, and kept the info for PR authors separated. Also highlighted information on requested changes and stale PRs. |
||
|---|---|---|
| .. | ||
| codebase | ||
| contributing | ||
| extending | ||
| internals | ||
| index.rst | ||
| README.md | ||
Suricata Developer Guide
This directory contains the Suricata Developer's Guide. It is built as part of the Suricata Userguide.
The Sequence Diagrams seen in the Transactions documentation are generated with Mscgen. Mscgen is a small program to parse Message Sequence Charts that can be represented as text and can then converted to image.
If you need to update the diagrams, please edit the .msc files present in the diagrams directory (extending/app-layer/diagrams). Once those have been changed, in the scripts directory (in the main Suricata dir) there's a scrip that will generate images for all files: generate-images.sh (you'll have to install Mscgen for that to work).
More info about Mscgen can be found at: https://www.mcternan.me.uk/mscgen/