Commit e36f631
committed
docs: README + CLAUDE.md system-properties reference deep-scan
A complete sweep of src/main and src/test for every
net.ladenthin.llama.* system property the library understands, with
each property's default value and concrete consumer attached. The
previous README table covered only 5 of the 9 properties (the 4
test-only nomic + vision properties were undocumented in user-facing
docs) and described the 5 it did cover as "all resolved by
LlamaSystemProperties" - which the scan showed to be incorrect.
README changes:
- Replaces the 5-row "System Properties Reference" table with a 9-row
table covering every net.ladenthin.llama.* property the library
understands. Columns added: Default value, Scope (runtime vs test),
and Consumer (which production class or test class reads the
property). Test-only properties (nomic.path, vision.model,
vision.mmproj, vision.image) and the runtime-but-tests-also (test.ngl)
are now visible to users without having to read CLAUDE.md or grep
the source.
- "All ... resolved by LlamaSystemProperties" claim corrected: only
runtime properties go through the registry, and even there two
inconsistencies exist (see CLAUDE.md TODO).
- Adds the MultimodalIntegrationTest self-skip note so users
understand a partial vision setup still loads.
CLAUDE.md changes:
- The "Optional models" mini-table now cross-links to the README
reference instead of being the only place the 4 test-only properties
are documented. Mini-table kept (model paths + the issue numbers
it regresses) since that's deeper context than the README needs.
- New TODO entry flags the two source-side inconsistencies the scan
surfaced:
(1) LlamaSystemProperties.getLibName() is declared but zero
production callers reach it - either wire it into LlamaLoader's
filename-resolution path or delete it as dead code;
(2) OSInfo.java:390 reads "net.ladenthin.llama.osinfo.architecture"
directly via the literal string, bypassing the registry's
getOsinfoArchitecture() getter. Same single-source-of-truth
smell as the recent BAF Radix.HEX consolidation; routing OSInfo
through the registry getter is a small follow-up.
Deep-scan inventory (9 properties total):
Runtime (resolved via LlamaSystemProperties, with caveats above):
net.ladenthin.llama.lib.path -> LlamaLoader:92
net.ladenthin.llama.lib.name -> (declared, zero callers)
net.ladenthin.llama.tmpdir -> LlamaLoader:250
net.ladenthin.llama.osinfo.architecture -> OSInfo:390 (literal, bypasses registry)
Test (declared in TestConstants):
net.ladenthin.llama.test.ngl -> 8 test classes via Integer.getInteger
net.ladenthin.llama.nomic.path -> LlamaEmbeddingsTest
net.ladenthin.llama.vision.model -> MultimodalIntegrationTest
net.ladenthin.llama.vision.mmproj -> MultimodalIntegrationTest
net.ladenthin.llama.vision.image -> MultimodalIntegrationTest
No source / test changes; doc-only commit.1 parent e673471 commit e36f631
2 files changed
Lines changed: 24 additions & 10 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
264 | 264 | | |
265 | 265 | | |
266 | 266 | | |
267 | | - | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
| 270 | + | |
| 271 | + | |
268 | 272 | | |
269 | 273 | | |
270 | 274 | | |
| |||
684 | 688 | | |
685 | 689 | | |
686 | 690 | | |
| 691 | + | |
| 692 | + | |
| 693 | + | |
| 694 | + | |
687 | 695 | | |
688 | 696 | | |
689 | 697 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
249 | 249 | | |
250 | 250 | | |
251 | 251 | | |
252 | | - | |
253 | | - | |
254 | | - | |
255 | | - | |
256 | | - | |
257 | | - | |
258 | | - | |
259 | | - | |
260 | | - | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
261 | 267 | | |
262 | 268 | | |
263 | 269 | | |
| |||
0 commit comments