Skip to content

Commit e3640ff

Browse files
lhxjRbb666
authored andcommitted
fix(doc): Exclude 'src/utest/perf/README.md' from Doxygen build (#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>
1 parent fa6f86e commit e3640ff

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

documentation/Doxyfile.1.9.1

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -924,7 +924,8 @@ RECURSIVE = YES
924924
EXCLUDE = ./0.doxygen/mainpage.h \
925925
./2.quick-start/quick_start_qemu \
926926
./env/env-vscode.md \
927-
./7.contribution/coding_style_cn.md
927+
./7.contribution/coding_style_cn.md \
928+
../src/utest/perf/README.md
928929

929930
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
930931
# directories that are symbolic links (a Unix file system feature) are excluded

documentation/Doxyfile.1.9.8

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1014,7 +1014,8 @@ RECURSIVE = YES
10141014
EXCLUDE = ./0.doxygen/mainpage.h \
10151015
./2.quick-start/quick_start_qemu \
10161016
./env/env-vscode.md \
1017-
./7.contribution/coding_style_cn.md
1017+
./7.contribution/coding_style_cn.md \
1018+
../src/utest/perf/README.md
10181019

10191020
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
10201021
# directories that are symbolic links (a Unix file system feature) are excluded

0 commit comments

Comments
 (0)