Skip to content

[tool][mkdist]修复disk命令的bug:1.重复在SConstruct注入RTT_ROOT;2.重建dist时遇到无权限删除… - #11874

Open
CXSforHPU wants to merge 2 commits into
RT-Thread:masterfrom
CXSforHPU:fix_mkdist
Open

CXSforHPU wants to merge 2 commits into
RT-Thread:masterfrom
CXSforHPU:fix_mkdist

Conversation

@CXSforHPU

@CXSforHPU CXSforHPU commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

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

[

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

scons --dist 在同一目录上重复执行、或目标 dist 目录里残留只读文件时,
tools/mkdist.py 表现异常:

  1. bsp_update_sconstruct 重复注入 RTT_ROOT 块

    • 命中含 RTT_ROOT + sys.path 的行时,函数只向流里前置写入 3
      行新代码并保留原行,原始 sys.path 行永远不被移除;
    • 每次 scons --dist 都再注入一遍,导致 dist/SConstruct 里
      # set RTT_ROOT / if not os.getenv("RTT_ROOT"): ... 块不断累积;
  2. do_copy_folder 撞只读/被锁文件直接放弃整次 copy

    • 目标目录里有 Windows 上常见的只读文件(如 BSP 自带的
      packages/CMSIS-Core-latest/.git/objects/pack/*.idx、杀毒残留、
      文件索引器占句柄等)时,shutil.rmtree 抛 WinError 5 (拒绝访问);
    • 原代码裸 except 吞掉异常直接 return,rmtree 失败后
      copytree 也不执行
      ,整次 dist 中断;
    • 用户必须手动 rm -rf dist/project 才能恢复,对开发体验影响很大。

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

1.先读一边文档是否已经存在 # set RTT_ROOT;存在便直接返回

2.对于捕获到无法删除的,先清除其只读位进行删除

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

  • BSP:
  • .config:
  • action:

]

当前拉取/合并请求的状态 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
  • 已经使用clang-format 源码格式化工具确保格式符合RT-Thread代码规范 This PR has been formatted with clang-format and complies with RT-Thread code specification
  • 如果是新增bsp, 已经添加ci检查到.github/ALL_BSP_COMPILE.json 详细请参考链接BSP自查

@github-actions github-actions Bot added the tools label Oct 16, 2026
@github-actions

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

  • Use workflow from 保持默认分支(通常为 master)
    Keep the default branch (usually master) in Use workflow from
  • 在 branch 输入框填写 PR 分支 fix_mkdist
    Enter PR branch fix_mkdist in the branch field
  • 设置需排除的文件/目录(目录请以"/"结尾)
    Set files/directories to exclude (directories should end with "/")
  1. 等待工作流完成 | Wait for the workflow to complete
    格式化后的代码将作为独立提交推送至你的分支。
    The formatting changes will be pushed to your branch as a separate commit.

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

@CXSforHPU
CXSforHPU marked this pull request as draft October 16, 2026 17:44
@github-actions

github-actions Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

MemBrowse Memory Report · Explore what changed →

esp32-c3

  • dram0_0_seg: .dram0.bss +9,208 B, .dram0.data +168 B, .dram0.dummy -21,504 B (-5.5%, 208,608 B / 325,120 B, total: 64% used)
  • drom0_0_seg: .eh_frame +78,544 B, .eh_frame_hdr +12,376 B, .flash.rodata +27,368 B, .flash_rodata_dummy +196,608 B (+76.6%, 725,908 B / 8,388,576 B, total: 9% used)
  • iram0_0_seg: .iram0.text -21,138 B, .iram0.text_end -366 B (-28.8%, 53,248 B / 325,120 B, total: 16% used)
  • iram0_2_seg: .flash.text +199,784 B, .text +474 B (+87.2%, 429,852 B / 8,388,576 B, total: 5% used)
  • rtc_iram_seg: .rtc.text +8 B (+60.0%, 64 B / 8,192 B, total: 1% used)

hpmicro-hpm5301evklite

  • DLM: .bss -2,320 B, .data -464 B (+0.5%, 58,560 B / 131,072 B, total: 45% used)
  • ILM: .fast -14,432 B, .vectors -96 B (-38.0%, 23,712 B / 131,072 B, total: 18% used)
  • XPI0: .data -464 B, .fast -14,432 B, .text -33,264 B, .vectors -96 B (-38.6%, 76,748 B / 1,048,576 B, total: 7% used)

k230

  • SRAM: .bss +4,096 B, .data +8 B, .eh_frame +13,592 B, .sbss +112 B, .srodata.cst8 +8 B, .stack -8 B, .text +62,632 B (+7.1%, 1,208,988 B / 268,300,288 B, total: 0% used)

nuvoton-m487

  • CODE: .text +56 B (+0.0%, 356,176 B / 524,288 B, total: 68% used)

qemu-virt64-aarch64

  • Code: .eh_frame +48 B, .text +416 B (+0.0%, 1,077,812 B)

No memory changes detected for:


Catch memory regressions in CI with MemBrowse. Free for open source.

@CXSforHPU
CXSforHPU marked this pull request as ready for review October 16, 2026 18:08
@CYFS3

CYFS3 commented Oct 23, 2026

Copy link
Copy Markdown
Contributor

ci有报错

@github-actions github-actions Bot added the BSP label Oct 26, 2026
@CXSforHPU

CXSforHPU commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor Author

tm4c123bsp的Sconstruct脚本中存留dist脚本导出的几行代码,已经删除:如下;

# set RTT_ROOT
#if not os.getenv("RTT_ROOT"):
    #RTT_ROOT="rt-thread"

并修改本次pr的mkdist.py脚本,仅匹配未注释的脚本如下:

#set RTT_ROOT
if not os.getenv("RTT_ROOT"):
    RTT_ROOT="rt-thread"

@CXSforHPU

Copy link
Copy Markdown
Contributor Author

@CYFS3

CYFS3 commented Oct 28, 2026

Copy link
Copy Markdown
Contributor

有个问题,为什么不直接删掉然后在dist出来一份。我认为dist出来这个工程是为了方便开发。这个文件应该不保留在原本的dist目录下了。其次这个文件如果被进程占用,也是删不掉的,只清理只读位应该也没有作用。

@CXSforHPU

Copy link
Copy Markdown
Contributor Author

有个问题,为什么不直接删掉然后在dist出来一份。我认为dist出来这个工程是为了方便开发。这个文件应该不保留在原本的dist目录下了。其次这个文件如果被进程占用,也是删不掉的,只清理只读位应该也没有作用。

我看了这个脚本的代码,原先的意思就是如果dist目录下存在project,那么就优先删除project重新dist出来一份。
有些文件不是被进程占用的,他本身就是只读。

@CXSforHPU

CXSforHPU commented Oct 29, 2026 •

Copy link
Copy Markdown
Contributor Author

下述代码先查看要copy的存在不存在,不存在直接返回,之后看目标目录存不存在要copy的文件夹,如果存在,那么就先删除,如果报错了就不删除以及直接返回后续copy也不直接进行;

def do_copy_folder(src_dir, dst_dir, ignore=None):
    import shutil
    # check source directory
    if not os.path.exists(src_dir):
        return

    try:
        if os.path.exists(dst_dir):
            shutil.rmtree(dst_dir)
    except:
        print('Deletes folder: %s failed.' % dst_dir)
        return

    shutil.copytree(src_dir, dst_dir, ignore = ignore)

但是,项目中有些文件是只读文件:

  1. 不清除可读位置
  • 复现代码如下(原函数没有捕获错误并打印,我加了打印错误)
def do_copy_folder(src_dir, dst_dir, ignore=None):
    import shutil

    # check source directory
    if not os.path.exists(src_dir):
        return

    try:
        if os.path.exists(dst_dir):
            shutil.rmtree(dst_dir)
    except Exception as e:
        print('Deletes folder: %s failed: %s\n' % (dst_dir, e))
        return

    shutil.copytree(src_dir, dst_dir, ignore = ignore)

第一次dist目录如下

image

重新dist结果与目录如下

image image

导致的结果是,第二次dist因为
Deletes folder: E:\workspace\cxs\rt-thread\bsp\stm32\stm32f407-rt-spark\dist\project failed: [WinError 5] 拒绝访
问。: 'E:\workspace\cxs\rt-thread\bsp\stm32\stm32f407-rt-spark\dist\project\packages\CMSIS-Core-latest
.git\objects\pack\pack-1e0aab758bbeb62472afa2a7b6760285eeb571fc.id
该文件无法删除导致(只读文件),do_copy_folder函数直接返回,没有去进行 shutil.copytree(src_dir, dst_dir, ignore = ignore),从而缺失一些文件夹。

  • 清除可读位置
image

成功删除只读文件,从而可以正常进行后续copy。

@CXSforHPU

Copy link
Copy Markdown
Contributor Author

其次修改 bsp_update_sconstruct函数是因为

def bsp_update_sconstruct(dist_dir):
    with open(os.path.join(dist_dir, 'SConstruct'), 'r') as f:
        data = f.readlines()
    with open(os.path.join(dist_dir, 'SConstruct'), 'w') as f:
        for line in data:
            if line.find('RTT_ROOT') != -1:
                if line.find('sys.path') != -1:
                    f.write('# set RTT_ROOT\n')
                    f.write('if not os.getenv("RTT_ROOT"): \n    RTT_ROOT="rt-thread"\n\n')
            f.write(line)

该函数会检测 sys.path = sys.path + [os.path.join(RTT_ROOT, 'tools')],但是不会检测原先脚本中是否存在以下代码

# set RTT_ROOT
if not os.getenv("RTT_ROOT"): 
   RTT_ROOT="rt-thread"

这就会导致该代码块会随之dist的次数增加而增加

image

@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

This branch has not been deployed

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants