Skip to content

Commit 86fd2bf

Browse files
committed
docs: re-root the upgrade-checklist file references to llama/ in CLAUDE.md
The per-section upgrade instructions (CUDA/Android/OpenCL/Windows classifier steps and the llama.cpp version bump) name the core `pom.xml` / `CMakeLists.txt` that a contributor would copy-paste — those now live in llama/. Re-rooted the precise `**pom.xml**` / `**CMakeLists.txt**` callouts, the `# Edit …` lines, the `git add …` lines, and the build-webui GIT_TAG reference to llama/. The **root** aggregator pom.xml (the version-bump target) is deliberately left unqualified. The loose build-command examples (cmake -B build / mvn compile) remain covered by the "read root examples as running in llama/" note in the Repository layout section. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Rt1paYztGJ2AKUuBuAGDXE
1 parent 71b3859 commit 86fd2bf

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

CLAUDE.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ To change the CUDA version, update the following **three** places:
1616

1717
1. **`.github/build_cuda_linux.sh`** — Line 10: `sudo dnf install -y cuda-toolkit-13-2`
1818
2. **`.github/build_cuda_linux.sh`** — Line 12: `-DCMAKE_CUDA_COMPILER=/usr/local/cuda-13.2/bin/nvcc`
19-
3. **`pom.xml`** — The `<classifier>` tag in the `cuda` jar execution: `cuda13-linux-x86-64`
19+
3. **`llama/pom.xml`** — The `<classifier>` tag in the `cuda` jar execution: `cuda13-linux-x86-64`
2020

2121
Also update the header comment in `build_cuda_linux.sh` and the job name in `.github/workflows/release.yaml` for clarity.
2222

