docs: regenerate CLI parameters reference - #1402
Conversation
Ran docs/gen_cli_docs.py against current settings.c/h. Picks up blackbox_disable_* bitflags (emuflight#1332) and altitude_limit/Position Config (emuflight#1260), neither previously captured in the last regen. emuflight#1400 (dmaopt claim-status warning) touched only cli.c runtime diagnostics, not settings.c/h, so it adds no rows here.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 4 included reviews per hour; 1 remains after this review. 📜 Recent review details⏰ Context from checks skipped due to timeout. (16)
🔇 Additional comments (1)
📝 WalkthroughWalkthroughThe CLI parameter reference updates its generated metadata, adds Blackbox recording bitflags, and documents the master-scoped ChangesCLI Reference Updates
Estimated code review effort: 1 (Trivial) | ~5 minutes Merge Risk: ⚪ Minimal · up to This is a localized documentation-only regeneration with no production behavior changes; no actionable merge-blocking risk remains beyond normal checks and review. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Description checkExplanation The description explains the regeneration source, lists the captured parameters, clarifies the scope of PR Full details: Docstring CoverageExplanation No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.) 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Folds the PG-backed commands table into parameters-reference.md as a new CLI Commands (PG-Backed) section instead of a separate file, matching emuflight#1403's own wording ("emit a second doc section"). Retitles the doc header to CLI Reference since it now covers both valueTable[] settings and cmdTable[] commands; filename unchanged. Requires a full regen of parameters-reference.md's existing content (last regenerated 2026-06-13), which also picks up unrelated settings.c drift since then (Position Config's altitude_limit, blackbox_disable_* bitflags) and populates the Requires column throughout via the prior commit's regex fix. This is the same regen the separate, still-open emuflight#1402 was doing -- emuflight#1402 becomes redundant once this merges. Closes emuflight#1403
Adds a cmdTable[] parser to docs/gen_cli_docs.py and a CLI Commands (PG-Backed) section inside docs/CLI/parameters-reference.md, covering 12 commands whose config persists through their own dedicated table/handler instead of valueTable[]: adjrange, aux, color, dma, led, mmix, mode_color, rxfail, rxrange, serial, smix, vtx. Fixes _extract_use_conditions()/_format_requires(): double-escaped backslashes in raw-string regexes meant the Requires column was empty for every entry regardless of #ifdef guards. Full regen of parameters-reference.md (last regenerated 2026-06-13) also picks up unrelated settings.c drift (Position Config's altitude_limit, blackbox_disable_* bitflags) -- supersedes #1402. Closes #1403
1 participant
AI Generated pull-request
Ran
docs/gen_cli_docs.pyagainst currentsettings.c/settings.hat HEADb50c475a7.Picks up parameters added since the last regen (
47a13a7155, 2026-06-13):blackbox_disable_pids/_rc/_setpoint/_bat/_mag/_alt/_rssi/_gyro/_acc/_debug/_motors/_gps/_gyrounfiltbitflags (feat(blackbox): output field masking via CLI (BF 4.5 parity) #1332)altitude_limitunder newPosition Configsection (feat(osd): altitude limit warning #1260)#1400 (dmaopt claim-status warning) touches only
cli.cruntime diagnostics, notsettings.c/settings.h— verified its isolated diff adds zero rows to the generated parameter table. No dmaopt-related content is expected or present in this regen.Test plan
python3 docs/gen_cli_docs.pyrun clean, 501 parameters across 56 sectionsdocs/CLI/parameters-reference.md, reviewed line-by-lineSummary by CodeRabbit
altitude_limitparameter.