Skip to content

docs: clarify overridable parameter naming in example manifests#181

Open
singhmj-1 wants to merge 2 commits into
pre-draftfrom
docs/167-clarify-params-and-targets
Open

docs: clarify overridable parameter naming in example manifests#181
singhmj-1 wants to merge 2 commits into
pre-draftfrom
docs/167-clarify-params-and-targets

Conversation

@singhmj-1
Copy link
Copy Markdown

Description

Remove the misleading "ENV." prefix from example pointer values to
clarify that target names are vendor-defined and opaque to the device.
Also adds comments in the example manifests to clarify,
what the pointer attributes actually are.

Issues Addressed

Closes #167

Change Type

Please select the relevant options:

  • Fix (change that resolves an issue)
  • New enhancement (change that adds specification content)
  • Content edits (change that edits existing content)

Checklist

  • I have read the CONTRIBUTING document.
  • My changes adhere to the established patterns, and best practices.

singhmj-1 added 2 commits May 15, 2026 13:54
Remove the "ENV." prefix from example pointer values to eliminate the
misperception that the specification enforces a naming schema.

Signed-off-by: Manjinder <manjinder.b.singh@capgemini.com>
Signed-off-by: Manjinder <manjinder.b.singh@capgemini.com>
@singhmj-1 singhmj-1 self-assigned this May 15, 2026
@singhmj-1 singhmj-1 requested a review from a team as a code owner May 15, 2026 08:45
@singhmj-1 singhmj-1 requested review from ajcraig and phil-abb May 15, 2026 08:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Define and improve clarity on parameters and their targets relating to Desired state.

3 participants