Skip to content

Conversation

@lhxj
Copy link
Contributor

@lhxj lhxj commented Nov 5, 2025

Fixed #10888

This issue was originally introduced by the following commit: Commit: 7499790
Title: utest: core: move perf testcase from example to src

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

[

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

Problem description: The file src/utest/perf/README.md was incorrectly appearing as a root-level page in the Doxygen documentation output.
Problem analysis: This file was unintentionally included by the Doxygen build process following commit 7499790. It is an internal README for performance tests and is not intended to be part of the generated documentation.

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

Solution: The issue is resolved by explicitly excluding this file from the build. The path '../src/utest/perf/README.md' has been added to the EXCLUDE list in both 'documentation/Doxyfile.1.9.1' and 'documentation/Doxyfile.1.9.8'.

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

  • BSP:N/A
  • .config:N/A
  • action:N/A

]

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

@CLAassistant
Copy link

CLAassistant commented Nov 5, 2025

CLA assistant check
All committers have signed the CLA.

@github-actions
Copy link

github-actions bot commented Nov 5, 2025

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

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

@github-actions github-actions bot added Doc This PR/issue related with documents Kernel PR has src relate code labels Nov 5, 2025
@github-actions
Copy link

github-actions bot commented Nov 5, 2025

📌 Code Review Assignment

🏷️ Tag: documentation

Reviewers: CXSforHPU GorrayLi lianux-mm unicornx

Changed Files (Click to expand)
  • documentation/Doxyfile.1.9.1
  • documentation/Doxyfile.1.9.8

📊 Current Review Status (Last Updated: 2025-11-05 22:58 CST)

  • CXSforHPU Pending Review
  • GorrayLi Pending Review
  • lianux-mm Pending Review
  • unicornx 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.

@unicornx unicornx requested review from unicornx and removed request for Cathy-lulu and mysterywolf November 5, 2025 10:11
@unicornx
Copy link
Contributor

unicornx commented Nov 5, 2025

Fixed#10888

请改成:Fixed #10888 这样 github 就能识别并将该 pr 和 issue 关联,pr merge 时就会自动 close issue。

Copy link
Contributor

@unicornx unicornx left a comment

Choose a reason for hiding this comment

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

#10888 中的这个页面不该出现,正如分析指出,是 Commit: 7499790 中不小心引入的, 不用将其加入 doxygen 文档的构建。

因为我们设置了扫描 .md 文件,原 Doxyfile 文件中的 INPUT 中的 ../src 会导致该目录下的所有 markdown 文件都加入构建。

正确的解法是修改 documentation/Doxyfile.1.9.1documentation/Doxyfile.1.9.8 在 EXCLUDE 中加入 ../src/utest/perf/README.md 将该文件排除在 doxygen 生成之外即可。

@lhxj lhxj closed this Nov 5, 2025
@lhxj lhxj force-pushed the fix/doc-issue-10888 branch from bb118ac to fa6f86e Compare November 5, 2025 14:38
…hread#10888)

Problem description:
The file 'src/utest/perf/README.md' was incorrectly appearing as a root-level page in the Doxygen documentation output.

Problem analysis:
This file was unintentionally included by the Doxygen build process following commit 7499790. It is an internal README for performance tests and is not intended to be part of the generated documentation.

Solution:
The issue is resolved by explicitly excluding this file from the build. The path '../src/utest/perf/README.md' has been added to the EXCLUDE list in both 'documentation/Doxyfile.1.9.1' and 'documentation/Doxyfile.1.9.8'.

This issue was originally introduced by the following commit:
Commit: 7499790
Title: utest: core: move perf testcase from example to src

Signed-off-by: lhxj <2743257167@qq.com>
@lhxj lhxj reopened this Nov 5, 2025
@lhxj lhxj changed the title fix(doc): Correct unexpected "testcases 说明" page in Doxygen output fix(doc): Exclude 'src/utest/perf/README.md' from Doxygen build Nov 5, 2025
@lhxj
Copy link
Contributor Author

lhxj commented Nov 5, 2025

@unicornx 我已经按照您的要求修改了pr message以及Doxyfile 并推送了新的 commit

@unicornx unicornx requested a review from Rbb666 November 5, 2025 23:45
@unicornx
Copy link
Contributor

unicornx commented Nov 5, 2025

@Rbb666 please review and merge if it LGTY.

@Rbb666 Rbb666 merged commit e3640ff into RT-Thread:master Nov 6, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Doc This PR/issue related with documents Kernel PR has src relate code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug] 文档网页上出现一个不期望的项目

4 participants