Imagelibrary/rt-thread
1
0
Fork 0
mirror of https://github.com/RT-Thread/rt-thread.git synced 2025-11-16 12:34:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(doc): Exclude 'src/utest/perf/README.md' from Doxygen build (RT-Thread#10888)

Browse Source 
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>
This commit is contained in:
lhxj
2025-11-05 22:51:29 +08:00
committed by R b b666
parent fa6f86eda3
commit e3640ffc3d
2 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
documentation/Doxyfile.1.9.1
View File

@@ -924,7 +924,8 @@ RECURSIVE = YES
EXCLUDE = ./0.doxygen/mainpage.h \
./2.quick-start/quick_start_qemu \
./env/env-vscode.md \
./7.contribution/coding_style_cn.md
./7.contribution/coding_style_cn.md \
../src/utest/perf/README.md
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded

3
documentation/Doxyfile.1.9.8
View File

@@ -1014,7 +1014,8 @@ RECURSIVE = YES
EXCLUDE = ./0.doxygen/mainpage.h \
./2.quick-start/quick_start_qemu \
./env/env-vscode.md \
./7.contribution/coding_style_cn.md
./7.contribution/coding_style_cn.md \
../src/utest/perf/README.md
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded