Add the Rust compilation guidance document

Issue:I6SJNH
Signed-off-by: Nlubinglun <lubinglun@huawei.com>
Change-Id: I950346d4997aba8ef88f637773d98334c64122e8

en/device-dev/subsystems/subsys-build-rust-compilation.md

+# OpenHarmony rust module configuration rules and guidance
+## Configuration rules for various types of rust
+Currently, OpenHarmony provides various types of gn templates for compiling and building rust code,include ohos_rust_executable、ohos_rust_static_library、ohos_rust_proc_macro、ohos_rust_shared_ffi、ohos_rust_static_ffi、ohos_rust_cargo_crate、ohos_rust_systemtest、ohos_rust_unittest.
+## Guide for configuring various types of rust
+### GN template
+To use the rust rule, you need to first import "//build/ohos. gni", which is a shared external interface with C/C++
+```
+import("//build/ohos.gni")
+```
+To use the rust rule, you need to first import "//build/test. gni", which is a shared external interface with C/C++
+```
+import("//build/test.gni")
+```
+### Example
+Currently, 'host x86_64', 'target arm64', and 'target arm' architectures have been supported for rust compilation and construction
+#### Example reference
+There are configuration examples of various types of rust modules available for reference in the build/rust/tests directory:
+| test directory | test function |
+| ---- | ---- |
+| test_bin_crate | Test the host and target compilation links and running of 'ohos_rust_executable' |
+| test_static_link | Testing static link from "ohos_rust_executable" to libstd.rlib |
+| test_dylib_crate | Test the compilation dependency and running of 'ohos_rust_executable' on 'ohos_rust_shared_library' |
+| test_rlib_crate | Test the compilation dependency and running of 'ohos_rust_executable' on 'ohos_rust_static_library' |
+| test_proc_macro_crate | Test the compilation dependency and running of 'ohos_rust_executable' on 'ohos_rust_proc_macro' |
+| test_cdylib_crate | Test the compilation dependency and running of 'ohos_rust_executable' on 'ohos_rust_shared_ffi' |
+| test_staticlib_crate | Test the compilation dependency and running of 'ohos_rust_executable' on 'ohos_rust_static_ffi' |
+| test_rust_ut | Test 'ohos_rust_unittest', with the use case code and feature code in the same file |
+| test_rust_st | Test 'ohos_rust_systemtest', with the use case code and feature code in the same file |
+| test_bin_cargo_crate | Test executable file which using 'ohos_cargo_crate' |
+| test_rlib_cargo_crate | Test static library file which using 'ohos_cargo_crate' |
+| test_proc_macro_cargo_crate | Test proc_macro which using 'ohos_cargo_crate' |
+#### Example of characteristic points
+##### Rust source code relies on calling C/C++ libraries
+By default, C/C++ modules in a dynamic library on OH use the .z.so suffix, but when they are depended on by Rust, they are converted to -l links, which will only link dynamic libraries with the .so suffix. Therefore, C/C++ dynamic libraries that are dependent on need to add output_externsion = "so". Similarly, if linking to a dynamic library in Rust source code, the suffix also needs to use ".so", and the middle name of the dynamic library does not need to add the "lib" prefix. For example, linking to libhilog.so:
+```
+#[link(name = "hilog")]
+```
+##### externs
+If a module relies on a binary rlib library, the externs attribute can be used:
+```
+executable("foo") {
+    sources = [ "main.rs" ]
+    externs = [{                    # `--extern bar=path/to/bar.rlib`
+        crate_name = "bar"
+        path = "path/to/bar.rlib"
+    }]
+}
+```
+##### rust-project.json for IDE
+```
+./build.sh --product-name rk3568 --build-target=build/rust:default --export-rust-project
+```
+#### Verification
+Currently target ohos arm and ohos arm64 architectures are supported. Arm64 simulator compilation startup method:
+```
+./build.sh --product-name qemu-arm64-linux-min
+./vendor/ohemu/qemu_arm64_linux_min/qemu_run.sh -e out/qemu-arm-linux/packages/phone/images/
+```
+### Lints rules
+The OH framework supports two levels of lints: rustc lints and clippy lints, identified by the module attributes rustc_lints and clippy_lints respectively. It also supports three standard levels: "openharmony", "vendor", and "none", with "openharmony" being the strictest and system-configured. When a module has no configuration, the level is determined based on path matching.
+#### The various level markers for rustc lints and clippy lints.
+| **lints type** | **module attribute** | **lints level** | **lints level flags** | **lints content** |
+| ---- | ---- | ---- | ---- | ---- |
+| rustc_lints | rustc_lints | openharmony | RustOhosLints | "-A deprecated", "-D missing-docs", "-D warnigngs" |
+| rustc_lints  |  rustc_lints | vendor | RustcVendorLints | "-A deprecated", "-D warnigs" |
+| rustc_lints  | rustc_lints  | none | allowAllLints | "-cap-lints allow" |
+| clippy lints | clippy lints | openharmony | ClippyOhosLints | "-A clippy::type-complexity", "-A clippy::unnecessary-wraps", "-A clippy::unusual-byte-groupings", "-A clippy::upper-case-acronyms" |
+| clippy lints | clippy lints | vendor | ClippyVendorLints | "-A clippy::complexity", "-A Clippy::perf", "-A clippy::style" |
+| clippy lints | clippy lints | none | allowAllLints | "--cap-lints allow" |
+
+#### The correspondence between code paths and lint levels.
+| path | Lints level | Note |
+| ---- | ---- | ---- |
+| thirdparty | none |  |
+| prebuilts | none |  |
+| vendor | vendor |  |
+| device | vendor |  |
+| others | openharmony |
+

zh-cn/device-dev/subsystems/subsys-build-rust-compilation.md

+# OpenHarmony rust模块配置规则和指导
+## rust各类型模块配置规则
+当前OpenHarmony提供了用于rust代码编译构建的各类型gn模板。包含ohos_rust_executable、ohos_rust_static_library、ohos_rust_proc_macro、ohos_rust_shared_ffi、ohos_rust_static_ffi、ohos_rust_cargo_crate、ohos_rust_systemtest、ohos_rust_unittest.
+## rust各类型模块配置指导
+### 模板gni文件
+使用rust规则需要先import导入"//build/ohos.gni"，与C/C++共用的对外接口
+```
+import("//build/ohos.gni")
+```
+使用rust测试用例规则需要先import导入"//build/test.gni"，与C/C++共用的对外接口
+```
+import("//build/test.gni")
+```
+### 实例参考
+当前已经支持host x86_64和target arm64和target arm架构的rust相关编译构建
+#### 源码实例 
+在build/rust/tests目录下有rust各类型模块的配置实例可供参考：
+| 用例目录 | 测试功能 |
+| ---- | ---- |
+| test_bin_crate | 测试ohos_rust_executable的host和target编译链接及运行 |
+| test_static_link | 测试ohos_rust_executable对libstd.rlib进行静态链接 |
+| test_dylib_crate | 测试ohos_rust_executable对ohos_rust_shared_library的编译依赖和运行 |
+| test_rlib_crate | 测试ohos_rust_executable对ohos_rust_static_library的编译依赖和运行 |
+| test_proc_macro_crate | 测试ohos_rust_executable对ohos_rust_proc_macro的编译依赖和运行,对不同类型都有用例覆盖 |
+| test_cdylib_crate | 测试ohos_rust_executable对ohos_rust_shared_ffi的编译依赖和运行 |
+| test_staticlib_crate | 测试ohos_rust_executable对ohos_rust_static_ffi的编译依赖和运行 |
+| test_rust_ut | 测试ohos_rust_unittest，用例代码与特性代码在同一个文件中 |
+| test_rust_st | 测试ohos_rust_systemtest，用例代码在独立的test目录中 |
+| test_bin_cargo_crate | 测试ohos_cargo_crate对拥有build.rs预编译的可执行文件编译链接和运行，适用于rust三方crate编译依赖 |
+| test_rlib_cargo_crate | 测试ohos_cargo_crate对拥有build.rs预编译的静态库文件编译链接和运行，适用于rust三方crate编译依赖 |
+| test_proc_macro_cargo_crate | 测试ohos_cargo_crate对拥有build.rs预编译的过程宏编译链接和运行，适用于rust三方crate编译依赖 |
+#### 特性点实例
+##### rust源码依赖调用C/C++库
+OH上C/C++模块动态库默认用.z.so后缀，但是被rust依赖部分会转成-l链接，默认只会链接.so后缀的动态库。因此被依赖的C/C++动态库要加上output_externsion = "so"。同理，在rust源码中如果直接链接动态库，后缀也需要使用".so"，使用动态库的中间名，不需要添加lib前缀，例如链接libhilog.so:
+```
+#[link(name = "hilog")]
+```
+##### externs使用
+某个模块如果依赖二进制的rlib库，可以使用externs属性：
+```
+executable("foo") {
+    sources = [ "main.rs" ]
+    externs = [{                    # 编译时会转成`--extern bar=path/to/bar.rlib`
+        crate_name = "bar"
+        path = "path/to/bar.rlib"
+    }]
+}
+```
+##### IDE的rust-project.json编译
+```
+./build.sh --product-name rk3568 --build-target=build/rust:default --export-rust-project
+```
+#### 运行验证
+当前支持target ohos arm和ohos arm64架构。arm64模拟器编译启动方法：
+```
+./build.sh --product-name qemu-arm64-linux-min
+./vendor/ohemu/qemu_arm64_linux_min/qemu_run.sh -e out/qemu-arm-linux/packages/phone/images/
+```
+### lints规则
+OH框架支持rustc lints和clippy lints两级lints，分别由模块属性rustc_lints和clippy_lints标识；同时支持三个等级的标准："openharmony"、"vendor"和"none"，"openharmony"是系统配置，最为严格。模块无配置时按照路径匹配等级。
+#### rustc lints和clippy lints的各等级标志
+| **lints类型** | **模块属性** | **lints等级** | **lints等级标志** | **lints内容** |
+| ---- | ---- | ---- | ---- | ---- |
+| rustc_lints | rustc_lints | openharmony | RustOhosLints | "-A deprecated", "-D missing-docs", "-D warnigngs" |
+| rustc_lints  |  rustc_lints | vendor | RustcVendorLints | "-A deprecated", "-D warnigs" |
+| rustc_lints  | rustc_lints  | none | allowAllLints | "-cap-lints allow" |
+| clippy lints | clippy lints | openharmony | ClippyOhosLints | "-A clippy::type-complexity", "-A clippy::unnecessary-wraps", "-A clippy::unusual-byte-groupings", "-A clippy::upper-case-acronyms" |
+| clippy lints | clippy lints | vendor | ClippyVendorLints | "-A clippy::complexity", "-A Clippy::perf", "-A clippy::style" |
+| clippy lints | clippy lints | none | allowAllLints | "--cap-lints allow" |
+
+#### 代码路径与lints等级的对应关系
+| 路径 | Lints等级 | 备注 |
+| ---- | ---- | ---- |
+| thirdparty | none |  |
+| prebuilts | none |  |
+| vendor | vendor |  |
+| device | vendor |  |
+| others | openharmony |
+