Skip to content

docs: record dump_usb_ids anti-removal policy (#720)#886

Merged
zackees merged 1 commit into
mainfrom
fix/720-dump-usb-ids-anti-removal-policy
Jun 30, 2026
Merged

docs: record dump_usb_ids anti-removal policy (#720)#886
zackees merged 1 commit into
mainfrom
fix/720-dump-usb-ids-anti-removal-policy

Conversation

@zackees

@zackees zackees commented Jun 30, 2026

Copy link
Copy Markdown
Member

Documentation-only PR per #720.

crates/fbuild-core/examples/dump_usb_ids.rs is tier-1 of the nightly USB-VID merge — .github/workflows/update-data.yml invokes it, then tools/merge_sources.py unions its output with the linux-usb.org mirror, the usbids GitHub mirror, and the curated vendor_names_inlined.py overlay to produce online-data/data/usb-vid.json. Because the usb-ids workspace dep exists only for this example, removing the example would drop the aggregator from 4 to 3 independent sources of truth.

Two doc additions to prevent future LLM-driven cleanup passes from dropping it:

  1. Banner comment at the top of the example explicitly citing policy: dump_usb_ids must remain (tier-1 source for online-data aggregation) #720 and the dependency-coupling rationale.
  2. crates/CLAUDE.md fbuild-core row mentions the example + policy so it surfaces in the per-crate routing the existing doc structure uses.

No code changes.

Closes #720

#720 escalates the policy after #719's near-removal of
`crates/fbuild-core/examples/dump_usb_ids.rs` to a documented anti-
removal rule. The example is tier-1 of the nightly USB-VID merge
(`.github/workflows/update-data.yml` -> `tools/merge_sources.py`),
and the `usb-ids` workspace dep exists only for it; removing the
example would also remove the dep, dropping the aggregator from
4 → 3 independent sources of truth.

Two doc additions:

1. Banner in `crates/fbuild-core/examples/dump_usb_ids.rs`
   explicitly tells future LLM-driven cleanup passes to read #720
   before deleting, and explains the dependency-coupling rationale.
2. `crates/CLAUDE.md` `fbuild-core` row mentions the example +
   policy so it surfaces in the per-crate routing the existing
   doc structure uses.

Closes #720
@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@zackees, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 54 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 00a60e36-c71e-43f6-afaf-107ac6f2ebc0

📥 Commits

Reviewing files that changed from the base of the PR and between 8bab4db and 1dd05f2.

📒 Files selected for processing (2)
  • crates/CLAUDE.md
  • crates/fbuild-core/examples/dump_usb_ids.rs
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/720-dump-usb-ids-anti-removal-policy

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.

❤️ Share

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

@zackees
zackees merged commit 582594b into main Jun 30, 2026
80 of 93 checks passed
@zackees
zackees deleted the fix/720-dump-usb-ids-anti-removal-policy branch June 30, 2026 18:08
zackees added a commit that referenced this pull request Jun 30, 2026
Rolls up the fixes shipped since 2.3.14:

- #855 (#883) — drop stale standalone-zccache CI/Docker/docs references
  after the soldr embedded-zccache transition (soldr#977/#980/#1081)
- #865 (#884) — write daemon status via sync write_atomic; unblocks
  fbuild-daemon unit tests on macOS/Windows by eliminating the
  block_in_place panic in current-thread tokio runtimes
- #875 (#885) — pin TMP/TEMP for compiler subprocess on Windows; ESP32
  compile no longer fails with 'Cannot create temporary file in
  C:\Windows\' on the very first TU
- #720 (#886) — record anti-removal policy for dump_usb_ids example
- #829 (#887) — stage fbuild._native cdylib during source/editable
  install so 'from fbuild import ...' works after 'uv pip install -e .'

Plus all prior #664 platform_packages audit work, the #826 testing
followups, and the build cancellation fix from earlier in the cycle.
@fastled-project-sync fastled-project-sync Bot moved this to Triage in FastLED Tracker Jul 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Triage

Development

Successfully merging this pull request may close these issues.

policy: dump_usb_ids must remain (tier-1 source for online-data aggregation)

1 participant