Skip to content

Docs: Generalise ut-core framing — unit-testing core, not HAL-specific#252

Open
Ulrond wants to merge 1 commit into
developfrom
feature/251-generalise-ut-core-framing
Open

Docs: Generalise ut-core framing — unit-testing core, not HAL-specific#252
Ulrond wants to merge 1 commit into
developfrom
feature/251-generalise-ut-core-framing

Conversation

@Ulrond

@Ulrond Ulrond commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

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

  • Purpose line: "unit-testing framework for RDK HAL components" → "unit-testing core framework for RDK C/C++ components. Its primary current use is testing HAL implementations."
  • "new HAL test projects" → "new test projects (e.g. HAL test suites)"
  • Architecture diagram label "HAL Test Binary" → "Test Binary"
  • "downstream HAL test project" → "downstream test project"; "top-level HAL API repository" → "top-level API repository"
  • Directory-tree comments: "HAL test projects" / "HAL API repos" → "test projects" / "API repos"

README.md

  • Title "Unit Testing - Hal Testing Suite" → "ut-core - Unit Testing Core Framework"
  • Section "## HAL Scope" → "## Primary Use Case — HAL Testing"
  • Softened HAL-as-purpose prose (L22, L45, L300, L466) to "component under test (e.g. the HAL)" style wording

Deliberately NOT changed

Load-bearing identifiers and genuine HAL-domain content are untouched: default binary hal_test, Makefile vars HAL_LIB_DIR / -lhal_xxx, downstream repos haltest-wifi / haltest-xxx, naming conventions hal-<component> / haltest-<component>, and docs/pages/hal_unit_testing_requirements.md (a real HAL requirements doc, linked by name elsewhere).

git diff is prose-only — no code, identifiers, or intra-repo links changed.

@Ulrond
Ulrond requested a review from a team as a code owner July 16, 2026 15:22
Copilot AI review requested due to automatic review settings July 16, 2026 15:22
@Ulrond Ulrond added the documentation Improvements or additions to documentation label Jul 16, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread README.md
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).
@Ulrond Ulrond self-assigned this Jul 16, 2026
@Ulrond Ulrond moved this from Todo to Under Review in UT-Core Roadmap Jul 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Under Review

Development

Successfully merging this pull request may close these issues.

Docs: Generalise ut-core framing — unit-testing core, not HAL-specific

2 participants