Skip to content

docs: remove obsolete GGML_NATIVE workaround - #5590

Open
satori-44 wants to merge 1 commit into
tinyhumansai:mainfrom
satori-44:docs/drop-obsolete-ggml-prefix
Open

docs: remove obsolete GGML_NATIVE workaround#5590
satori-44 wants to merge 1 commit into
tinyhumansai:mainfrom
satori-44:docs/drop-obsolete-ggml-prefix

Conversation

@satori-44

@satori-44 satori-44 commented Aug 19, 2026

Copy link
Copy Markdown

Summary

  • Remove the obsolete GGML_NATIVE=OFF prefix from active contributor-facing build and test commands.
  • Update the library recipe and benchmarking documentation to show the current commands.
  • Update the two embedding examples so their runnable documentation matches the current toolchain.

Problem

The bundled whisper.cpp STT engine and its whisper-rs dependencies were removed, but the old GGML_NATIVE=OFF workaround remained in current documentation and examples. New contributors and agents could copy an obsolete platform-specific command into otherwise valid workflows.

Solution

This documentation-only patch removes the obsolete prefix from AGENTS.md, docs/library-minimal-recipe.md, docs/library-benchmarking.md, examples/embed_headless.rs, and examples/embed_kernel.rs. Historical plans and specifications are intentionally left unchanged because they describe past implementation states.

Submission Checklist

  • Tests added or updated: N/A — documentation and example comments only.
  • Diff coverage ≥ 80%: N/A — no executable behavior changed.
  • Coverage matrix updated: N/A — behavior-only change.
  • All affected feature IDs from the matrix are listed: N/A — no feature behavior changed.
  • No new external network dependencies introduced: N/A — documentation-only change.
  • Manual smoke checklist updated: N/A — no release-cut surface changed.
  • Linked issue closed via Closes #5461 in the Related section.

Impact

No runtime, platform, security, migration, or compatibility behavior changes. The patch only makes current contributor and example commands accurate.

Related


AI Authored PR Metadata

Linear Issue

  • Key: N/A — no Linear issue associated with this contribution.
  • URL: N/A.

Commit & Branch

  • Branch: docs/drop-obsolete-ggml-prefix
  • Commit SHA: 6bb1bbabe

Validation Run

  • pnpm --filter openhuman-app format:check: blocked — dependencies are not installed in the sandbox (node_modules absent).
  • pnpm typecheck: N/A — documentation-only change.
  • Focused tests: N/A — no executable behavior changed.
  • Rust fmt/check: N/A — no Rust code changed.
  • Tauri fmt/check: N/A — no Tauri code changed.

Validation Blocked

  • command: pnpm format:check
  • error: Dependencies are not installed locally; node_modules is absent.
  • impact: The patch contains documentation and Rust doc-comment changes only. git diff --check passes, and the obsolete prefix is absent from the active issue-scoped files.

Behavior Changes

  • Intended behavior change: None.
  • User-visible effect: Current contributor and example commands no longer instruct users to set an obsolete build workaround.

Parity Contract

  • Legacy behavior preserved: Yes; only command documentation changed.
  • Guard/fallback/dispatch parity checks: N/A — no runtime code changed.

Duplicate / Superseded PR Handling

  • Duplicate PR(s): None known.
  • Canonical PR: This PR.
  • Resolution: N/A.

Summary by CodeRabbit

  • Documentation
    • Updated build, test, benchmarking, and example instructions to run without the GGML_NATIVE=OFF workaround.
    • Simplified slim-profile and minimal production build guidance.
    • Clarified profiling options and updated notes regarding removed whisper-related linking requirements.
    • Updated embedding example commands to reflect the streamlined setup.

@satori-44
satori-44 requested a review from a team August 19, 2026 12:58

@tinysweeper tinysweeper Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tinysweeper found nothing blocking. Approving.

$0.0000 · 0 in / 0 out · 230 embedded · openrouter/openai/text-embedding-3-small

@tinysweeper

tinysweeper Bot commented Aug 19, 2026

Copy link
Copy Markdown

How this change flows

0 changed behaviours across 4 relationships. 4 surrounding behaviours are shown (6 graph nodes walked). 7 further behaviours left out to keep the diagram readable.

flowchart LR
  n0["main"]:::impacted
  n1["main"]:::impacted
  n2["none"]:::impacted
  n3["map_err"]:::impacted
  n0 -->|calls| n2
  n0 -->|calls| n3
  n1 -->|calls| n2
  n1 -->|calls| n3
  classDef changed fill:#0d4429,stroke:#238636,color:#e6edf3
  classDef impacted fill:#161b22,stroke:#6e7681,color:#c9d1d9
  classDef flagged fill:#5a1e02,stroke:#d93f0b,color:#ffffff
  classDef blocking fill:#67060c,stroke:#f85149,color:#ffffff
Loading

Green: changed behaviour. Grey: surrounding behaviour. Arrows name the call, use, implementation, or test relationship. Orange: has findings. Red: has a finding that blocks the merge.

tinysweeper 0.1.0

@tinysweeper tinysweeper Bot added the priority: p3 Whenever. Cosmetic, a nicety, or a cleanup with no user visible effect. label Aug 19, 2026
@coderabbitai

coderabbitai Bot commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: bf7a75a7-57a9-4134-9397-78bfe91599ae

📥 Commits

Reviewing files that changed from the base of the PR and between ded703d and 6bb1bba.

📒 Files selected for processing (5)
  • AGENTS.md
  • docs/library-benchmarking.md
  • docs/library-minimal-recipe.md
  • examples/embed_headless.rs
  • examples/embed_kernel.rs

Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.


📝 Walkthrough

Walkthrough

The change removes the obsolete GGML_NATIVE=OFF prefix from Rust commands in contributor guidance, library documentation, and example comments. The minimal recipe also updates its explanation of the former whisper.cpp linking workaround.

Changes

Command guidance updates

Layer / File(s) Summary
Update command guidance
AGENTS.md, docs/library-benchmarking.md, docs/library-minimal-recipe.md, examples/embed_headless.rs, examples/embed_kernel.rs
Cargo build, check, test, and run commands no longer set GGML_NATIVE=OFF. The minimal recipe updates the related whisper.cpp workaround note.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to 6bb1b

This change removes obsolete build-workaround instructions from contributor documentation and examples without changing runtime behavior; no actionable merge-blocking risk remains after normal checks and review.

Suggested reviewers: senamakel

Poem

I’m a rabbit with a tidy nest,
Commands now run without the test.
No workaround prefix in sight,
Cargo hops along just right.
Documentation thumps with delight! 🐇

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies removal of the obsolete GGML_NATIVE workaround, which is the main change.
Linked Issues check ✅ Passed The changes remove the obsolete GGML_NATIVE=OFF prefix from all active documentation and examples listed in issue #5461.
Out of Scope Changes check ✅ Passed All changes are documentation updates within issue #5461 scope; no unrelated code or historical documents were changed.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

priority: p3 Whenever. Cosmetic, a nicety, or a cleanup with no user visible effect.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

chore: drop the now-obsolete GGML_NATIVE=OFF prefix from docs and examples

1 participant