Project

General

Profile

Actions

Task #3343

open

Tracking: developer documentation

Added by Victor Julien almost 2 years ago. Updated 18 days ago.

Status:
Assigned
Priority:
Normal
Assignee:
Target version:
Effort:
Difficulty:
Label:

Description

Goal is to create a developer guide similar to the user guide. So it will also live in the git repo and will using sphinx for the higher level guides.

For low level, we will continue to use doxygen.
In addition, for the Rust and Python components we need to support other low level frameworks as well like rustdoc.

Provisional TOC (will update as needed)

TOC

working with the codebase
- contributing
  = process (github)
  = quality requirements
- style
- debugging
- performance
  = concepts
  = analysis and tooling

internals
- packet pipeline
- threading
- common data structures

extending
- capture methods
- packet decoders
- app-layer protocols
- detection
- outputs

Existing documentation can be found here https://redmine.openinfosecfoundation.org/projects/suricata/wiki/Suricata_Developers_Guide. Much of this is outdated, so we shouldn't just copy it over. But it may be a good starting point for some of the new docs.


Subtasks 3 (1 open2 closed)

Task #3344: devguide: setup sphinxClosedShivani BhardwajActions
Task #3363: devguide: set up rustdoc to generate low level rust docsClosedJason IshActions
Task #3365: Research: can we use doxygen to validate completeness of low level docsNewActions
Actions #1

Updated by Victor Julien almost 2 years ago

  • Description updated (diff)
Actions #2

Updated by Victor Julien over 1 year ago

Basic structure with above TOC has been set up https://github.com/OISF/suricata/pull/4904

Actions #3

Updated by Victor Julien about 1 year ago

  • Target version changed from 6.0.0beta1 to 6.0.0rc1
Actions #4

Updated by Victor Julien about 1 year ago

  • Target version changed from 6.0.0rc1 to 7.0rc1
Actions

Also available in: Atom PDF