Skip to content

[workqueue] rename rt_workqueue_critical_work as rt_workqueue_urgent_work #5210

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

Merged
merged 1 commit into from
Oct 27, 2021
Merged

[workqueue] rename rt_workqueue_critical_work as rt_workqueue_urgent_work #5210

merged 1 commit into from
Oct 27, 2021

Conversation

mysterywolf
Copy link
Member

@mysterywolf mysterywolf commented Oct 20, 2021

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

[
image
]

以下的内容不应该在提交PR时的message修改,修改下述message,PR会被直接关闭。请在提交PR后,浏览器查看PR并对以下检查项逐项check,没问题后逐条在页面上打钩。
The following content must not be changed in the submitted PR message. Otherwise, the PR will be closed immediately. After submitted PR, please use a web browser to visit PR, and check items one by one, and ticked them if no problem.

当前拉取/合并请求的状态 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

@mysterywolf mysterywolf changed the title [workqueue] rename rt_workqueue_critical_work as rt_workqueue_urgent_… [workqueue] rename rt_workqueue_critical_work as rt_workqueue_urgent_work Oct 20, 2021
@majianjia
Copy link
Contributor

+1

@mysterywolf mysterywolf added the +1 Agree +1 label Oct 20, 2021
@Guozhanxin
Copy link
Member

+1, 我们是不是要新建一个issue,专门记录这些api更改,下次发布版本的时候,弄个迁移指南?

@Guozhanxin Guozhanxin added the +2 Agree +2 label Oct 25, 2021
@mysterywolf
Copy link
Member Author

mysterywolf commented Oct 25, 2021

+1, 我们是不是要新建一个issue,专门记录这些api更改,下次发布版本的时候,弄个迁移指南?

赞同,从4.0.4开始算吧。4.0.4里边已经删除一个工作队列的api了。

@Guozhanxin
Copy link
Member

#5230

@Guozhanxin
Copy link
Member

Guozhanxin commented Oct 26, 2021

1635232061(1)

旧的可以加 废弃标志

@mysterywolf
Copy link
Member Author

mysterywolf commented Oct 26, 2021

老的不能留,这个api不是什么关键的api,更新版本的时候编译报错,改一下就可以了。一味的强调兼容性会导致rtt存在大量的历史毒瘤。一旦一个软件其使用还涉及到这个软件的发展历史,对于初学者来讲是非常可怕的一件事情,因为我不光得学习这个操作系统本身,还得上一堂历史课。绝对不能为了兼容而兼容,迁移报错改就是了。而且这个本身就是当时提交pr时命名不细致造成的,不能将这个问题一直保留下来。一定要考虑用户学习成本的问题,不能说这个api只有我们内部自己知道来龙去脉,而用户看见这个操作一脸懵逼。

@majianjia
Copy link
Contributor

majianjia commented Oct 26, 2021

可以等一个版本抛弃,但是一定要添加编译警告。留一定的预警时间。这些修改单独在版本更新的时候说明。
比如4.0.6的时候抛弃,如果考虑小版本兼容性,就等到 4.1.x 或者5.0 的时候抛弃。
RTT 要删的接口应该不止这一个,统一一下一个地方发布,然后发布migration guide

@majianjia
Copy link
Contributor

像RTT这样直接提交到master branch 的仓库,master 应该当做nightly来对待,不兼容老版本是可以的。

@BernardXiong BernardXiong merged commit 31bf735 into RT-Thread:master Oct 27, 2021
@mysterywolf mysterywolf deleted the workqueue branch October 27, 2021 02:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
+1 Agree +1 +2 Agree +2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants