Skip to content

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

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

Jiu-xiao merged 4 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 recommendations across hardware configuration, USB identity settings, and project documentation.

Bug Fixes:

  • Correct SPI6 configuration by adding an RX buffer and enabling full transfer-length support.
  • Update USB identification values and remove the hard-coded serial number.

Documentation:

  • Update configuration and build documentation links and describe shared CI checks and tag-based firmware publishing.
  • Document the repository license and bundled third-party licenses.

@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 (collapsed on small PRs)

Reviewer's Guide

The PR applies audit-approved documentation updates, enables SPI6 reception with dedicated D3 RAM buffering, and synchronizes the USB device identity changes between configuration and application code.

Sequence diagram for SPI6 and USB device initialization

sequenceDiagram
    participant App as app_main
    participant SPI6 as STM32SPI
    participant USBDesc as USB::DeviceDescriptor
    participant USB as USB device

    App->>SPI6: STM32SPI(&hspi6, spi6_rx_buf, spi6_tx_buf, UINT32_MAX)
    App->>USBDesc: USB::DeviceDescriptor(..., 0x1D50, 0x6199, 0xF407, ...)
    App->>USB: Init(false)
Loading

File-Level Changes

Change Details Files
Update project documentation to reflect current configuration, CI, build, and licensing guidance.
  • Refresh configuration and optimization documentation links and wording.
  • Document shared CI checks and tag-triggered firmware publication.
  • Add repository and bundled third-party license references.
README.md
Enable SPI6 receive buffering and update its transfer configuration.
  • Add aligned SPI6 RX storage in D3 RAM.
  • Pass the RX buffer to the SPI6 driver and remove the fixed transfer-count limit.
User/app_main.cpp
Apply the audited USB identity configuration consistently across generated/runtime settings.
  • Change USB VID/PID values.
  • Shorten the serial prefix and match the runtime USB descriptor string.
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 728db64 into dev Oct 4, 2026
3 of 5 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