Skip to content

Fix stale docs: upgrade example, build_info note, CHAT compat version… #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bernardladenthin merged 1 commit into from
Apr 18, 2026
Merged

Fix stale docs: upgrade example, build_info note, CHAT compat version… #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CHAT_INTEGRATION_SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Origin

Based on a large patch by **@vaiju1981** that proposed OpenAI-compatible chat completions and JSON-in/JSON-out endpoints for the java-llama.cpp project. The patch was reimplemented from scratch against the current codebase (llama.cpp b8611) with significant improvements.
Based on a large patch by **@vaiju1981** that proposed OpenAI-compatible chat completions and JSON-in/JSON-out endpoints for the java-llama.cpp project. The patch was reimplemented from scratch against the codebase at llama.cpp b8611 with significant improvements.

### CI Status: All 16/16 jobs green

Expand Down Expand Up @@ -109,9 +109,9 @@ macOS 14 (Metal), macOS 15 (Metal + no-Metal), Ubuntu, Windows (x86 + x86\_64),

---

## Upstream Compatibility (llama.cpp b8611)
## Upstream Compatibility (originally verified at llama.cpp b8611; compatible through b8831)

Verified against `ggml-org/llama.cpp` master:
Verified against `ggml-org/llama.cpp` at b8611; no chat-specific breaking changes were introduced in any subsequent upgrade through b8831.

| Feature | Status |
|---------|--------|
Expand Down
23 changes: 12 additions & 11 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,18 +42,18 @@ git commit -m "Upgrade CUDA from 13.2 to 13.3"

To change the llama.cpp version, update the following **three** files:

1. **CMakeLists.txt** — Line 28: `GIT_TAG b5022`
2. **README.md** — Line 2: Badge and link with version number
3. **CLAUDE.md** — Line 9: This documentation
1. **CMakeLists.txt** — the `GIT_TAG` line for llama.cpp: `GIT_TAG b8831`
2. **README.md** — the badge and link line with the version number
3. **CLAUDE.md** — the "Current llama.cpp pinned version" line

Example: To upgrade from b5016 to b5022:
Example: To upgrade from b8808 to b8831:
```bash
# Edit CMakeLists.txt, line 28: change b5016 to b5022
# Edit README.md, line 2: change b5016 to b5022 (in both badge and link)
# Edit CLAUDE.md, line 9: change b5016 to b5022
# Edit CMakeLists.txt: change GIT_TAG b8808 to b8831
# Edit README.md: change b8808 to b8831 (in both badge and link)
# Edit CLAUDE.md: change b8808 to b8831
git add CMakeLists.txt README.md CLAUDE.md
git commit -m "Upgrade llama.cpp from b5016 to b5022"
git push -u origin claude/upgrade-llama-cpp-b4927-EaJcb
git commit -m "Upgrade llama.cpp from b8808 to b8831"
git push -u origin <your-branch>
```

**Note:** Always test the build with `cmake -B build && cmake --build build --config Release` after version changes to catch compatibility issues early.
Expand Down Expand Up @@ -107,12 +107,13 @@ jllama.cpp / server.hpp / utils.hpp

**Priority-ordered review list for upgrade diffs** (highest break risk first)

The top 8 rows cover all known breaking changes from b5022 → b8831.
The top 8 rows cover all known API-level breaking changes from b5022 → b8831.
For future upgrades, provide diffs for at least these 8 files rather than the full patch.
Also review the project `CMakeLists.txt` for build-system-level breaks (e.g. renamed link targets, new required headers) — those are not visible in header file diffs alone.

| File | What to watch for |
|------|-------------------|
| `common/common.h` | `common_params`/`common_params_speculative` struct fields, `model_alias` container type, `common_init_result` shape, `build_info` symbol |
| `common/common.h` | `common_params`/`common_params_speculative` struct fields, `model_alias` container type, `common_init_result` shape, `build_info` symbol (removed in b8831 — now `llama_build_info()` from `build-info.h`) |
| `common/chat.h` | `common_chat_parser_params` (was `common_chat_syntax`), `to_json_oaicompat`, `common_chat_msg_diff_to_json_oaicompat`, `set_tool_call_ids` |
| `common/speculative.h` | `common_speculative_init`, `common_speculative_draft`, `common_speculative_accept` signatures, struct names |
| `tools/mtmd/mtmd.h` | `mtmd_context_params` fields, `image_marker`/`media_marker` API, deprecated symbols (was `common/mtmd.h` before ~b8190) |
Expand Down
6 changes: 5 additions & 1 deletion CLAUDE_TEST_GENERATION_PROMPT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
Use this prompt in a fresh Claude Code session to reproduce all AI-generated
unit tests in this repository.

> **Status:** All tasks in this prompt have been executed. The 8 test files listed below already exist.
> Re-running this prompt as-is will conflict with the existing files.
> Update or skip steps that have already been completed.

---

## Prompt
Expand Down Expand Up @@ -93,7 +97,7 @@ Create each file below. Follow the existing style exactly: JUnit 4,
- `testSetTokenIdBiasMultiple`

#### `src/test/java/de/kherud/llama/LlamaOutputTest.java`
- `testTextFromBytes` — `new LlamaOutput("hello".getBytes(UTF_8), emptyMap, false)` → text == "hello"
- `testTextFromString` — `new LlamaOutput("hello", emptyMap, false)` → text == "hello"
- `testEmptyText`
- `testUtf8MultibyteText` — round-trip with "héllo wörld"
- `testProbabilitiesStored` — map with 2 entries
Expand Down
Loading