@@ -32,9 +32,9 @@ Example: To upgrade from 13.2 to a hypothetical 13.3:
3232
# Edit .github/build_cuda_linux.sh:
3333
# line 10: cuda-toolkit-13-2 -> cuda-toolkit-13-3
3434
# line 12: /usr/local/cuda-13.2/bin/nvcc -> /usr/local/cuda-13.3/bin/nvcc
35-
# Edit pom.xml classifier: cuda13-linux-x86-64 (major version only, no need to change for minor bumps)
35+
# Edit llama/pom.xml classifier: cuda13-linux-x86-64 (major version only, no need to change for minor bumps)
3636
# Edit CLAUDE.md line: Current CUDA version: **13.2** -> **13.3**
37-
git add .github/build_cuda_linux.sh pom.xml CLAUDE.md
37+
git add .github/build_cuda_linux.sh llama/pom.xml CLAUDE.md
3838
git commit -m "Upgrade CUDA from 13.2 to 13.3"
3939
```
4040

@@ -88,7 +88,7 @@ This is enforced through bionic's **weak-symbol** mechanism, *not* by bumping
8888
`__ANDROID_API__` or passing `-DANDROID_PLATFORM`. See "How the API gate is
8989
satisfied" below for why. To change anything here, update:
9090

91-
1. **`CMakeLists.txt`** — the `add_compile_definitions(__ANDROID_UNAVAILABLE_SYMBOLS_ARE_WEAK__)`
91+
1. **`llama/CMakeLists.txt`** — the `add_compile_definitions(__ANDROID_UNAVAILABLE_SYMBOLS_ARE_WEAK__)`
9292
block and its Android-detection guard (`OS_NAME MATCHES "Android"` etc.).
9393
2. **`CLAUDE.md`** (this file) — the "Current Android minimum API level" line above.
9494
3. **`README.md`** — the minimum-API note (the `[!NOTE]` block near the Android
@@ -134,15 +134,15 @@ The default Android arm64 JAR remains CPU-only.
134134

135135
Three places wire it together (mirrors the CUDA classifier pattern):
136136

137-
1. **`CMakeLists.txt`**`elseif(GGML_OPENCL)` branch routes artifacts to
137+
1. **`llama/CMakeLists.txt`**`elseif(GGML_OPENCL)` branch routes artifacts to
138138
`src/main/resources_android_opencl/net/ladenthin/llama/${OS_NAME}/${OS_ARCH}/`.
139139
2. **`.github/workflows/publish.yml`**`crosscompile-android-aarch64-opencl`
140140
job runs the dockcross-android-arm64 build with
141141
`-DGGML_OPENCL=ON -DGGML_OPENCL_EMBED_KERNELS=ON -DGGML_OPENCL_USE_ADRENO_KERNELS=ON`
142142
and uploads as artifact `android-libraries-opencl`. The `package`,
143143
`publish-snapshot`, and `publish-release` jobs download it into
144144
`resources_android_opencl/` and activate the `opencl-android` Maven profile.
145-
3. **`pom.xml`** — the `opencl-android` profile produces a second JAR with
145+
3. **`llama/pom.xml`** — the `opencl-android` profile produces a second JAR with
146146
`<classifier>opencl-android-aarch64</classifier>` from the
147147
`${project.build.outputDirectory}_opencl_android` tree.
148148

@@ -196,7 +196,7 @@ local / self-hosted.
196196

197197
Wiring (mirrors the CUDA-Linux / OpenCL-Android classifier pattern):
198198

199-
1. **`CMakeLists.txt`** — the `if(GGML_CUDA) … elseif(GGML_VULKAN) … elseif(GGML_OPENCL) … else()`
199+
1. **`llama/CMakeLists.txt`** — the `if(GGML_CUDA) … elseif(GGML_VULKAN) … elseif(GGML_OPENCL) … else()`
200200
chain is **OS-aware**: CUDA → `resources_windows_cuda` on Windows (else `resources_linux_cuda`),
201201
Vulkan → `resources_windows_vulkan`, OpenCL → `resources_windows_opencl` on Windows (else
202202
`resources_android_opencl`). The default CPU build (both generators) still emits to the canonical
@@ -225,7 +225,7 @@ Wiring (mirrors the CUDA-Linux / OpenCL-Android classifier pattern):
225225
The `package`, `publish-snapshot`, and `publish-release` jobs download each non-default artifact into
226226
its `src/main/resources_windows_{msvc,cuda,vulkan,opencl}/` tree and activate the
227227
`windows-msvc,cuda-windows,vulkan-windows,opencl-windows` Maven profiles.
228-
5. **`pom.xml`** — profiles `windows-msvc` / `cuda-windows` / `vulkan-windows` / `opencl-windows`,
228+
5. **`llama/pom.xml`** — profiles `windows-msvc` / `cuda-windows` / `vulkan-windows` / `opencl-windows`,
229229
each a separate compile pass + resource copy + classified jar (classifiers `msvc-windows` /
230230
`cuda13-windows-x86-64` / `vulkan-windows-x86-64` / `opencl-windows-x86-64`). Activated only in CI.
231231
6. **`README.md`** — the classifier table + dependency snippets in "Choosing the right classifier".
@@ -263,7 +263,7 @@ checked in (same policy as the native libs).
263263
Pipeline (`.github/workflows/publish.yml`):
264264

265265
1. **`build-webui` job** (ubuntu — the *only* job that runs `npm`): resolves the
266-
pinned `b<nnnn>` tag from `CMakeLists.txt`'s `GIT_TAG`, sparse-checks-out
266+
pinned `b<nnnn>` tag from `llama/CMakeLists.txt`'s `GIT_TAG`, sparse-checks-out
267267
`ggml-org/llama.cpp@<tag>` `tools/ui`, runs the upstream Svelte build
268268
(`npm ci && npm run build`), gzips `dist/` into `dist/_gzip/` (LLAMA_UI_GZIP
269269
parity), builds the self-contained `llama-ui-embed` host tool (plain C++17, **no
@@ -472,16 +472,16 @@ re-verify the generator the same way you re-verify `patches/`.
472472

473473
To change the llama.cpp version, update the following **three** files (and re-verify `patches/`):
474474

475-
1. **CMakeLists.txt** — the `GIT_TAG` line for llama.cpp: `GIT_TAG b8831`
475+
1. **llama/CMakeLists.txt** — the `GIT_TAG` line for llama.cpp: `GIT_TAG b8831`
476476
2. **README.md** — the badge and link line with the version number
477477
3. **CLAUDE.md** — the "Current llama.cpp pinned version" line
478478

479479
Example: To upgrade from b8808 to b8831:
480480
```bash
481-
# Edit CMakeLists.txt: change GIT_TAG b8808 to b8831
481+
# Edit llama/CMakeLists.txt: change GIT_TAG b8808 to b8831
482482
# Edit README.md: change b8808 to b8831 (in both badge and link)
483483
# Edit CLAUDE.md: change b8808 to b8831
484-
git add CMakeLists.txt README.md CLAUDE.md
484+
git add llama/CMakeLists.txt README.md CLAUDE.md
485485
git commit -m "Upgrade llama.cpp from b8808 to b8831"
486486
git push -u origin <your-branch>
487487
```

0 commit comments

Comments
 (0)