From 7d3401444d6961cb8b59a3110016265a64177383 Mon Sep 17 00:00:00 2001 From: "hongwei.li" Date: Wed, 6 Jul 2022 14:52:21 +0800 Subject: [PATCH 1/3] =?UTF-8?q?=E6=96=B0=E5=A2=9E=E7=BC=96=E8=AF=91?= =?UTF-8?q?=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/compile.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 doc/compile.md diff --git a/doc/compile.md b/doc/compile.md new file mode 100644 index 0000000..4a3ea24 --- /dev/null +++ b/doc/compile.md @@ -0,0 +1,44 @@ +# 编译指南 + +## 1. 编译环境准备 + +1. 安装 `Rust`。通过 `rustup` 下载 `Rust`，这是一个管理 `Rust` 版本和相关工具的命令行工具。 +2. 安装 `Rust` 编译器 。本项目采用的编译器是 `rustc 1.61.0-nightly` 。这里需要强调的是 `nightly` 版本的是官方用来实验新功能的 **不稳定版本** 。此项目用到了很多 `Rust` 的 **不稳定特性**，因此只能选择 `nightly`。 +3. 安装 `Cargo`，这是 `Rust` 的构建系统和包管理器，大多数 `Rustacean` 们使用 `Cargo` 来管理他们的 `Rust` 项目，它可以帮你处理很多任务，比如构建代码，下载依赖库并编译这些库。 +4. 使用 `Cargo` 编译本项目。`cargo build` 编译一个包，`cargo check` 检查本地包及其所有依赖项是否有错误，`cargo clean` 删除 `Cargo` 过去生成的文件。`cargo build --release` 表示构建带有优化的包。 + +## 2. 项目目录结构说明 + +- `async-executor` + - `examples` 示例代码 + - `src` + - `lib` 异步执行器单线程实现 + +## 3. 条件编译 + +### 3.1. 通过配置 `Cargo.toml` 配置文件可以实现条件编译 + +``` toml +[features] +# default 字段配置了默认启动哪些 feature。每一个 feature 都是一个列表，列表中的项表示将依赖于哪些 feature。 +# default = ["alloc"] 表示默认依赖于 alloc 。而 alloc 又依赖于 stdlib/alloc 和 sync-task/alloc 库，默认为 NO-STD 编译。 +# 若将 default = ["alloc"] 修改为 default = ["std"] 则表示依赖依赖项中包含 rust STD。 +# 注意事项：不能同时开启 alloc 和 std。编译时只能选择其中一个。即 default = ["alloc","std"] 是错误的，无法编译。 +default = ["alloc"] +alloc = ["stdlib/alloc", "async-task/alloc"] +std = ["stdlib/std", "async-task/std"] + +``` + +### 3.2. 通过`Cargo`命令实现条件编译 + +```shell +# 注意事项：不能同时开启 alloc 和 std。编译时只能选择其中一个。即 cargo build --no-default-features --features "stdlib/std stdlib/alloc" 是错误的，无法编译。 +# STD 编译 +# --no-default-features 表示不开启默认 features ，--features "std" 会依赖用户列出的 features，也就是 std。 +cargo build --no-default-features --features "std" +# NO-STD +# --no-default-features 表示不开启默认 features ，--features "alloc" 会依赖用户列出的 features，也就是 alloc。 +cargo build --no-default-features --features "alloc" +``` + -- Gitee From c044ffd7c33f27b54a818c35a8160f2dde48b8ff Mon Sep 17 00:00:00 2001 From: "hongwei.li" Date: Wed, 6 Jul 2022 17:21:39 +0800 Subject: [PATCH 2/3] =?UTF-8?q?Cargo.toml=E9=85=8D=E7=BD=AE=E6=96=87?= =?UTF-8?q?=E4=BB=B6=E4=BF=AE=E6=94=B9=EF=BC=8C=E5=B0=86=E6=9C=AC=E5=9C=B0?= =?UTF-8?q?=E7=9B=B8=E5=AF=B9=E5=9C=B0=E5=9D=80=E4=BE=9D=E8=B5=96=E4=BF=AE?= =?UTF-8?q?=E6=94=B9=E4=B8=BAgit=E5=9C=B0=E5=9D=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Cargo.toml | 6 +++--- README.md | 46 +++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 48 insertions(+), 4 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 32616af..6cef980 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -15,9 +15,9 @@ signle_thread = [] [dependencies] -stdlib = { path = "../stdlib", default-features = false } -async-task = { path = "../async-task", default-features = false } -utils = { path = "../utils" } +stdlib = { git = "https://gitee.com/iot-ua/stdlib.git", default-features = false,branch="develop"} +async-task = { git = "https://gitee.com/iot-ua/async-task.git", default-features = false,branch="develop"} +utils = { git = "https://gitee.com/iot-ua/utils.git",branch="develop" } slab = { version = "0.4.6", default-features = false } [dev-dependencies] diff --git a/README.md b/README.md index aefff22..403ca25 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,49 @@ # async-executor -#### 介绍 +#### 1. 介绍 异步任务的异步执行器，用来对异步任务 `Task` 进行调度执行。 +#### 2. 编译指南 + +##### 2.1. 编译环境准备 + +1. 安装 `Rust`。通过 `rustup` 下载 `Rust`，这是一个管理 `Rust` 版本和相关工具的命令行工具。 +2. 安装 `Rust` 编译器 。本项目采用的编译器是 `rustc 1.61.0-nightly` 。这里需要强调的是 `nightly` 版本的是官方用来实验新功能的 **不稳定版本** 。此项目用到了很多 `Rust` 的 **不稳定特性**，因此只能选择 `nightly`。 +3. 安装 `Cargo`，这是 `Rust` 的构建系统和包管理器，大多数 `Rustacean` 们使用 `Cargo` 来管理他们的 `Rust` 项目，它可以帮你处理很多任务，比如构建代码，下载依赖库并编译这些库。 +4. 使用 `Cargo` 编译本项目。`cargo build` 编译一个包，`cargo check` 检查本地包及其所有依赖项是否有错误，`cargo clean` 删除 `Cargo` 过去生成的文件。`cargo build --release` 表示构建带有优化的包。 + +##### 2.2. 项目目录结构说明 + +- `async-executor` + - `examples` 示例代码 + - `src` + - `lib` 异步执行器单线程实现 + +##### 2.3. 条件编译 + +###### 2.3.1. 通过配置 `Cargo.toml` 配置文件可以实现条件编译 + +``` toml +[features] +# default 字段配置了默认启动哪些 feature。每一个 feature 都是一个列表，列表中的项表示将依赖于哪些 feature。 +# default = ["alloc"] 表示默认依赖于 alloc 。而 alloc 又依赖于 stdlib/alloc 和 sync-task/alloc 库，默认为 NO-STD 编译。 +# 若将 default = ["alloc"] 修改为 default = ["std"] 则表示依赖依赖项中包含 rust STD。 +# 注意事项：不能同时开启 alloc 和 std。编译时只能选择其中一个。即 default = ["alloc","std"] 是错误的，无法编译。 +default = ["alloc"] +alloc = ["stdlib/alloc", "async-task/alloc"] +std = ["stdlib/std", "async-task/std"] + +``` + +###### 2.3.2. 通过`Cargo`命令实现条件编译 + +```shell +# 注意事项：不能同时开启 alloc 和 std。编译时只能选择其中一个。即 cargo build --no-default-features --features "stdlib/std stdlib/alloc" 是错误的，无法编译。 +# STD 编译 +# --no-default-features 表示不开启默认 features ，--features "std" 会依赖用户列出的 features，也就是 std。 +cargo build --no-default-features --features "std" +# NO-STD +# --no-default-features 表示不开启默认 features ，--features "alloc" 会依赖用户列出的 features，也就是 alloc。 +cargo build --no-default-features --features "alloc" +``` + -- Gitee From cac327192f21f90ee296c1f4f1afcd359e0c9f17 Mon Sep 17 00:00:00 2001 From: "hongwei.li" Date: Wed, 6 Jul 2022 17:21:58 +0800 Subject: [PATCH 3/3] =?UTF-8?q?=E5=88=A0=E9=99=A4doc=E6=96=87=E4=BB=B6?= =?UTF-8?q?=E5=A4=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- doc/compile.md | 44 -------------------------------------------- 1 file changed, 44 deletions(-) delete mode 100644 doc/compile.md diff --git a/doc/compile.md b/doc/compile.md deleted file mode 100644 index 4a3ea24..0000000 --- a/doc/compile.md +++ /dev/null @@ -1,44 +0,0 @@ -# 编译指南 - -## 1. 编译环境准备 - -1. 安装 `Rust`。通过 `rustup` 下载 `Rust`，这是一个管理 `Rust` 版本和相关工具的命令行工具。 -2. 安装 `Rust` 编译器 。本项目采用的编译器是 `rustc 1.61.0-nightly` 。这里需要强调的是 `nightly` 版本的是官方用来实验新功能的 **不稳定版本** 。此项目用到了很多 `Rust` 的 **不稳定特性**，因此只能选择 `nightly`。 -3. 安装 `Cargo`，这是 `Rust` 的构建系统和包管理器，大多数 `Rustacean` 们使用 `Cargo` 来管理他们的 `Rust` 项目，它可以帮你处理很多任务，比如构建代码，下载依赖库并编译这些库。 -4. 使用 `Cargo` 编译本项目。`cargo build` 编译一个包，`cargo check` 检查本地包及其所有依赖项是否有错误，`cargo clean` 删除 `Cargo` 过去生成的文件。`cargo build --release` 表示构建带有优化的包。 - -## 2. 项目目录结构说明 - -- `async-executor` - - `examples` 示例代码 - - `src` - - `lib` 异步执行器单线程实现 - -## 3. 条件编译 - -### 3.1. 通过配置 `Cargo.toml` 配置文件可以实现条件编译 - -``` toml -[features] -# default 字段配置了默认启动哪些 feature。每一个 feature 都是一个列表，列表中的项表示将依赖于哪些 feature。 -# default = ["alloc"] 表示默认依赖于 alloc 。而 alloc 又依赖于 stdlib/alloc 和 sync-task/alloc 库，默认为 NO-STD 编译。 -# 若将 default = ["alloc"] 修改为 default = ["std"] 则表示依赖依赖项中包含 rust STD。 -# 注意事项：不能同时开启 alloc 和 std。编译时只能选择其中一个。即 default = ["alloc","std"] 是错误的，无法编译。 -default = ["alloc"] -alloc = ["stdlib/alloc", "async-task/alloc"] -std = ["stdlib/std", "async-task/std"] - -``` - -### 3.2. 通过`Cargo`命令实现条件编译 - -```shell -# 注意事项：不能同时开启 alloc 和 std。编译时只能选择其中一个。即 cargo build --no-default-features --features "stdlib/std stdlib/alloc" 是错误的，无法编译。 -# STD 编译 -# --no-default-features 表示不开启默认 features ，--features "std" 会依赖用户列出的 features，也就是 std。 -cargo build --no-default-features --features "std" -# NO-STD -# --no-default-features 表示不开启默认 features ，--features "alloc" 会依赖用户列出的 features，也就是 alloc。 -cargo build --no-default-features --features "alloc" -``` - -- Gitee