Docs: Generalise ut-core framing — unit-testing core, not HAL-specific#252
Open
Ulrond wants to merge 1 commit into
Open
Docs: Generalise ut-core framing — unit-testing core, not HAL-specific#252Ulrond wants to merge 1 commit into
Ulrond wants to merge 1 commit into
Conversation
… as primary use case
There was a problem hiding this comment.
Pull request overview
This PR updates the “front-door” documentation to describe ut-core as a general-purpose C/C++ unit-testing core framework, while keeping HAL testing as the primary example use case (per #251).
Changes:
- Reframed README heading and scope section to position HAL testing as the primary use case rather than the framework’s purpose.
- Updated AGENTS.md purpose statement and several downstream/template references to be “test project” / “API repository” instead of HAL-specific wording.
- Minor wording adjustments throughout both docs to use “component under test (e.g. HAL)” phrasing.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Updates title/scope framing and adjusts several HAL-specific sentences to “primary use case / component under test” language. |
| AGENTS.md | Generalizes the stated purpose and various references (architecture label, template/downstream wording) while preserving HAL as the main example consumer. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| This allows the `ut-core` framework to be upgraded over time, and have independence of the `ut` unit being tested. | ||
|
|
||
| Script templates are provided to show examples files that will be required of reach layer, starting from the hal. | ||
| Script templates are provided to show examples files that will be required of reach layer, starting from the component under test (e.g. the HAL). |
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
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.
Closes #251
What
Reframes the two front-door docs (
AGENTS.md,README.md) so ut-core's stated purpose is generic (a C/C++ unit-testing core), with HAL demoted from "the purpose" to the named primary example use case. HAL is only ut-core's main current consumer, not its intent.Changes (prose only — 11 edits)
AGENTS.md
README.md
Deliberately NOT changed
Load-bearing identifiers and genuine HAL-domain content are untouched: default binary
hal_test, Makefile varsHAL_LIB_DIR/-lhal_xxx, downstream reposhaltest-wifi/haltest-xxx, naming conventionshal-<component>/haltest-<component>, anddocs/pages/hal_unit_testing_requirements.md(a real HAL requirements doc, linked by name elsewhere).git diffis prose-only — no code, identifiers, or intra-repo links changed.