Skip to content

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

Merged
Ulrond merged 4 commits into
developfrom
feature/251-generalise-ut-core-framing
Aug 5, 2026
Merged

Docs: Generalise ut-core framing — unit-testing core, not HAL-specific#252
Ulrond merged 4 commits 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 Outdated
@Ulrond Ulrond self-assigned this Jul 16, 2026
@Ulrond Ulrond moved this from Todo to Under Review in UT-Core Roadmap Jul 16, 2026
@Ulrond
Ulrond requested review from bhanucbp and kanjoe24 July 27, 2026 16:34
@Ulrond

Ulrond commented Jul 27, 2026

Copy link
Copy Markdown
Contributor Author

@bhanucbp @kanjoe24 — adding you as named reviewers; this has been on the team request alone since 16 July. Docs-only change: it reframes ut-core as a general-purpose C/C++ unit-testing core with HAL testing as the primary example, per #251. Review ask: confirm the wording change is one you are happy to stand behind, since it is the front-door description of the project.

kanjoe24
kanjoe24 previously approved these changes Aug 4, 2026

@kanjoe24 kanjoe24 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

approved.

Ulrond added 2 commits August 4, 2026 17:43
'examples files ... required of reach layer' -> 'example files ...
required for each layer'.
Copilot AI review requested due to automatic review settings August 4, 2026 16:43

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

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

@Ulrond
Ulrond requested a review from kanjoe24 August 4, 2026 16:46
@Ulrond

Ulrond commented Aug 4, 2026

Copy link
Copy Markdown
Contributor Author

@kanjoe24 re-review needed — your approval was auto-dismissed by the ruleset (dismiss_stale_reviews_on_push: true) when I pushed the follow-up.

Two changes since your approval:

  1. develop merged in (picks up feat(gmock): GoogleMock wrap + mock/gtest autogeneration for C++ interfaces #255, no conflicts).
  2. 6621ef1 — one-line typo fix on the sentence Copilot flagged: "show examples files that will be required of reach layer" → "show example files that will be required for each layer".

Docs-only, all checks green, Copilot re-reviewed with no new comments, thread resolved. Note #258 is also awaiting re-review for the same reason if you want to do both together.

@kanjoe24 kanjoe24 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Approved.

@github-project-automation github-project-automation Bot moved this from Under Review to Approved For Merge in UT-Core Roadmap Aug 5, 2026
Copilot AI review requested due to automatic review settings August 5, 2026 14:49

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

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

@Ulrond
Ulrond merged commit 3726cb5 into develop Aug 5, 2026
8 checks passed
@Ulrond
Ulrond deleted the feature/251-generalise-ut-core-framing branch August 5, 2026 14:50
@github-project-automation github-project-automation Bot moved this from Approved For Merge to Resolved in UT-Core Roadmap Aug 5, 2026
@github-actions github-actions Bot locked and limited conversation to collaborators Aug 5, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Improvements or additions to documentation

Projects

Status: Resolved

Development

Successfully merging this pull request may close these issues.

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

3 participants