Skip to content

format/rsoc：clang format ignore migration #10828

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Nov 13, 2025
Merged

format/rsoc：clang format ignore migration #10828

merged 1 commit into from
Nov 13, 2025

Conversation

@westcity-YOLO
Copy link
Contributor

@westcity-YOLO westcity-YOLO commented Oct 16, 2025

拉取/合并请求描述 (PR description)

为什么提交这份PR (why to submit this PR)

迁移 RT-Thread 项目的代码格式化忽略机制，从自定义的 .ignore_format.yml 格式迁移到 clang-format 原生的 .clang-format-ignore 机制，以统一代码格式化工具的使用。

你的解决方案是什么 (what is your solution)

删除所有原有的 .ignore_format.yml 文件，并在相应位置创建 .clang-format-ignore 文件，使用 clang-format 原生的忽略语法规则。新的忽略机制采用类似 .gitignore 的语法，支持通配符模式和路径匹配。

请提供验证的bsp和config (provide the config and bsp)

  • BSP: 不适用（本次修改为工具链配置迁移）
  • .config: 不适用（本次修改不涉及功能配置）
  • action: [请在此处添加你的 GitHub Actions 编译链接]

新增的 .clang-format-ignore 文件列表（25个涉及13个BSP）：

  • bsp/Vango/v85xx/Libraries/.clang-format-ignore
  • bsp/Vango/v85xxp/Libraries/.clang-format-ignore
  • bsp/microchip/samc21/.clang-format-ignore
  • bsp/microchip/samd51-adafruit-metro-m4/.clang-format-ignore
  • bsp/microchip/samd51-seeed-wio-terminal/.clang-format-ignore
  • bsp/microchip/same54/.clang-format-ignore
  • bsp/microchip/same70/.clang-format-ignore
  • bsp/microchip/saml10/.clang-format-ignore
  • bsp/mm32f103x/.clang-format-ignore
  • bsp/mm32f327x/.clang-format-ignore
  • bsp/mm32f526x/.clang-format-ignore
  • bsp/n32/libraries/.clang-format-ignore
  • bsp/n32g452xx/.clang-format-ignore
  • bsp/nxp/imx/imxrt/libraries/.clang-format-ignore
  • bsp/nxp/lpc/lpc55sxx/Libraries/.clang-format-ignore
  • bsp/nxp/mcx/mcxa/Libraries/.clang-format-ignore
  • bsp/nxp/mcx/mcxc/Libraries/.clang-format-ignore
  • bsp/nxp/mcx/mcxn/Libraries/.clang-format-ignore
  • bsp/renesas/libraries/.clang-format-ignore
  • bsp/stm32/libraries/.clang-format-ignore
  • bsp/tae32f5300/.clang-format-ignore
  • bsp/wch/arm/.clang-format-ignore
  • bsp/wch/risc-v/.clang-format-ignore
  • bsp/yichip/yc3121-pos/.clang-format-ignore
  • bsp/yichip/yc3122-pos/Libraries/.clang-format-ignore

测试情况

已在本地验证：

  • 所有新的 .clang-format-ignore 文件创建成功
  • 所有旧的 .ignore_format.yml 文件删除成功
  • 文件迁移操作完整，无遗漏

当前拉取/合并请求的状态 Intent for your PR

必须选择一项 Choose one (Mandatory):

  • 本拉取/合并请求是一个草稿版本 This PR is for a code-review and is intended to get feedback
  • 本拉取/合并请求是一个成熟版本 This PR is mature, and ready to be integrated into the repo

代码质量 Code Quality：

我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following:

  • 已经仔细查看过代码改动的对比 Already check the difference between PR and old code
  • 代码风格正确，包括缩进空格，命名及其他风格 Style guide is adhered to, including spacing, naming and other styles
  • 没有垃圾代码，代码尽量精简，不包含#if 0代码，不包含已经被注释了的代码 All redundant code is removed and cleaned up
  • 所有变更均有原因及合理的，并且不会影响到其他软件组件代码或BSP All modifications are justified and not affect other components or BSP
  • 对难懂代码均提供对应的注释 I've commented appropriately where code is tricky
  • 代码是高质量的 Code in this PR is of high quality
  • 已经使用formatting 等源码格式化工具确保格式符合RT-Thread代码规范 This PR complies with RT-Thread code specification
  • 如果是新增bsp, 已经添加ci检查到.github/ALL_BSP_COMPILE.json 详细请参考链接BSP自查

@github-actions github-actions bot added BSP: NXP Code related with NXP BSP: STM32 BSP related with ST/STM32 BSP BSP: Renesas BSP related with Renesas BSP: WCH BSP related with WCH labels Oct 16, 2025
@github-actions
Copy link

github-actions bot commented Oct 16, 2025

👋 感谢您对 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：clang-format-ignore
  • 设置PR number为 \ Set the PR number to：10828
  1. 等待工作流完成 | Wait for the workflow to complete
    格式化后的代码将自动推送至你的分支。
    The formatted code will be automatically pushed to your branch.

