Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

devguide/transactions: add template examples #6241

Closed
wants to merge 10 commits into from

Conversation

jufajardini
Copy link
Contributor

Transactions documentation - v8

Describe changes:

  • add examples from the Template protocol (including Sequence Diagrams)

(waiting for final approval to figure out the squashing process... If that's not ideal, I can fix that now.)

Link to Redmine issue: https://redmine.openinfosecfoundation.org/issues/4396

Previous PR: #6233

- extending/applayer/transactions: third draft
- typo fix
- add definition of `flow` as found in inliniac's blog
- strike off parenthesis text about per-flow state that didn't make much sense
- doc/devguide: add transactions.rst
- doc/devguide/extending/app-layer/index.rst: add transactions.rst
Add explanation about how transaction state is used for rule matching
Grammar refinement.
Add examples of simple protocols.
Refine some statements.
Nit: fix markup.
add sequence diagrams as pngs generated by mscgen via a script
Add image description to Sequence Diagrams
Change table of contents be built with markup
tell git to ignore *.png files
mscgen is used for generating Sequence Diagrams images. Let's make
sure it's present before generating devguide docs.
@codecov
Copy link

codecov bot commented Jun 30, 2021

Codecov Report

Merging #6241 (870dac7) into master (b3c1f2a) will decrease coverage by 0.08%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #6241      +/-   ##
==========================================
- Coverage   76.95%   76.86%   -0.09%     
==========================================
  Files         611      611              
  Lines      186232   186232              
==========================================
- Hits       143306   143152     -154     
- Misses      42926    43080     +154     
Flag Coverage Δ
fuzzcorpus 52.79% <ø> (-0.12%) ⬇️
suricata-verify 51.05% <ø> (-0.03%) ⬇️
unittests 63.08% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@suricata-qa
Copy link

field test baseline % diff
tlpr1_stats_chk
.flow.mgr.rows_maxlen 364 539 68.0%

@jufajardini
Copy link
Contributor Author

Followed by: #6245

@jufajardini jufajardini closed this Jul 1, 2021
@jufajardini jufajardini deleted the tx-documentation-v8 branch September 30, 2021 09:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants