Skip to content

docs: fix three doc typos - #1933

Open
mvanhorn wants to merge 2 commits into
DragonOS-Community:masterfrom
mvanhorn:osc/fix-doc-typos
Open

mvanhorn wants to merge 2 commits into
DragonOS-Community:masterfrom
mvanhorn:osc/fix-doc-typos

Conversation

@mvanhorn

Copy link
Copy Markdown

Summary

  • docs/conf.py:94: sphinx-multiversion comment had "lastest" → "latest"
  • docs/kernel/core_api/softirq.md:50: 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:330: doc example used <funtion> instead of <function> (the rest of the line already says <filename>:<function>)

Comment/doc-only.

- 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
  `<funtion>` instead of `<function>` (the rest of the line already says
  `<filename>:<function>`)

Comment/doc-only.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 26, 2026
# Conflicts:
#	docs/conf.py
#	docs/kernel/core_api/softirq.md
@mvanhorn

Copy link
Copy Markdown
Author

Merged master into the branch (634980d). Since the docs moved to VitePress, I dropped the docs/conf.py change (that file is gone upstream), took master's English version of docs/kernel/core_api/softirq.md, and applied the hanlder and funtion fixes to the Chinese copies under docs/zh/. The PR now touches three lines across docs/kernel/debug/debug-kernel-with-gdb.md and the two docs/zh files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant