Skip to content

Commit

Permalink
Remove empty toctree to avoid useless expanding buttons
Browse files Browse the repository at this point in the history
  • Loading branch information
ouuan committed Mar 4, 2024
1 parent 509e1a3 commit 2619c47
Show file tree
Hide file tree
Showing 15 changed files with 7 additions and 72 deletions.
4 changes: 0 additions & 4 deletions source/0setup-devel-env.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
第零章:实验环境配置
================================

.. toctree::
:hidden:
:maxdepth: 4

本节我们将完成环境配置并成功运行 rCore-Tutorial 。整个流程分为下面几个部分:

- OS 环境配置
Expand Down
7 changes: 1 addition & 6 deletions source/appendix-a/index.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
附录 A:Rust 系统编程资料
=============================

.. toctree::
:hidden:
:maxdepth: 4


.. .. note::

.. **Rust 语法卡片:外部符号引用**
Expand Down Expand Up @@ -53,4 +48,4 @@ Rust系统编程pattern

- `Arc<Mutex<_>> in Rust <https://aeshirey.github.io/code/2020/12/23/arc-mutex-in-rust.html>`_
- `Understanding Closures in Rust <https://medium.com/swlh/understanding-closures-in-rust-21f286ed1759>`_
- `Closures in Rust <https://zhauniarovich.com/post/2020/2020-12-closures-in-rust/>`_
- `Closures in Rust <https://zhauniarovich.com/post/2020/2020-12-closures-in-rust/>`_
6 changes: 0 additions & 6 deletions source/appendix-b/index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
附录 B:常见工具的使用方法
========================================

.. toctree::
:hidden:
:maxdepth: 4



分析可执行文件
------------------------

Expand Down
6 changes: 1 addition & 5 deletions source/appendix-c/index.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
附录 C:深入机器模式:RustSBI
=================================================

.. toctree::
:hidden:
:maxdepth: 4

RISC-V指令集的SBI标准规定了类Unix操作系统之下的运行环境规范。这个规范拥有多种实现,RustSBI是它的一种实现。

RISC-V架构中,存在着定义于操作系统之下的运行环境。这个运行环境不仅将引导启动RISC-V下的操作系统, 还将常驻后台,为操作系统提供一系列二进制接口,以便其获取和操作硬件信息。 RISC-V给出了此类环境和二进制接口的规范,称为“操作系统二进制接口”,即“SBI”。
Expand All @@ -15,4 +11,4 @@ RustSBI项目发起于鹏城实验室的“rCore代码之夏-2020”活动,它

RustSBI项目的目标是,制作一个从固件启动的最小Rust语言SBI实现,为可能的复杂实现提供参考和支持。 RustSBI也可以作为一个库使用,帮助更多的SBI开发者适配自己的平台,以支持更多处理器核和片上系统。

当前项目实现源码:https://github.com/luojia65/rustsbi
当前项目实现源码:https://github.com/luojia65/rustsbi
7 changes: 1 addition & 6 deletions source/chapter1/1app-ee-platform.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
应用程序执行环境与平台支持
================================================

.. toctree::
:hidden:
:maxdepth: 5


执行应用程序
-------------------------------

Expand Down Expand Up @@ -117,4 +112,4 @@ CPU 架构是 x86_64,CPU 厂商是 unknown,操作系统是 linux,运行时
它包含了 Rust 语言相当一部分核心机制,可以满足本门课程的需求。
有很多第三方库也不依赖标准库 std,而仅仅依赖核心库 core。

为了以裸机平台为目标编译程序,我们要将对标准库 std 的引用换成核心库 core。
为了以裸机平台为目标编译程序,我们要将对标准库 std 的引用换成核心库 core。
5 changes: 0 additions & 5 deletions source/chapter1/2remove-std.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@
移除标准库依赖
==========================

.. toctree::
:hidden:
:maxdepth: 5


首先在 ``os`` 目录下新建 ``.cargo`` 目录,并在这个目录下创建 ``config`` 文件,输入如下内容:

.. code-block:: toml
Expand Down
4 changes: 0 additions & 4 deletions source/chapter1/3mini-rt-usrland.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@
构建用户态执行环境
=================================

.. toctree::
:hidden:
:maxdepth: 5

.. note::

