Skip to content

[bsp][stm32] clarify BSP template copy path#11540

Merged
Rbb666 merged 1 commit into
RT-Thread:masterfrom
Old-Ding:codex/docs-stm32-template-usage
Jul 5, 2026
Merged

[bsp][stm32] clarify BSP template copy path#11540
Rbb666 merged 1 commit into
RT-Thread:masterfrom
Old-Ding:codex/docs-stm32-template-usage

Conversation

@Old-Ding

@Old-Ding Old-Ding commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Clarify that STM32 BSP templates should be copied into bsp/stm32/<board> before running menuconfig, pkgs --update, or scons.
  • Explain why running these commands directly under bsp/stm32/libraries/templates/<series> fails: the template directory is two levels deeper than a real BSP, so the relative Kconfig paths do not resolve to the RT-Thread root.
  • Update both the Chinese and English STM32 BSP creation guides.

Addresses #11341.

Validation

  • git diff --check
  • Verified the relative path layout locally:
    • real BSP ../../../ resolves to the repository root
    • template ../../../ resolves to bsp/stm32
    • template ../../../../.. resolves to the repository root

Docs-only change; no build was run.

@github-actions

github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown

👋 感谢您对 RT-Thread 的贡献!Thank you for your contribution to RT-Thread!

为确保代码符合 RT-Thread 的编码规范,请在你的仓库中执行以下步骤运行代码格式化工作流(如果格式化CI运行失败)。
To ensure your code complies with RT-Thread's coding style, please run the code formatting workflow by following the steps below (If the formatting of CI fails to run).


🛠 操作步骤 | Steps

  1. 前往 Actions 页面 | Go to the Actions page
    点击进入工作流 → | Click to open workflow →

  2. 点击 Run workflow | Click Run workflow

  • 设置需排除的文件/目录(目录请以"/"结尾)
    Set files/directories to exclude (directories should end with "/")
  • 将目标分支设置为 \ Set the target branch to:codex/docs-stm32-template-usage
  • 设置PR number为 \ Set the PR number to:11540
  1. 等待工作流完成 | Wait for the workflow to complete
    格式化后的代码将自动推送至你的分支。
    The formatted code will be automatically pushed to your branch.

完成后,提交将自动更新至 codex/docs-stm32-template-usage 分支,关联的 Pull Request 也会同步更新。
Once completed, commits will be pushed to the codex/docs-stm32-template-usage branch automatically, and the related Pull Request will be updated.

如有问题欢迎联系我们,再次感谢您的贡献!💐
If you have any questions, feel free to reach out. Thanks again for your contribution!

@github-actions github-actions Bot added BSP: STM32 BSP related with ST/STM32 BSP labels Jul 1, 2026
@github-actions

github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown

📌 Code Review Assignment

🏷️ Tag: bsp_stm32

Reviewers: @Liang1795 @hamburger-os @wdfk-prog

Changed Files (Click to expand)
  • bsp/stm32/docs/How to make a STM32 BSP for RT-Thread.md
  • bsp/stm32/docs/STM32系列BSP制作教程.md

📊 Current Review Status (Last Updated: 2026-07-01 10:24 CST)


📝 Review Instructions

  1. 维护者可以通过单击此处来刷新审查状态: 🔄 刷新状态
    Maintainers can refresh the review status by clicking here: 🔄 Refresh Status

  2. 确认审核通过后评论 LGTM/lgtm
    Comment LGTM/lgtm after confirming approval

  3. PR合并前需至少一位维护者确认
    PR must be confirmed by at least one maintainer before merging

ℹ️ 刷新CI状态操作需要具备仓库写入权限。
ℹ️ Refresh CI status operation requires repository Write permission.

@CYFS3 CYFS3 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm

@Rbb666 Rbb666 merged commit 5882e6a into RT-Thread:master Jul 5, 2026
42 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

BSP: STM32 BSP related with ST/STM32 BSP

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants