Add comprehensive documentation for ntosebpfext #292
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add new docs/ntosebpfext.md with complete documentation for the NTOS eBPF Extension * Getting started guide with prerequisites, building, and testing * Development guide with API reference and code examples * Architecture overview and use cases * Troubleshooting section and additional resources - Update README.md to link to ntosebpfext documentation - Fix all command-line examples in both docs to use Windows syntax (PowerShell/cmd) instead of bash Fixes microsoft#95
Alan-Jowett
requested review from
LakshK98,
matthewige,
mikeagun,
mtfriesen,
poornagmsft,
saxena-anurag and
shankarseal
as code owners
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for the ntosebpfext extension and fixes command-line syntax across documentation files to use Windows-appropriate commands (PowerShell/cmd instead of bash).
Changes:
- Added complete ntosebpfext.md documentation covering getting started, development guide, API reference, architecture, and troubleshooting
- Updated README.md to link to the new ntosebpfext documentation with expanded description
- Fixed command-line examples in neteventebpfext.md to use Windows syntax (bash → cmd/PowerShell,
#→REM)
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/ntosebpfext.md | New comprehensive documentation for the NTOS eBPF Extension, including setup instructions, API reference, code examples, helper functions, architecture overview, use cases, and troubleshooting guidance |
| docs/neteventebpfext.md | Fixed command-line syntax to use Windows commands (cmd/PowerShell) and changed comment syntax from bash (#) to Windows (REM) |
| README.md | Added link to ntosebpfext documentation and expanded description to mention process monitoring capabilities |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds comprehensive documentation for the ntosebpfext extension and fixes command-line syntax in both extension documentation files to use Windows-appropriate commands.
Changes
docs/ntosebpfext.mdwith complete documentation for the NTOS eBPF Extensionbpf_process_get_image_path)process_md_t) referenceREADME.mdto link to the new ntosebpfext documentationdocs/ntosebpfext.mdanddocs/neteventebpfext.mdto use Windows syntax (PowerShell/cmd) instead of bashCloses
Fixes #95
Testing