Repository navigation
Correct documentation and JSON help - #24437
Merged
Merged
Conversation
Contributor
|
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
Update outdated JSON descriptions Library/Homebrew/cmd/outdated.rb, completions/fish/brew.fish, completions/zsh/_brew, docs/Manpage.md, manpages/brew.1 |
The command description, completions, and manpages identify v2 as the only supported JSON format. |
Brew bundle upgrade guidance
| Layer / File(s) | Summary |
|---|---|
Clarify brew bundle upgrade behaviour docs/Brew-Bundle-and-Brewfile.md |
The guide states that upgrades are attempted where supported and excludes installed Go, Cargo, and uv packages from newer-version checks. It clarifies that disabling upgrades does not pin versions or add lock-file support. |
Cask platform scope
| Layer / File(s) | Summary |
|---|---|
Update cask platform qualification docs/Homebrew-Package-Policies.md |
The policy text covers macOS and Linux when the cask supports the platform. |
Cursor MCP configuration
| Layer / File(s) | Summary |
|---|---|
Update Cursor configuration example docs/MCP-Server.md |
The example sets the command to brew, passes mcp-server as an argument, and sets the transport to stdio. |
Merge Risk: 
5725b
-
The documentation wording concern is fixed, and no remaining issue is identified that would prevent merging after normal checks.
Pre-merge checks: 
-
Check name Status Explanation Title check The title clearly identifies the main changes to documentation and JSON help. It is concise and related to the changeset. Description check The description accurately covers all four documentation and help-text corrections, their scope, and the reported validation results. Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request.
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.
![coderabbitai[bot]](/p/https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
-
-
- Source mode: Auto
- Repository: Unavailable
- Branch: Unavailable
- File: No configuration file from this repository applied
- Commit: Unavailable
- Layers: Organization UI
- Review profile: CHILL
- Plan: Advanced
- Run ID:
84f9ddb0-1314-443a-b896-d42671e9a2d4
-
Library/Homebrew/cmd/outdated.rbcompletions/fish/brew.fishcompletions/zsh/_brewdocs/Brew-Bundle-and-Brewfile.mddocs/Homebrew-Package-Policies.mddocs/MCP-Server.mddocs/Manpage.mdmanpages/brew.1
Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.
-
- Match Cursor's stdio configuration and Linux cask policy scope. - Explain Bundle's upgrade limits and clarify its opt-out instructions. - Remove obsolete JSON v1 guidance and regenerate command descriptions.
hezhizhen
force-pushed
the
documentation-accuracy
branch
from
November 2, 2026 07:00
3190634 to
5725b94
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Correct four discrepancies between the documentation and current behaviour:
Regenerate the manpage and fish/zsh completion descriptions from the
outdatedcommand source.Evidence
To see the outdated JSON discrepancy before this change:
./bin/brew outdated --help: it describes v1 as the default../bin/brew outdated --json=v1: it reports that v1 is no longersupported.
After this change, the help and generated descriptions consistently state
v2. The version-selection behaviour is unchanged.
The Cursor example follows the
official STDIO configuration.
All four MCP JSON examples parse successfully.
Validation:
./bin/brew generate-man-completions./bin/brew lgtm --online./bin/brew style docs: 102 files, no offencesbundle exec rake lintbundle exec rake test: 146 external links and 495 internal links checkedMerge Danger
Door: two-way. Reverting requires no migration.
Blast Radius: small. Changes are limited to documentation, help strings
and generated command descriptions; command behaviour is unchanged.
brew benchmarkresults.brewcommands to reproduce the bug?brew lgtm(style, typechecking and tests) locally?No new test files were added because this only changes documentation and
help strings. Existing command tests, JSON parsing and the documentation
checks validate the change.
OpenAI Codex assisted with investigation, the documentation edits and this
description. The contributor reviewed the patch before authorising
submission and will handle maintainer discussion directly.