docs(pm): add the missing flags to the bun install and bun add flag references - #38839
docs(pm): add the missing flags to the bun install and bun add flag references#38839robobun wants to merge 1 commit into
Conversation
…eferences bun install --help lists --linker, --minimum-release-age, --cpu, --os and --catalog, and bun add --help lists all but --catalog (which add.mdx already documents); the flag reference snippets did not mention them.
|
Warning Review limit reached
Next review available in: 16 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (2)
Comment |
|
Updated 7:56 PM PT - Aug 14th, 2026
✅ @robobun, your commit 4d3679a59b6791f6361ca7cd143d19ffbfb043b9 passed in 🧪 To try this PR locally: bunx bun-pr 38839That installs a local version of the PR into your bun-38839 --bun |
|
Status: ready for review. Docs only. Each added flag was checked against |
There was a problem hiding this comment.
LGTM — docs-only addition of already-shipped CLI flags to the flag reference tables.
What was reviewed:
- Verified all five flags (
--linker,--minimum-release-age,--cpu,--os,--catalog) exist inSHARED_TAIL_PARAMS/INSTALL_PARAMS/ADD_PARAMSinCommandLineArguments.rsand are accepted by both subcommands. - Confirmed the descriptions match the
--helpstrings and the wording already used indocs/snippets/cli/link.mdx. - Checked the
--catalogentry forbun install— it is defined inINSTALL_PARAMS(not justADD_PARAMS), so documenting it there is correct.
Extended reasoning...
Overview
This PR adds missing ParamField entries to two docs snippets (docs/snippets/cli/install.mdx and docs/snippets/cli/add.mdx) for CLI flags that already exist and work but weren't listed in the per-command flag tables: --linker, --minimum-release-age, --cpu, --os, and (for install) --catalog. No code is touched.
Security risks
None. Pure documentation change to .mdx snippet files.
Level of scrutiny
Low. This is mechanical docs backfill. I cross-checked each added flag against src/install/PackageManager/CommandLineArguments.rs:
SHARED_TAIL_PARAMS(lines 117–126) defines--linker,--minimum-release-age,--cpu,--osand is included in bothINSTALL_PARAMS(via line 168) andADD_PARAMS(viaSHARED_PARAMSat line 132/232).--catalogis defined separately in bothINSTALL_PARAMS(line 154) andADD_PARAMS(line 251), so adding it to the install snippet is correct.- The description text matches the
--helpstrings and is byte-identical to the entries already indocs/snippets/cli/link.mdx(the stated source for the wording).
Other factors
CI build #97185 passed. No prior human review comments to address. The MDX structure follows the existing ParamField / ### section pattern used throughout the file and in sibling snippets (the new Platform Targeting section header mirrors link.mdx). The PR description accurately notes placement avoids conflict with two other open PRs touching adjacent lines.
Problem
docs/snippets/cli/install.mdx, the flag reference rendered on thebun installpage, does not list--linker,--minimum-release-age,--cpu,--osor--catalog. All five are printed bybun install --help(SHARED_TAIL_PARAMSandINSTALL_PARAMSinsrc/install/PackageManager/CommandLineArguments.rs) and work.docs/snippets/cli/add.mdxhas the same gap for--linker,--minimum-release-age,--cpuand--os(it already documents--catalog).linkandpatchsnippets already carry--linker,--cpuand--os, so the two pages where these flags matter most were the ones missing them.Fix
ParamFieldentries to both snippets, using the wording thelink/patchsnippets and--helpalready use.--cpu/--osgo in aPlatform Targetingsection like the other snippets;--catalogsits next to--exact,--linkernext to--backend,--minimum-release-ageunder the security flags.bun install --helpandbun add --helpon current main, and ran prettier on both files.--network-concurrencydefault) and install: add --offline and --tarball-dir for installs without network access #36977 (--offline), so the branches merge independently.Background
docs/snippets/cli/*.mdxare included at the top of the matchingdocs/pm/cli/*.mdxpages and are the per-command flag tables; the prose sections for the linker, minimum release age and--cpu/--osfurther down the install page already existed, only the table was incomplete.