docs: improve code documentation- v3

[zazie-codes]

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

• I have read the contributing guide lines at https://docs.suricata.io/en/latest/devguide/codebase/contributing/contribution-process.html
• I have signed the Open Information Security Foundation contribution agreement at https://suricata.io/about/contribution-agreement/
• I have updated the user guide (in doc/userguide/) to reflect the changes made (if applicable)

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

Describe changes:
This is an update of #9606

• ran ./scripts/clang-format.sh branch to fix formatting
• added the formatting change to a new commit

[inashivb]

Hi @zazie-codes ! Thanks for incorporating the formatting changes, could you please squash all the commits together and make sure they are as per the guidelines: https://docs.suricata.io/en/latest/devguide/codebase/contributing/code-submission-process.html#commits

Check other folks's commits in the open approved PRs/merged in the repo to get examples. 😉

[github-actions]

NOTE: This PR may contain new authors:

Liza <oparliza@gmail.com>

[zazie-codes]

Hi @zazie-codes ! Thanks for incorporating the formatting changes, could you please squash all the commits together and make sure they are as per the guidelines: https://docs.suricata.io/en/latest/devguide/codebase/contributing/code-submission-process.html#commits

Check other folks's commits in the open approved PRs/merged in the repo to get examples. 😉

On it. Thank you.

[codecov]

Codecov Report

Merging #9611 (07cfe9c) into master (1a132f4) will decrease coverage by 0.03%.
The diff coverage is n/a.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #9611      +/-   ##
==========================================
- Coverage   82.28%   82.26%   -0.03%     
==========================================
  Files         968      968              
  Lines      274275   274275              
==========================================
- Hits       225700   225638      -62     
- Misses      48575    48637      +62     

Flag	Coverage Δ
fuzzcorpus	64.37% <ø> (+0.04%)	⬆️
suricata-verify	60.90% <ø> (-0.03%)	⬇️
unittests	62.87% <ø> (+<0.01%)	⬆️

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

[zazie-codes]

Hi @zazie-codes ! Thanks for incorporating the formatting changes, could you please squash all the commits together and make sure they are as per the guidelines: https://docs.suricata.io/en/latest/devguide/codebase/contributing/code-submission-process.html#commits

Check other folks's commits in the open approved PRs/merged in the repo to get examples. 😉

Hi Shivani, instead of squashing the commits together i ended up adding another. Kindly advice, i followed the procedure but i must,ve skipped a process.

[inashivb]

Hi Shivani, instead of squashing the commits together i ended up adding another. Kindly advice, i followed the procedure but i must,ve skipped a process.

Liza, this is a nice guide and on the lines of what was demonstrated by Jason yesterday in the live session. Please try this and see if you can figure out the steps you missed. It's important that you practice this as this will be needed for almost all open source projects. Good luck! :)

[zazie-codes]

Member

Going through it

[zazie-codes]

Hi Shivani, instead of squashing the commits together i ended up adding another. Kindly advice, i followed the procedure but i must,ve skipped a process.

Liza, this is a nice guide and on the lines of what was demonstrated by Jason yesterday in the live session. Please try this and see if you can figure out the steps you missed. It's important that you practice this as this will be needed for almost all open source projects. Good luck! :)

Hi Shivani, I'm done. The squash was successful.

[jufajardini]

Hi Shivani, instead of squashing the commits together i ended up adding another. Kindly advice, i followed the procedure but i must,ve skipped a process.

Liza, this is a nice guide and on the lines of what was demonstrated by Jason yesterday in the live session. Please try this and see if you can figure out the steps you missed. It's important that you practice this as this will be needed for almost all open source projects. Good luck! :)

Hi Shivani, I'm done. The squash was successful.

Thanks, Liza! I've noticed that your git author is missing a surname, (we usually follow the format FirstName LastName <e-mail>). Could you please fix that?

We also add the ticket number we're working on to the commit message, please see this commit as an example of what we expect:
3ecb923

