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

doc: add overview of *TriggerRawStreamReassembly #11446

Closed
wants to merge 1 commit into from

Conversation

inashivb
Copy link
Member

@inashivb inashivb commented Jul 8, 2024

Link to ticket: https://redmine.openinfosecfoundation.org/issues/4351

Apart from the content, looking for feedback on:

  • organization
  • naming schemes of folders and files

@inashivb inashivb added the typo/doc update No code change : only doc or typo fixes label Jul 8, 2024
Copy link

codecov bot commented Jul 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.56%. Comparing base (eeec609) to head (70cb1e3).

Additional details and impacted files
@@            Coverage Diff             @@
##           master   #11446      +/-   ##
==========================================
+ Coverage   82.44%   82.56%   +0.12%     
==========================================
  Files         938      938              
  Lines      248068   248068              
==========================================
+ Hits       204513   204816     +303     
+ Misses      43555    43252     -303     
Flag Coverage Δ
fuzzcorpus 60.61% <ø> (+0.51%) ⬆️
livemode 18.71% <ø> (ø)
pcap 43.76% <ø> (+0.04%) ⬆️
suricata-verify 61.47% <ø> (+0.05%) ⬆️
unittests 59.43% <ø> (ø)

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

Copy link
Contributor

@jufajardini jufajardini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<3

Thanks for helping us all understand this better :)

As this is a draft, are you planning on adding an explanation on what does it mean to allow the detection engine to have access to a bigger portion of the raw stream?

@inashivb
Copy link
Member Author

inashivb commented Jul 9, 2024

are you planning on adding an explanation on what does it mean to allow the detection engine to have access to a bigger portion of the raw stream?

I intended that to be shown with the diagram, could you please tell if something should be changed there or some text?

@jufajardini
Copy link
Contributor

are you planning on adding an explanation on what does it mean to allow the detection engine to have access to a bigger portion of the raw stream?

I intended that to be shown with the diagram, could you please tell if something should be changed there or some text?

I think that it's usually good to have a textual explanation of what the diagram illustrates (it may feel redundant, but considering that these concepts are complex and new to many; and people's learning abilities differ; I consider this makes docs more accessible :) ).

@inashivb inashivb closed this Jul 12, 2024
@inashivb inashivb deleted the doc-raw-trigger-reassembly/v1 branch July 12, 2024 13:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
typo/doc update No code change : only doc or typo fixes
Development

Successfully merging this pull request may close these issues.

3 participants