19 Commits (97ef60cd9ba956260fefaf08cfe6ad4e6b14747a)

Author	SHA1	Message	Date
Jason Ish	b9a429e6ce	devguide: move image generation into sphinx setup ... While ReadTheDocs can't execute arbitrary scripts, we can install mscgen in the container that builds the docs (see .readthedocs.yaml). Then instead of calling generate-images.sh from the Makefile, move this into the setup function defined on conf.yaml, which will generate the scripts as part of a normal Sphinx workflow. This should give us an image generation solution that works on ReadTheDocs, and locally within anyones build system provided they have mscgen installed.	3 years ago
Juliana Fajardini	c6e97222b7	devguide: add page about rust unittests ... Part of the task to offer better guidance on how and when to write unit tests or suricata-verify tests Also updated linking and index files, as well as testing page to refer to the unit tests pages Doc: #4590	3 years ago
Juliana Fajardini	747d225c84	devguide: repurpose unittests page to unittests-c ... Part of ongoing task to add more guidance on how to create unittests and suricata-verify tests for suri. There will also be a unittests-rust page. Doc: #4590	3 years ago
Juliana Fajardini	5b4c575f3b	devguide: add page about testing ... This page offers guidance about when to use unittests or s-v tests, and how to create input for those. Also lists other common ways to test Suri, such as fuzzing and the CI checks. Doc: #4590	3 years ago
Juliana Fajardini	dbeb8bfa1f	doc/devguide: add few more explanations & details	3 years ago
Juliana Fajardini	2cd25e8105	devguide/app-layer: rename /img dir to /diagrams ... Semantically speaking it makes more sense, because it stores `msc` files for dynamic image generation. Updated files that refered to `img` accordingly, too.	3 years ago
Juliana Fajardini	f65b3908ed	devguide/transactions: add TSL_STATE enum snippet	3 years ago
Juliana Fajardini	d6c5dfacc7	devguide/transactions: update & refine diagrams ... - DNS sequence diagram was incorrect (transactions should be unidirectional). After changing it, it made sense to rename the file. Adjusted spacing, too. Updated transactions.rst accordingly. - TLS sequence diagram was refined to illustrate how Suricata actually implements the protocol.	3 years ago
Juliana Fajardini	84311ab151	devguide/transactions: fix wordings	3 years ago
Juliana Fajardini	2f3cee2429	devguide/code-style: fix typo in banned functions	3 years ago
Juliana Fajardini	a5b344e015	doc/devguide: add Transactions documentation page ... A guide on what is a transaction for Suricata engine, focusing on developers. - What's the purpose of a transaction; - transaction states and API callbacks; - Examples and sequence diagrams. - doc/devguide: add transactions.rst - doc/devguide/extending/app-layer/index.rst: add transactions.rst	3 years ago
Philippe Antoine	95f225e8fb	doc: update sphinx api to use add_css_file ... instead of deprecated add_stylesheet	4 years ago
Victor Julien	372fc26739	ci: buildbot is decommissioned, so remove prscript refs	4 years ago
Roland Fischer	de7c7eeff0	doc: Add dev code-style	5 years ago
Victor Julien	e5fd47dcfd	doc/devguide: create basic layout ... Issue: #3343	5 years ago
Jeff Lucovsky	5f71e7a371	doc/devguide: Submission and style ... This commit adds code submission and coding style guidelines to the devguide. Most of the material is a straight port from the wiki but there have been some content modifications and additions.	5 years ago
Jason Ish	752e4828d7	devguide: include sources in EXTRA_DIST ... Required for distcheck to pass, and required to build docs from a dist archive.	5 years ago
Victor Julien	ccfdcb55fb	devguide: document new app-layer retvals	5 years ago
Shivani Bhardwaj	7b1699c5a8	doc: Add chassis for dev docs ... Closes redmine ticket 3344.	5 years ago