完成后，提交将自动更新至 clang-format-ignore 分支，关联的 Pull Request 也会同步更新。
Once completed, commits will be pushed to the clang-format-ignore 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
Copy link

github-actions bot commented Oct 16, 2025 •
edited
Loading

📌 Code Review Assignment

🏷️ Tag: bsp_mcxa

Reviewers: @hywing

Changed Files (Click to expand)
  • bsp/nxp/mcx/mcxa/Libraries/.ignore_format.yml

🏷️ Tag: bsp_mcxn

Reviewers: @hywing

Changed Files (Click to expand)
  • bsp/nxp/mcx/mcxn/Libraries/.ignore_format.yml

🏷️ Tag: bsp_mm32f526x

Reviewers: @Maihuanyi

Changed Files (Click to expand)
  • bsp/mm32f526x/.clang-format-ignore
  • bsp/mm32f526x/.ignore_format.yml

🏷️ Tag: bsp_renesas

Reviewers: @kurisaW

Changed Files (Click to expand)
  • bsp/renesas/.clang-format-ignore
  • bsp/renesas/libraries/bsp-template/.ignore_format.yml

🏷️ Tag: bsp_stm32

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

Changed Files (Click to expand)
  • bsp/stm32/.clang-format-ignore
  • bsp/stm32/libraries/.ignore_format.yml

📊 Current Review Status (Last Updated: 2025-11-13 10:11 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.

@CLAassistant
Copy link

CLAassistant commented Oct 16, 2025 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@Rbb666
Copy link
Member

Rbb666 commented Oct 17, 2025

@westcity-YOLO 感谢PR，作者先签署下CLA

@Rbb666
Copy link
Member

Rbb666 commented Oct 17, 2025

PR的标题建议简洁些，不用添加姓名，主要是可以说清楚这个PR干了什么事情即可

@westcity-YOLO westcity-YOLO changed the title RSOC-马锡尧-迁移忽略格式机制：将 .ignore_format.yml 替换为 .clang-format-ignore RSOC-将 .ignore_format.yml 替换为 .clang-format-ignore Oct 17, 2025
@Rbb666 Rbb666 closed this Oct 20, 2025
@Rbb666 Rbb666 reopened this Oct 20, 2025
@Rbb666 Rbb666 linked an issue Oct 20, 2025 that may be closed by this pull request
[Feature] 推动clang-format-ignore机制 #10764
Closed
@kurisaW kurisaW changed the title RSOC-将 .ignore_format.yml 替换为 .clang-format-ignore format/rsoc：clang format ignore migration Oct 21, 2025
CYFS3
CYFS3 approved these changes Oct 28, 2025
View reviewed changes
Copy link
Contributor

@CYFS3 CYFS3 left a comment

Choose a reason for hiding this comment

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

LGTM

bsp/stm32/.clang-format-ignore Outdated
/libraries/STM32U5xx_HAL/
/libraries/STM32H5xx_HAL/
/libraries/STM32WBxx_HAL/
/libraries/STM32WLxx_HAL/
Copy link
Contributor

@CYFS3 CYFS3 Oct 21, 2025

Choose a reason for hiding this comment

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

这些hal库可以删除，目前固件库都是以软件包形式提供

bsp/stm32/.clang-format-ignore Outdated
/stm32wb55-st-nucleo/board/CubeMX_Config/
/stm32wl55-st-nucleo/board/CubeMX_Config/
/stm32wle5-yizhilian-lm401/board/CubeMX_Config/
/stm32wle5-yizhilian-lm402/board/CubeMX_Config/
Copy link
Contributor

@CYFS3 CYFS3 Oct 21, 2025

Choose a reason for hiding this comment

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

这个应该可以使用**/CUbeMX_Config/

@Rbb666 Rbb666 closed this Nov 13, 2025
@Rbb666 Rbb666 reopened this Nov 13, 2025
@Rbb666 Rbb666 merged commit 32d2cf1 into RT-Thread:master Nov 13, 2025
92 of 95 checks passed
kurisaW
kurisaW reviewed Nov 13, 2025
View reviewed changes
bsp/renesas/.clang-format-ignore
# 4. clang-format will recursively apply the .clang-format-ignore rules.

# Renesas Vendor library
<<<<<<< HEAD
Copy link
Member

@kurisaW kurisaW Nov 13, 2025

Choose a reason for hiding this comment

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

这里的冲突没处理好

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kurisaW kurisaW kurisaW left review comments

@Rbb666 Rbb666 Rbb666 approved these changes

@mysterywolf mysterywolf Awaiting requested review from mysterywolf mysterywolf is a code owner

@supperthomas supperthomas Awaiting requested review from supperthomas supperthomas is a code owner

+1 more reviewer

@CYFS3 CYFS3 CYFS3 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

BSP: NXP Code related with NXP BSP: Renesas BSP related with Renesas BSP: STM32 BSP related with ST/STM32 BSP: WCH BSP related with WCH BSP

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Feature] 推动clang-format-ignore机制

5 participants

@westcity-YOLO @CLAassistant @Rbb666 @kurisaW @CYFS3