:)

[github-actions]

NOTE: This PR may contain new authors:

Liza <oparliza@gmail.com>

[zazie-codes]

Hi Shivani, instead of squashing the commits together i ended up adding another. Kindly advice, i followed the procedure but i must,ve skipped a process.

Liza, this is a nice guide and on the lines of what was demonstrated by Jason yesterday in the live session. Please try this and see if you can figure out the steps you missed. It's important that you practice this as this will be needed for almost all open source projects. Good luck! :)

Hi Shivani, I'm done. The squash was successful.

Thanks, Liza! I've noticed that your git author is missing a surname, (we usually follow the format FirstName LastName <e-mail>). Could you please fix that?

We also add the ticket number we're working on to the commit message, please see this commit as an example of what we expect: 3ecb923

:)

Yes I'm on it.

[zazie-codes]

Hi Shivani, instead of squashing the commits together i ended up adding another. Kindly advice, i followed the procedure but i must,ve skipped a process.

Liza, this is a nice guide and on the lines of what was demonstrated by Jason yesterday in the live session. Please try this and see if you can figure out the steps you missed. It's important that you practice this as this will be needed for almost all open source projects. Good luck! :)

Hi Shivani, I'm done. The squash was successful.

Thanks, Liza! I've noticed that your git author is missing a surname, (we usually follow the format FirstName LastName <e-mail>). Could you please fix that?

We also add the ticket number we're working on to the commit message, please see this commit as an example of what we expect: 3ecb923

:)

Hi Juliana. I've made the changes.

[github-actions]

NOTE: This PR may contain new authors:

Liza Opar <oparliza@gmail.com>

[github-actions]

NOTE: This PR may contain new authors:

Liza Opar <oparliza@gmail.com>

[jufajardini]

I reviewed this PR looking at the previous reviews, and it seems that you have incorporated most of the feedback given. :)

I've also checked that commit style and author ID are conforming to our guidelines, now.

I've left three inline comments, but these should be straightforward to address, at this point :)

[inashivb]

@zazie-codes you're supposed to make new PR each time to incorporate any changes 😉

[zazie-codes]

I reviewed this PR looking at the previous reviews, and it seems that you have incorporated most of the feedback given. :)

I've also checked that commit style and author ID are conforming to our guidelines, now.

I've left three inline comments, but these should be straightforward to address, at this point :)

Hi, I've incorporated the changes requested.

[zazie-codes]

@zazie-codes you're supposed to make new PR each time to incorporate any changes 😉

Done.

[jufajardini]

@zazie-codes you're supposed to make new PR each time to incorporate any changes 😉

Done.

Thanks and kudos, but when incorporating feedback, especially when code-related, can you please submit those as part of a new PR, as you've done with the previous versions of your work? I know not all communities are like that, but this is really how our workflow goes, and it's easier for us to follow up and compare stuff.

[zazie-codes]

@zazie-codes you're supposed to make new PR each time to incorporate any changes 😉

Done.

Thanks and kudos, but when incorporating feedback, especially when code-related, can you please submit those as part of a new PR, as you've done with the previous versions of your work? I know not all communities are like that, but this is really how our workflow goes, and it's easier for us to follow up and compare stuff.

Sure Juliana...the changes are incorporated in the new PR #9650

[jufajardini]

@zazie-codes you're supposed to make new PR each time to incorporate any changes 😉

Done.

Thanks and kudos, but when incorporating feedback, especially when code-related, can you please submit those as part of a new PR, as you've done with the previous versions of your work? I know not all communities are like that, but this is really how our workflow goes, and it's easier for us to follow up and compare stuff.

Sure Juliana...the changes are incorporated in the new PR #9650

Thanks for mentioning it, I'll close this one, then.

[jufajardini]

Replaced by: #9649

[github-actions]

NOTE: This PR may contain new authors:

Liza Opar <oparliza@gmail.com>