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

userguide/runmodes: fix typo #12108

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

AlirezaPourchali
Copy link

@AlirezaPourchali AlirezaPourchali commented Nov 11, 2024

Make sure these boxes are checked accordingly before submitting your Pull Request -- thank you.

Contribution style:

Our Contribution agreements:

Changes (if applicable):

Describe changes:

  • fixed a typo in the documentation

@AlirezaPourchali
Copy link
Author

it's a very small change and nothing much

@jufajardini jufajardini added the typo/doc update No code change : only doc or typo fixes label Nov 11, 2024
Copy link

NOTE: This PR may contain new authors.

Copy link

codecov bot commented Nov 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.15%. Comparing base (5d766df) to head (49fda0c).
Report is 4 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##           master   #12108       +/-   ##
===========================================
+ Coverage   62.68%   83.15%   +20.47%     
===========================================
  Files         840      909       +69     
  Lines      153669   257883   +104214     
===========================================
+ Hits        96323   214445   +118122     
+ Misses      57346    43438    -13908     
Flag Coverage Δ
fuzzcorpus 61.00% <ø> (?)
livemode 19.44% <ø> (?)
pcap 44.04% <ø> (?)
suricata-verify 62.70% <ø> (+0.02%) ⬆️
unittests 59.26% <ø> (?)

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.

Thanks for your contribution :)

Before we can merge it, the merge commit should be squashed with the main one.

We also kindly ask you to use as your GitHub e-mail for the PR author the same e-mail that you used for signing up the Contribution Agreement, please :)

The CI failure looks unrelated to your work.

@AlirezaPourchali
Copy link
Author

AlirezaPourchali commented Nov 11, 2024

squashed the commits to one.
fixed the email as well, thanks for pointing that out !
thanks :)

@jufajardini
Copy link
Contributor

squashed the commits to one. fixed the email as well, thanks for pointing that out ! thanks :)

Thanks! I missed two points in my previous comment, sorry (low on coffee today, it seems), both related to the commit message:

Copy link

NOTE: This PR may contain new authors.

@AlirezaPourchali
Copy link
Author

changed the commit message.

@AlirezaPourchali AlirezaPourchali changed the title fix(): Documentation typo userguide/runmodes: fix typo Nov 14, 2024
@AlirezaPourchali
Copy link
Author

is everything ok to be merged or do i need to do something else?

@jufajardini
Copy link
Contributor

is everything ok to be merged or do i need to do something else?

It looks good to me, thanks :)

I'll approve it, as it's a very small doc update. For larger contributions, though, the workflow would be to submit a new PR for incorporating new feedback, roger? :)

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.

As it's something very small, I think it's ok to go without new versions for the incorporated feedback. Can't confirm whether CLA was really signed or not.

@@ -12,7 +12,7 @@ a queue. Packets will be processed by one thread at a time, but there
can be multiple packets being processed at a time by the engine (see
:ref:`suricata-yaml-max-pending-packets`). A thread can have one or
more thread-modules. If they have more modules, they can only be
active one a a time. The way threads, modules and queues are arranged
active one at a time. The way threads, modules and queues are arranged
Copy link
Contributor

Choose a reason for hiding this comment

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

There is another one :

git grep " a a "
doc/userguide/performance/hyperscan.rst:**Note:** Hyperscan can take a a long time to build/compile.
doc/userguide/performance/runmodes.rst:active one a a time.  The way threads, modules and queues are arranged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla complete typo/doc update No code change : only doc or typo fixes
Development

Successfully merging this pull request may close these issues.

4 participants