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

[tools] 添加scons --target别名scons --ide,减少用户对target的误解 #10127

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ComerLater
Copy link
Contributor

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

[

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

scons --target 的 target 意思给人很迷惑,一般用户都会理解为最终生成的target,而不是生成其他ide工程

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

添加 scons --ide 作为 --target 的别名,同时还保留原来的--target,ide这个名字意义大家一看就明白。

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

添加scons --target别名scons --ide,减少用户对target的误解
@github-actions github-actions bot added the tools label Mar 19, 2025
@supperthomas supperthomas changed the title 添加scons --target别名scons --ide,减少用户对target的误解 [tools] 添加scons --target别名scons --ide,减少用户对target的误解 Mar 20, 2025
@mysterywolf
Copy link
Member

cmake不属于ide

@BernardXiong
Copy link
Member

cmake不属于ide

so, 怎么办?似乎target这个名称也还好?

@mysterywolf
Copy link
Member

改成--project-type吧,和上面的project-name一脉相承,用--而不是-

@mysterywolf
Copy link
Member

PR的意图我完全支持,改个命令名字就行

@supperthomas supperthomas requested a review from Copilot March 27, 2025 14:11
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR improves the clarity of the scons build options by adding the "--ide" alias to the existing "--target" option, helping users better understand that the flag is meant for generating IDE projects.

  • Added the "--ide" alias to the target flag
  • Updated the help message to reflect the intended use for IDE projects
Comments suppressed due to low confidence (1)

tools/options.py:73

  • [nitpick] Consider aligning the destination name with the new alias. For clarity, you might update 'dest' from 'target' to 'ide' if the flag is exclusively used for IDE project configuration, unless maintaining backward compatibility is a priority.
AddOption('--target', '--ide',

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants