Skip to content

docs: clarify ai.* vs srcmorph.* property namespaces - #168

Merged
bernardladenthin merged 3 commits into
mainfrom
claude/dependency-updates-audit-vv4mz5
Jul 31, 2026
Merged

docs: clarify ai.* vs srcmorph.* property namespaces#168
bernardladenthin merged 3 commits into
mainfrom
claude/dependency-updates-audit-vv4mz5

Conversation

@bernardladenthin

Copy link
Copy Markdown
Owner

Summary

  • Added prominent documentation clarifying the distinction between ai.* build properties (repo-local Maven configuration for self-test/benchmark executions) and srcmorph.* mojo parameters (published plugin configuration).
  • Updated README examples to use srcmorph.generationProvider instead of -Dai.gpuLayers in command-line examples, with cross-references explaining the difference.
  • Expanded CLAUDE.md guidance to prevent future confusion between the two property namespaces during code review and maintenance.
  • Updated TODO.md and pom.xml comments to reflect the current mojo count (4 goal mojos + 1 abstract base) and clarify the PIT mutation testing scope.

Motivation

The repository has two distinct property namespaces that serve different purposes:

  • ai.* properties: Maven build properties defined in srcmorph-maven-plugin/pom.xml, used only for this repo's own gpt-oss profile executions (self-test, benchmarking). Overridable with -Dai.<name>=<value> at build time.
  • srcmorph.* properties: Published mojo @Parameter annotations that downstream consumers use in their own <configuration> blocks.

This distinction has previously tripped audits and code reviews. The changes make it explicit in multiple places (README, CLAUDE.md, pom.xml comments) so maintainers and contributors understand why -Dai.gpuLayers=12 is correct (not a bug to "fix" to srcmorph.gpuLayers).

Test plan

  • Affected unit / integration tests pass locally
  • CI is green on this branch
  • Docs / CHANGELOG updated where applicable

Related issues / PRs

Checklist

  • I have read CONTRIBUTING.md and CODE_OF_CONDUCT.md
  • My commits follow Conventional Commits
  • No security-sensitive changes (if there are, I have notified the maintainer privately per SECURITY.md)

https://claude.ai/code/session_018WUx9TF8QGQf6efgG5TkHi

claude added 3 commits July 29, 2026 09:53
…oc-consistency audit)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018WUx9TF8QGQf6efgG5TkHi
…arameters

Prevents future audits from mistaking the -Dai.* flags (ai.model, ai.gpuLayers,
ai.mainGpu, ai.devices, ai.index.output.directory) for stale/invalid properties.
They ARE valid: repo-local Maven <properties> in srcmorph-maven-plugin/pom.xml,
wired into this module's own gpt-oss self-test/benchmark executions and
overridable with -Dai.*. Downstream consumers of the published plugin set the
same knobs as <configuration>/model-definition elements; the published mojo
parameters are the separate srcmorph.* set.

- pom.xml: header comment above the ai.* property block.
- README.md: note before the -Dai.* usage in "Recommended Models".
- CLAUDE.md: bullet documenting the two property namespaces.

Comment/doc-only; no build behavior or parameters changed.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018WUx9TF8QGQf6efgG5TkHi
The "GPU acceleration (opt-in)" section targets downstream users of the
published plugin, but its tuning bullets described the knobs via -Dai.gpuLayers
/-Dai.mainGpu/-Dai.devices — which are this repo's own Maven build properties
and do NOT exist in a downstream build. Reframed the two bullets to set
<gpuLayers>/<mainGpu>/<devices> inside the user's <aiDefinition> (the real,
documented config elements, cross-referenced to "Per-model <aiDefinition>
parameters"), and kept -Dai.* only as an explicit "this repo's own presets"
parenthetical. Consistent with the ai.* clarification note added earlier.

Doc-only.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_018WUx9TF8QGQf6efgG5TkHi
@bernardladenthin
bernardladenthin merged commit 6675924 into main Jul 31, 2026
7 of 12 checks passed
@bernardladenthin
bernardladenthin deleted the claude/dependency-updates-audit-vv4mz5 branch July 31, 2026 22:33
@sonarqubecloud

Copy link
Copy Markdown

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.

2 participants