Skip to content
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.

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

[feature][v5.1.1][tools] Refactoring and improving the scons --dist packaging command #9885

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

ZhaoCake
Copy link

@ZhaoCake ZhaoCake commented Jan 8, 2025

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

[

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

The issue #8592 mentioned the need to promote the refactoring and improvement of the scons --dist packaging command.

And the issue #9878 suggested LWP_DEBUG should be closed by default

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

  1. By reading in the. config file under bsp, copy the contents of components in a targeted manner to reduce the size of the package
  2. Further remove some non essential folders such as __pycache__
  3. Generate information about this packaging at the same time as executing the command, dist_deadme.md

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

  • BSP: qemu-virt64-riscv
  • .config: default config, and I also modify some config to test.

I cannot be sure if this solution is stable, in fact, due to the existence of some directories that are not included in the processing method I provided, a necessary directory list is also maintained.
If we could use compile_commands.json to perform the step of selecting a specific file for packaging, I think it would be very enjoyable. But this will introduce unnecessary dependencies bear, as Scons does not seem to have a built-in tool for generating compile_commands.json. So I am not sure if I should use it.

  • 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
  • 已经使用formatting 等源码格式化工具确保格式符合RT-Thread代码规范 This PR complies with RT-Thread code specification
  • 如果是新增bsp, 已经添加ci检查到.github/workflows/bsp_buildings.yml 详细请参考链接BSP自查

@ZhaoCake ZhaoCake requested a review from BernardXiong as a code owner January 8, 2025 08:10
@CLAassistant
Copy link

CLAassistant commented Jan 8, 2025

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added tools RT-Smart RT-Thread Smart related PR or issues component: lwp Component labels Jan 8, 2025
tools/mkdist.py Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: lwp Component RT-Smart RT-Thread Smart related PR or issues tools
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants