docs: Preliminary testing infra documentation #1059
+593
−0
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
Contributor
|
Thank you for your contribution! 🚀 |
ajankovicTT
force-pushed
the
ajankovic/test-infra-docs
branch
from
bfa440d to
c8be111
Compare
ajankovicTT
changed the title
github-actions
bot
added
the
documentation
ajankovicTT
requested review from
ldjurovicTT,
nvelickovicTT,
skotaracTT,
skrsmanovicTT,
sstanisicTT and
vkrsmanovicTT
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request adds preliminary documentation for the LLK (Low-Level Kernel) test infrastructure. The documentation aims to help team members understand how to write, run, and debug tests for the test infrastructure.
- Getting started guide with code examples for writing functional and performance tests
- Architecture overview explaining compilation process and memory layouts
- Debugging guide with tips and common issue checklists
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 13 comments.
| File | Description |
|---|---|
| docs/tests/infra_architecture.md | Detailed architecture documentation covering file paths, TestConfig object, kernel compilation, L1 memory layouts, and runtime behavior (contains multiple TODO sections) |
| docs/tests/getting_started.md | Step-by-step guide for writing and running functional/performance tests with Python and C++ code examples |
| docs/tests/debugging_guide.md | Troubleshooting checklist organized by compilation, runtime, and assertion errors (contains some TODO sections) |
| docs/tests/images/compilation-graph.svg | Diagram illustrating the kernel compilation pipeline from source files to ELF binaries |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
ajankovicTT
force-pushed
the
ajankovic/test-infra-docs
branch
from
1155d83 to
983baed
Compare
ajankovicTT
force-pushed
the
ajankovic/test-infra-docs
branch
from
983baed to
bd27fce
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What's changed
Preliminary test infra documentation, useful to the rest of LLK team and anyone who knows how to write tests. Includes getting started document with code snippets, preliminary architecture overview and debuging tips&trick for some bugs myself and other people came across.
Type of change
Checklist