Skip to content

docs: update macOS platform support for cross-compilation#520

Merged
OGKevin merged 2 commits into
masterfrom
ogkevin/push/rvvvuppwxpsr
May 26, 2026
Merged

docs: update macOS platform support for cross-compilation#520
OGKevin merged 2 commits into
masterfrom
ogkevin/push/rvvvuppwxpsr

Conversation

@OGKevin

@OGKevin OGKevin commented May 26, 2026

Copy link
Copy Markdown
Owner

Change-Id: 84445aa32a78aa2fe745a945bfbb1a5a
Change-Id-Short: rvvvuppwxpsr

Change-Id: 84445aa32a78aa2fe745a945bfbb1a5a
Change-Id-Short: rvvvuppwxpsr
@OGKevin OGKevin self-assigned this May 26, 2026
@coderabbitai coderabbitai Bot added the documentation Improvements or additions to documentation label May 26, 2026
@coderabbitai

coderabbitai Bot commented May 26, 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: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 3e054634-32dd-4526-b56a-17a5212bb60c

📥 Commits

Reviewing files that changed from the base of the PR and between f16783c and cff3ecf.

📒 Files selected for processing (1)
  • docs/src/contributing/devenv-setup.md
✅ Files skipped from review due to trivial changes (1)
  • docs/src/contributing/devenv-setup.md
📜 Recent review details
⏰ Context from checks skipped due to timeout of 900000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
  • GitHub Check: Analyze (actions)
  • GitHub Check: Analyze (rust)
  • GitHub Check: Analyze (python)
  • GitHub Check: Analyze (c-cpp)
  • GitHub Check: build

Walkthrough

Development environment documentation updated to reflect expanded Kobo build support and improved macOS capabilities. Build task references no longer mark Kobo as Linux-only, and the macOS platform support section was reframed from limited native-only development to full support with updated capabilities.

Changes

Kobo and macOS Support Documentation Updates

Layer / File(s) Summary
Kobo build task references
docs/src/contributing/devenv-setup.md
cargo xtask build-kobo command and build:kobo task entries are updated; "Linux only" qualifier removed, and task dependency on docs:build now documented.
macOS platform support narrative
docs/src/contributing/devenv-setup.md
macOS section rewritten from "Native Development Only" framing to "macOS (Full Support)" heading with revised bullet points and clarified macOS-specific capabilities.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • OGKevin/cadmus#518: Updates related to Kobo cross-compilation and macOS vs Linux build guidance referenced in docs and xtask changes.

Suggested labels

documentation

Poem

Docs refreshed, the instructions glow,
Kobo builds where macOS can go.
Linux note removed from view,
Full support now sings anew. ✨

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title follows the Conventional Commits format with 'docs:' prefix and clearly describes the main change of updating macOS platform support documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/src/contributing/devenv-setup.md`:
- Around line 192-193: The sentence saying the Linaro toolchain is “downloaded
and patched via patchelf at setup time” is inaccurate for macOS; change it to
state that patchelf is only used during the distribution/packaging step to
modify generated ELF artifacts (rpath removal) rather than during macOS
toolchain setup. Mention that ELF patching is disabled on Darwin (dontPatchELF /
isDarwin in devenv.nix and autoPatchelfHook is Linux-only) and that patchelf is
invoked in the packaging path (see strip_and_patch() in xtask/src/tasks/dist.rs
where `patchelf --remove-rpath` runs as part of `cargo xtask dist`).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 8d831bc7-91fc-4f18-b817-0b0f697df7ec

📥 Commits

Reviewing files that changed from the base of the PR and between d61537a and f16783c.

📒 Files selected for processing (1)
  • docs/src/contributing/devenv-setup.md
📜 Review details
⏰ Context from checks skipped due to timeout of 900000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
  • GitHub Check: build
  • GitHub Check: Analyze (python)
  • GitHub Check: Analyze (rust)
  • GitHub Check: Analyze (actions)
  • GitHub Check: Analyze (c-cpp)
🧰 Additional context used
📓 Path-based instructions (3)
docs/src/**/*.md

📄 CodeRabbit inference engine (docs/AGENTS.md)

docs/src/**/*.md: Use conversational and friendly tone in user-facing documentation
Use active voice in user-facing documentation (e.g., 'Copy the file', not 'The file should be copied')
Avoid jargon in user-facing documentation: replace 'artifact' with 'file' or 'package', 'deploy' with 'install' or 'download', 'configure' with 'set up', 'bundle' with 'package', 'on-device' with 'on your Kobo' or 'wirelessly'
Use standard admonitions (NOTE, TIP, WARNING) in markdown with the syntax: > [!NOTE], > [!TIP], > [!WARNING]

Files:

  • docs/src/contributing/devenv-setup.md
docs/src/contributing/**/*.md

📄 CodeRabbit inference engine (docs/AGENTS.md)

docs/src/contributing/**/*.md: Contributor documentation should be clear and direct with technical terminology appropriate for developers
Include code examples in contributor documentation where helpful
Document setup steps precisely in contributor documentation

Files:

  • docs/src/contributing/devenv-setup.md
docs/**/*.md

📄 CodeRabbit inference engine (docs/AGENTS.md)

docs/**/*.md: Format Markdown files with Prettier
Ensure Markdown passes markdownlint validation
Use code blocks with language tags in documentation

Files:

  • docs/src/contributing/devenv-setup.md
🔇 Additional comments (1)
docs/src/contributing/devenv-setup.md (1)

55-55: LGTM!

Also applies to: 80-80

Comment thread docs/src/contributing/devenv-setup.md Outdated
@OGKevin
OGKevin temporarily deployed to cloudflare-pages-preview May 26, 2026 18:10 — with GitHub Actions Inactive
@coderabbitai coderabbitai Bot removed the documentation Improvements or additions to documentation label May 26, 2026
@OGKevin
OGKevin merged commit ac32e8e into master May 26, 2026
11 checks passed
@OGKevin
OGKevin deleted the ogkevin/push/rvvvuppwxpsr branch May 26, 2026 19:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant