upstream/suricata
1
0
Fork 0
mirror of https://github.com/OISF/suricata.git synced 2026-02-11 23:06:04 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
suricata/doc/userguide/devguide
History
Juliana Fajardini a2905ae5d4 userguide: explain rule types and categorization 
Add documentation about the rule types introduced by commit
2696fda041.

Add doc tags around code definitions that are referenced in the docs.

Task #https://redmine.openinfosecfoundation.org/issues/7031
2025-01-28 09:32:49 +01:00
..
codebase docs: remove mentions to Suricata-6 2024-09-23 18:59:26 +02:00
contributing doc: add guide for ticket title 2024-12-20 07:55:55 +01:00
extending userguide: explain rule types and categorization 2025-01-28 09:32:49 +01:00
internals devguide: move into userguide as last chapter 2022-03-29 07:56:03 +02:00
libsuricata devguide: add chapter and short intro to libsuricata 2024-03-09 07:54:41 +01:00
upgrading devguide: add an upgrade section 2024-03-16 09:29:34 +01:00
index.rst devguide: add an upgrade section 2024-03-16 09:29:34 +01:00
README.md devguide: update readme 2022-03-29 07:56:03 +02:00

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/