You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
suricata/doc/userguide/devguide
Shivani Bhardwaj 6f937c7545 doc: add guide for ticket title
Explain with examples what a good ticket title looks like and
why is it important to have ticket titles convey the correct issues.
7 months ago
..
codebase docs: remove mentions to Suricata-6 9 months ago
contributing doc: add guide for ticket title 7 months ago
extending output-filedata: rename and document registration function 10 months ago
internals devguide: move into userguide as last chapter 3 years ago
libsuricata devguide: add chapter and short intro to libsuricata 1 year ago
upgrading devguide: add an upgrade section 1 year ago
README.md devguide: update readme 3 years ago
index.rst devguide: add an upgrade section 1 year ago

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/