Skip to content

Apply the pre-release audit recommendations (audit/apply-20261004) - #23

Merged
Jiu-xiao merged 3 commits into
devfrom
audit/apply-20261004
Oct 4, 2026
Merged

Jiu-xiao merged 3 commits into
devfrom
audit/apply-20261004

Conversation

@Jiu-xiao

@Jiu-xiao Jiu-xiao commented Oct 4, 2026 •

Copy link
Copy Markdown
Contributor

Changes recommended by the pre-release audit of 2026-10-04 and approved by the owner. Each commit names what it changes.

Summary by Sourcery

Apply the pre-release audit updates to USB identification and project documentation.

Bug Fixes:

  • Update USB device identification to use the approved vendor/product IDs and remove the hard-coded serial suffix while retaining unique device identity handling.

Enhancements:

  • Clarify hardware object-name mappings, configuration usage, build behavior, generated-file ownership, and current XRobot/LibXR documentation in English and Chinese.
  • Document libxr stm32 setup as the standard workflow for regenerating STM32 BSP and LibXR configuration files while preserving user-code regions.

Documentation:

  • Refresh README and AGENTS guidance for configuration naming, build optimization, generation workflows, CI behavior, and current documentation links.

The README keeps this BSP's own values and links the LibXR.CMake rules and
the shared CI to the website. The directory listing is a text block as in
the other BSPs, commands carry no prompt, the configuration link points to
the format page, and regeneration uses libxr stm32 setup, which leaves an
unchanged project untouched; AGENTS.md no longer calls it a one-time
command. Section 1 lists the 0.x aliases with the object names that replace
them.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry @Jiu-xiao, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 5 days and 21 hours by commenting @sourcery-ai review. Upgrade to get a review now.

@sourcery-ai

sourcery-ai Bot commented Oct 4, 2026

Copy link
Copy Markdown

Reviewer's Guide

The PR applies pre-release audit recommendations by aligning contributor and user documentation with the current LibXR/CubeMX generation workflow and hardware naming conventions, and by updating both configured and generated USB descriptors to the new VID/PID and serial format.

Flow diagram for the LibXR STM32 generation workflow

flowchart LR
    CubeMX[CubeMX project or libxr_config.yaml] --> Setup[libxr stm32 setup]
    Setup --> Generated[Generated BSP files and LibXR.CMake]
    Generated --> Build[CMake build and CI verification]
    CI[Shared BSP CI] --> Setup
    CI --> Build
Loading

File-Level Changes

Change Details Files
Document the current hardware naming model and simplify the project-generation workflow.
  • Replace the duplicated path tables with bilingual hardware-alias-to-object mappings and a concise repository layout.
  • Document libxr stm32 setup as the regeneration command for CubeMX and LibXR configuration changes.
  • Clarify build optimization scopes, CI behavior, configuration documentation links, generated-file handling, and command examples.
AGENTS.md
README.md
Update USB identity descriptors to use the approved vendor/product identifiers and a device-generated serial suffix.
  • Change FS and HS VID/PID values from 0x16D0/0x1492 to 0x1D50/0x6199.
  • Remove the hard-coded serial suffix while retaining the MCU UID as the descriptor serial source.
User/app_main.cpp
User/libxr_config.yaml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@Jiu-xiao
Jiu-xiao merged commit e38032e into dev Oct 4, 2026
3 of 14 checks passed
@Jiu-xiao
Jiu-xiao deleted the audit/apply-20261004 branch October 4, 2026 20:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant