Repository navigation
Conversation
There was a problem hiding this comment.
Copilot review overview
馃煛 Changes recommended
The formula cannot pass the mandatory new-formula audit until its upstream build patch is accepted or released.
Review effort: Balanced
Findings: 1
Open (1)
What changed in this PR
Adds MrDocs as a source-built formula with LLVM, Lua, and JerryScript integration.
Changes:
- Adds build dependencies and custom dependency configuration.
- Applies an upstream build patch.
- Adds a functional documentation-generation test.
| File | Description |
|---|---|
Formula/鈥媘/鈥媘rdocs.rb |
Defines the MrDocs formula, build process, patch, and test. |
馃挕 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| # Missing explicit instantiation; the link fails when the compiler inlines | ||
| # the implicit one (e.g. with Homebrew's LLVM 23.1). | ||
| # https://github.com/cppalliance/mrdocs/pull/1334 | ||
| patch :DATA |
| # Missing explicit instantiation; the link fails when the compiler inlines | ||
| # the implicit one (e.g. with Homebrew's LLVM 23.1). | ||
| # https://github.com/cppalliance/mrdocs/pull/1334 | ||
| patch :DATA |
There was a problem hiding this comment.
New formula should have no patch in general.
There was a problem hiding this comment.
Ok, got it: I wait for the companion PR to mrdocs to be included and eventually renew this PR (now it's back in draft).
|
Thanks for contributing to Homebrew! 馃帀 It looks like you're having trouble with a CI failure. See our contribution guide for help. You may be most interested in the section on dealing with CI failures. You can find the CI logs in the Checks tab of your pull request. |

HOMEBREW_NO_INSTALL_FROM_API=1 brew install --build-from-source <formula>?brew test <formula>?brew audit --strict <formula>(after doingHOMEBREW_NO_INSTALL_FROM_API=1 brew install --build-from-source <formula>)? If this is a new formula, does it passbrew audit --new <formula>?New formula for MrDocs, a C++ reference documentation generator built on Clang (172 stars, Apache-2.0 WITH LLVM-exception).
brew audit --strictandbrew lgtmpass.brew audit --newreports one problem, which is why that box is unticked:The patch adds a missing explicit template instantiation. Without it, linking
mrdocsagainst Homebrew'sllvm23.1.2 fails with an undefinedASTVisitor::populate<unsigned long long>symbol, because the compiler inlines the implicit instantiation. The fix is submitted upstream as cppalliance/mrdocs#1334 and is under review. If you'd prefer to wait until it's merged and released, I'm happy to keep this as a draft and drop the patch with the next release.Notes on the build:
depends_on "llvm"(23.1.2) instead.luaformula (5.5). mrdocs looks for aLua::luaCMake package, so the formula writes a minimalLuaConfig.cmakethat points at it. All seven upstream Lua extension golden fixtures produce output identical to the expected results with Lua 5.5.JERRY_EXTERNAL_CONTEXTand its own context header (fromutils/bootstrap/patches/jerryscript), which thejerryscriptformula doesn't provide.2026.9.29) from git history.Built and tested locally on macOS 27 (arm64). The same formula (apart from
headand an explicitlivecheckblock) also builds, passesbrew testand passesbrew audit --strictonmacos-latestandubuntu-latestin my tap's CI: https://github.com/liuq/homebrew-mrdocs/actions/runs/37187438831AI disclosure
I used Claude Code (Claude Opus 5.5) to draft the formula, investigate the link failure, write the upstream fix, and run the build, test and audit commands. I reviewed the formula and the results myself and will handle review comments personally.