From ec79299f8405134b935026332364faaac4295314 Mon Sep 17 00:00:00 2001 From: Matt Van Horn <455140+mvanhorn@users.noreply.github.com> Date: Tue, 26 May 2026 00:40:32 -0700 Subject: [PATCH] docs: fix three doc typos - docs/conf.py L94: sphinx-multiversion comment had "lastest" -> "latest" - docs/kernel/core_api/softirq.md L50: doc said `hanlder` but the actual Softirq struct field in kernel/src/exception/softirq.rs is `handler` - docs/kernel/debug/debug-kernel-with-gdb.md L330: doc example used `` instead of `` (the rest of the line already says `:`) Comment/doc-only. --- docs/conf.py | 2 +- docs/kernel/core_api/softirq.md | 2 +- docs/kernel/debug/debug-kernel-with-gdb.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index c1da2dbc94..d856c4eb9f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -91,7 +91,7 @@ "linkify" ] -# sphinx-multiversion 指定哪个分支为 lastest 版本 +# sphinx-multiversion 指定哪个分支为 latest 版本 smv_latest_version = 'master' smv_released_pattern = r'^tags/.*$' # Tags only smv_tag_whitelist = r'^(V.*|v.*)$' diff --git a/docs/kernel/core_api/softirq.md b/docs/kernel/core_api/softirq.md index 452c1f2057..b8731b334f 100644 --- a/docs/kernel/core_api/softirq.md +++ b/docs/kernel/core_api/softirq.md @@ -47,7 +47,7 @@ pub fn register_softirq(&self, - softirq_num:中断向量号 - - hanlder:中断函数对应的结构体,需要指向实现了`SoftirqVec`特征的结构体变量 + - handler:中断函数对应的结构体,需要指向实现了`SoftirqVec`特征的结构体变量 - 返回: diff --git a/docs/kernel/debug/debug-kernel-with-gdb.md b/docs/kernel/debug/debug-kernel-with-gdb.md index 99f3813ce4..9550ddfdbd 100644 --- a/docs/kernel/debug/debug-kernel-with-gdb.md +++ b/docs/kernel/debug/debug-kernel-with-gdb.md @@ -327,7 +327,7 @@ continue #用于继续程序的执行,直到遇到下一个断点 quit #退出调试 list #或者l,显示当前活动源文件源代码的片段,以及当前执行的位置。 -list : #显示文件里面的函数的源代码片段 +list : #显示文件里面的函数的源代码片段 list : #显示文件里面的附近的源代码片段 list , #显示当前活动源文件的之间的源代码片段 set listsize #设置list命令显示的源代码行数。默认情况下,list命令显示当前行和其周围的几行代码。