前三小节的用户态程序案例代码在 `此处 <https://github.com/LearningOS/rCore-Tutorial-Book-2021Autumn/tree/ch2-U-nostd>`_ 获取。
Expand Down
6 changes: 1 addition & 5 deletions source/chapter1/4mini-rt-baremetal.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@
构建裸机执行环境
=================================

.. toctree::
:hidden:
:maxdepth: 5

有了上一节实现的用户态的最小执行环境,稍加改造,就可以完成裸机上的最小执行环境了。
本节中,我们将把 ``Hello world!`` 应用程序从用户态搬到内核态。

Expand Down Expand Up @@ -325,4 +321,4 @@ RustSBI 约定的 ``0x80200000`` 。我们需要修改程序的内存布局并

.. note::

背景知识:`理解应用程序和执行环境 <https://rcore-os.github.io/rCore-Tutorial-Book-v3/chapter1/4understand-prog.html>`_
背景知识:`理解应用程序和执行环境 <https://rcore-os.github.io/rCore-Tutorial-Book-v3/chapter1/4understand-prog.html>`_
6 changes: 1 addition & 5 deletions source/chapter1/5exercise.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
chapter1练习(已经废弃,没删是怕以后有用)
=====================================================

.. toctree::
:hidden:
:maxdepth: 4

- 本节难度: ****

编程作业
Expand Down Expand Up @@ -140,4 +136,4 @@ chapter1练习(已经废弃,没删是怕以后有用)

- 简单总结你实现的功能(200字以内,不要贴代码)。
- 完成问答题。
- (optional) 你对本次实验设计及难度/工作量的看法,以及有哪些需要改进的地方,欢迎畅所欲言。
- (optional) 你对本次实验设计及难度/工作量的看法,以及有哪些需要改进的地方,欢迎畅所欲言。
4 changes: 0 additions & 4 deletions source/chapter2/2application.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
实现应用程序
===========================

.. toctree::
:hidden:
:maxdepth: 5

.. note::

拓展阅读:`RISC-V 特权级机制 <https://rcore-os.github.io/rCore-Tutorial-Book-v3/chapter2/1rv-privilege.html>`_
Expand Down
6 changes: 1 addition & 5 deletions source/chapter2/3batch-system.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,6 @@
实现批处理操作系统
==============================

.. toctree::
:hidden:
:maxdepth: 5

将应用程序链接到内核
--------------------------------------------

Expand Down Expand Up @@ -165,4 +161,4 @@

- ``init`` :调用 ``print_app_info`` 的时第一次用到了全局变量 ``APP_MANAGER`` ,它在这时完成初始化;
- ``run_next_app`` :批处理操作系统的核心操作,即加载并运行下一个应用程序。
批处理操作系统完成初始化,或者应用程序运行结束/出错后会调用该函数。下节再介绍其具体实现。
批处理操作系统完成初始化,或者应用程序运行结束/出错后会调用该函数。下节再介绍其具体实现。
4 changes: 0 additions & 4 deletions source/chapter2/4trap-handling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@
实现特权级的切换
===========================

.. toctree::
:hidden:
:maxdepth: 5

RISC-V特权级切换
---------------------------------------

Expand Down
4 changes: 0 additions & 4 deletions source/chapter2/5exercise.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
chapter2练习(已废弃)
=====================================================

.. toctree::
:hidden:
:maxdepth: 4

编程练习
-------------------------------

Expand Down
6 changes: 1 addition & 5 deletions source/rest-example.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
reStructuredText 基本语法
=====================================================

.. toctree::
:hidden:
:maxdepth: 4

.. note::
下面是一个注记。

Expand Down Expand Up @@ -73,4 +69,4 @@ reStructuredText 基本语法
* - :math:`\text{jalr}\ \text{rd},\ (\text{imm}[11:0])\text{rs}`
- :math:`\text{rd}\leftarrow\text{pc}+4`

:math:`\text{pc}\leftarrow\text{rs}+\text{imm}`
:math:`\text{pc}\leftarrow\text{rs}+\text{imm}`
4 changes: 0 additions & 4 deletions source/setup-sphinx.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
修改和构建本项目
====================================

.. toctree::
:hidden:
:maxdepth: 4

TL;DR: ``python -m venv .venv`` 创建一个虚拟环境(你也可以使用 conda 等工具),activate 后 ``pip install -r requirements.txt``。

1. 参考 `这里 <https://www.sphinx-doc.org/en/master/usage/installation.html>`_ 安装 Sphinx。
Expand Down

0 comments on commit 2619c47

Please sign in to comment.