Skip to content

Refactor/12392 v2 Edited README and ISSUES for pre-release, removed unused shell scripts - #27

Merged
KEIAHNY merged 3 commits into
mainfrom
12392-refactor-for-release-v2
Sep 27, 2026
Merged

KEIAHNY merged 3 commits into
mainfrom
12392-refactor-for-release-v2

Conversation

@KEIAHNY

@KEIAHNY KEIAHNY commented Sep 27, 2026 •

Copy link
Copy Markdown
Collaborator

PR Type

Documentation, Other


Description

  • Remove unused Suricata testing shell scripts

  • Update README for v1.0.0-dev pre-release

    • Add NUMA binding and memcap requirements
    • Document single-interface cpu_affinity limitation
  • Add memory reallocation item to ISSUES.md


Diagram Walkthrough

flowchart LR
  pr["PR changes"] -- "delete" --> scripts["Unused shell scripts"]
  pr -- "update" --> readme["README v1.0.0-dev docs"]
  pr -- "extend" --> issues["ISSUES.md future work"]
Loading

File Walkthrough

Relevant files
Miscellaneous
configs.sh
Remove unused Suricata config generation script                   

src/configs.sh

  • Deleted entire script that generated Suricata configuration files and
    NIC settings
  • Script iterated over test cases and traffic types, running TRex
    traffic and Suricata
+0/-34   
runs.sh
Remove unused Suricata test runner script                               

src/runs.sh

  • Deleted entire script that tested generated Suricata configurations
    and NIC settings
  • Script ran Suricata with TRex traffic, collected logs, and aggregated
    drop results
+0/-56   
Documentation
ISSUES.md
Add memory reallocation item to future work                           

ISSUES.md

  • Added memory reallocation on memcap limit to Future work section
+1/-0     
README.md
Update README with v1.0.0-dev requirements and warnings   

README.md

  • Updated version references from v1.0-dev to v1.0.0-dev
  • Added System section requiring NUMA node binding for the network
    interface
  • Added Suricata configuration file section with memcap warning and
    guidance
  • Added warning that cpu_affinity module supports only a single
    interface
+20/-3   

@KEIAHNY KEIAHNY self-assigned this Sep 27, 2026
@github-actions

Copy link
Copy Markdown

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ No major issues detected

@github-actions

Copy link
Copy Markdown

PR Code Suggestions ✨

No code suggestions found for the PR.

@KEIAHNY
KEIAHNY merged commit 871edc9 into main Sep 27, 2026
3 checks passed
@KEIAHNY
KEIAHNY deleted the 12392-refactor-for-release-v2 branch September 27, 2026 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant