Skip to content

Conversation

@wdfk-prog
Copy link
Contributor

@wdfk-prog wdfk-prog commented Nov 25, 2025

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

[

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

  • MSH shell 中的 tail 命令存在一个bug:当用户错误地使用 -n 参数时,会导致设备崩溃。
  • 复现步骤:
    执行 tail -n 或 tail -n 这种缺少必要参数的命令。
    tail -n flash_sys.log 命令将 flash_sys.log 误解析为行数,然后尝试访问不存在的 argv[3] 来获取文件名,这导致了异常。

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

  • 本次提交的核心是增加了一道安全防线来修复这个崩溃问题:
  1. 增加参数数量校验:在解析 -n 选项的逻辑分支中,强制检查 argc 是否小于 4。如果参数数量不足以同时提供 -n、行数和文件名,则立即打印错误信息并安全返回,彻底杜绝了访问越界内存的可能性。
  2. 优化用户提示:同步更新了错误提示和 MSH 命令导出宏中的帮助文本,更清晰地向用户展示了 tail -n [+]numbers 的正确用法,以减少误操作的可能。
  3. 补充代码文档:为 cmd_tail 函数添加了 Doxygen 注释,方便后续开发者理解和维护

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

  • 此修复为 shell 通用组件更新,不依赖特定硬件。已进行如下专项测试:
  1. 异常情况:执行 tail -n、tail -n 10、tail -n flash_sys.log,均能正确打印用法提示并安全退出,崩溃问题已解决。
  2. 正常功能:执行 tail file、tail -n 20 file、tail -n +50 file,功能均与修复前一致,表现正常。
  • 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/ALL_BSP_COMPILE.json 详细请参考链接BSP自查

@github-actions
Copy link

github-actions bot commented Nov 25, 2025

📌 Code Review Assignment

🏷️ Tag: components

Reviewers: Maihuanyi

Changed Files (Click to expand)
  • components/finsh/msh_file.c

📊 Current Review Status (Last Updated: 2025-11-25 13:21 CST)

  • Maihuanyi Pending Review

📝 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.

@github-actions
Copy link

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

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

@Rbb666
Copy link
Member

Rbb666 commented Nov 26, 2025

我要晚点测测

@Rbb666 Rbb666 self-requested a review November 26, 2025 14:55
Copilot finished reviewing on behalf of Rbb666 November 26, 2025 14:58
Copy link
Contributor

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 fixes a crash bug in the MSH shell's tail command that occurs when users incorrectly provide the -n parameter without sufficient arguments. The fix adds proper argument validation to prevent accessing out-of-bounds memory (argv[3]) when the required parameters are missing.

Key Changes:

  • Adds argument count validation before accessing argv[3] to prevent crash
  • Enhances error messages and usage information for better user guidance
  • Adds comprehensive Doxygen documentation for the cmd_tail function
Comments suppressed due to low confidence (1)

components/finsh/msh_file.c:813

  • English: Missing space after if keyword. RT-Thread coding style requires a space between control keywords and parentheses (e.g., if (condition) not if(condition)). While this line is not part of the diff, I notice this pattern exists in the surrounding context. Please ensure consistent formatting.

中文: if 关键字后缺少空格。RT-Thread 编码风格要求控制关键字和括号之间有空格(例如 if (condition) 而不是 if(condition))。虽然这一行不是 diff 的一部分,但我注意到周围上下文中存在这种模式。请确保格式一致。

Note: This is existing code, not introduced by this PR.

        if(total_lines == 0)

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

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.

3 participants