# static-keys v0.6.1

Bare metal support is added. Bump dependencies.
Godones · Oct 30, 2024 · 3aa610f · 3aa610f
1 parent 8526b17
commit 3aa610f
Show file tree

Hide file tree

Showing 8 changed files with 53 additions and 27 deletions.
diff --git a/CHANGELOG/v0.6.1.md b/CHANGELOG/v0.6.1.md
@@ -0,0 +1,5 @@
+# static-keys v0.6.1
+
+Bare metal support is added.
+
+Bump dependencies.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "static-keys"
-version = "0.6.0"
+version = "0.6.1"
 edition = "2021"
 authors = ["Evian-Zhang <[email protected]>"]
 license = "MIT OR Apache-2.0"

diff --git a/README.md b/README.md
@@ -23,6 +23,8 @@ Currently CI-tested platforms:
 
     * `x86_64-pc-windows-msvc`
     * `i686-pc-windows-msvc`
+* Bare metal (No CI)
+    * Should work with above-mentioned architectures. For more detail, see [FAQ](https://evian-zhang.github.io/static-keys/en/FAQs.html#How-can-I-use-this-crate-in-bare-metal).
 
 Note that when using cross-rs to build `loongarch64-unknown-linux-gnu` target, you should use latest cross-rs avaiable on GitHub. See [Evian-Zhang/static-keys#4](https://github.com/Evian-Zhang/static-keys/pull/4) for more details.
 

diff --git a/docs/en/src/FAQs.md b/docs/en/src/FAQs.md
@@ -40,3 +40,7 @@ Because when passing a static variable to inline assembly as `sym` argument, it
 ## Can I use this crate in `no_std`?
 
 Yes.
+
+## How can I use this crate in bare metal?
+
+You should modify your linker script to add `__start` and `__stop` prefix symbols for marking start and end address of corresponding sections. For more details, see [Evian-Zhang/static-keys#6](https://github.com/Evian-Zhang/static-keys/pull/6).
diff --git a/docs/en/src/README.md b/docs/en/src/README.md
@@ -23,6 +23,8 @@ Currently CI-tested platforms:
 
     * `x86_64-pc-windows-msvc`
     * `i686-pc-windows-msvc`
+* Bare metal (No CI)
+    * Should work with above-mentioned architectures. For more detail, see [FAQ](https://evian-zhang.github.io/static-keys/en/FAQs.html#How-can-I-use-this-crate-in-bare-metal).
 
 Note that when using cross-rs to build `loongarch64-unknown-linux-gnu` target, you should use latest cross-rs avaiable on GitHub. See [Evian-Zhang/static-keys#4](https://github.com/Evian-Zhang/static-keys/pull/4) for more details.
 

diff --git a/docs/zh-Hans/src/FAQs.md b/docs/zh-Hans/src/FAQs.md
@@ -39,3 +39,7 @@
 ## 我可以在`no_std`环境中使用吗？
 
 可以
+
+## 我可以在裸金属环境中使用吗？
+
+可以。需要修改linker script，在对应的节前后加上`__start`和`__stop`为前缀的相应符号。具体可见[Evian-Zhang/static-keys#6](https://github.com/Evian-Zhang/static-keys/pull/6)。
diff --git a/docs/zh-Hans/src/README.md b/docs/zh-Hans/src/README.md
@@ -23,6 +23,8 @@
 
     * `x86_64-pc-windows-msvc`
     * `i686-pc-windows-msvc`
+* 裸金属（未经过CI测试）
+    * 上述架构应该都能支持。具体可见[FAQ](https://evian-zhang.github.io/static-keys/zh-Hans/FAQs.html#我可以在裸金属环境中使用吗)
 
 需要注意，如果使用cross-rs交叉编译`loongarch64-unknown-linux-gnu`平台，需要使用GitHub上的最新版cross-rs。更多细节可参见[Evian-Zhang/static-keys#4](https://github.com/Evian-Zhang/static-keys/pull/4)。