Skip to content

doxygen: improve doc for kernel basics section #10066

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 3, 2025

Conversation

unicornx
Copy link
Contributor

@unicornx unicornx commented Mar 3, 2025

整理 "Kerenl Basics" 部分的文档内容,这个 PR 没有对文字内容做实质的改动,只是对文档的格式化做了一些优化和调整,包括:

  • 为函数名,变量名加上 "`" 括起来,这样 html 渲染后会采用不同的字体和正文文字部分区分开来。
  • 段落之间加上空行,否则 html 渲染的时候会将没有空行分隔的段落合并成一个段落。
  • 采用 "@ref" 的方式引用对应章节的页面,譬如 “Thread Scheduling” 这个章节的最后对 page_thread_management 的引用。
  • 对于 markdown 中的表格,尽量在 text 中对列进行对齐,美化了阅读的感受。

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

[

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

见上描述

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

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

  • BSP:
  • .config:
  • action:

]

当前拉取/合并请求的状态 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/workflows/bsp_buildings.yml 详细请参考链接BSP自查

Organize the document content of the "Kerenl Basics" section.
This PR does not make substantial changes to the text content,
but only makes some optimizations and adjustments to the
document formatting, including:

- Enclose the function name and variable name in "`", so that
  the HTML rendering will use different fonts to distinguish
  them from the text part.

- Add blank lines between paragraphs, otherwise the HTML
  rendering will merge the paragraphs without blank lines
  into one paragraph.

- Use "@ref" to reference the page of the corresponding
  chapter, such as the reference to page_thread_management
  at the end of the "Thread Scheduling" chapter.

- For tables in markdown, try to align the columns in the
  text to beautify the reading experience.

Signed-off-by: Chen Wang <[email protected]>
@github-actions github-actions bot added the Doc This PR/issue related with documents label Mar 3, 2025
@unicornx unicornx requested a review from Rbb666 March 3, 2025 04:24
@unicornx unicornx self-assigned this Mar 3, 2025
@Rbb666 Rbb666 merged commit f9655aa into RT-Thread:master Mar 3, 2025
4 checks passed
@unicornx unicornx deleted the dev-doxygen-kernel-basic branch March 6, 2025 06:50
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants