diff --git a/docs/po/messages.pot b/docs/po/messages.pot index 4a665f0..13f74de 100644 --- a/docs/po/messages.pot +++ b/docs/po/messages.pot @@ -2,7 +2,7 @@ msgid "" msgstr "" "Project-Id-Version: ezlog documentation\n" -"POT-Creation-Date: \n" +"POT-Creation-Date: 2023-10-17T01:17:24+08:00\n" "PO-Revision-Date: \n" "Last-Translator: \n" "Language-Team: \n" @@ -37,27 +37,31 @@ msgid "Rust" msgstr "" #: src/SUMMARY.md:12 +#: src/benchmark.md:1 msgid "Benchmark" msgstr "" #: src/SUMMARY.md:14 +#: src/architecture.md:1 msgid "Architecture" msgstr "" #: src/SUMMARY.md:16 +#: src/build.md:1 msgid "Build" msgstr "" #: src/introduction.md:1 -msgid "# ezlog" +#: src/benchmark.md:11 +msgid "ezlog" msgstr "" #: src/introduction.md:3 -msgid "[中文介绍](https://s1rius.github.io/ezlog/zh/index.html)

" +msgid "[中文介绍](https://s1rius.github.io/ezlog/zh/index.html)" msgstr "" #: src/introduction.md:5 -msgid "## What is ezlog?" +msgid "What is ezlog?" msgstr "" #: src/introduction.md:7 @@ -75,24 +79,43 @@ msgid "" msgstr "" #: src/introduction.md:13 -msgid "### Features" +msgid "Features" msgstr "" #: src/introduction.md:14 +msgid "multi platform: Flutter, Android, iOS, Windows, Linux, MacOS" +msgstr "" + +#: src/introduction.md:15 msgid "" -"- multi platform: Flutter, Android, iOS, Windows, Linux, MacOS\n" -"- map file into memory by " -"[mmap](https://man7.org/linux/man-pages/man2/mmap.2.html).\n" -"- compression support, eg: [zlib](https://en.wikipedia.org/wiki/Zlib).\n" -"- encryption support, eg: [AEAD " -"encryption](https://en.wikipedia.org/wiki/Authenticated_encryption).\n" -"- fetch log by callback.\n" -"- trim out of date files.\n" -"- command line parser support." +"map file into memory by " +"[mmap](https://man7.org/linux/man-pages/man2/mmap.2.html)." +msgstr "" + +#: src/introduction.md:16 +msgid "compression support, eg: [zlib](https://en.wikipedia.org/wiki/Zlib)." +msgstr "" + +#: src/introduction.md:17 +msgid "" +"encryption support, eg: [AEAD " +"encryption](https://en.wikipedia.org/wiki/Authenticated_encryption)." +msgstr "" + +#: src/introduction.md:18 +msgid "fetch log by callback." +msgstr "" + +#: src/introduction.md:19 +msgid "trim out of date files." +msgstr "" + +#: src/introduction.md:20 +msgid "command line parser support." msgstr "" #: src/introduction.md:22 -msgid "### License" +msgid "License" msgstr "" #: src/introduction.md:24 @@ -101,24 +124,16 @@ msgid "" msgstr "" #: src/platform/flutter.md:1 -msgid "### Flutter Usage" +msgid "Flutter Usage" msgstr "" #: src/platform/flutter.md:3 -msgid "#### Add ezlog_flutter as a dependency in your pubspec.yaml file." -msgstr "" - -#: src/platform/flutter.md:5 -msgid "" -"```yaml\n" -"dependencies:\n" -" ezlog_flutter: ^0.2.0\n" -"```" +msgid "Add ezlog_flutter as a dependency in your pubspec.yaml file." msgstr "" #: src/platform/flutter.md:10 #: src/platform/rust.md:12 -msgid "#### Example" +msgid "Example" msgstr "" #: src/platform/flutter.md:12 @@ -167,38 +182,17 @@ msgid "" msgstr "" #: src/platform/android.md:1 -msgid "### Android Usage" +msgid "Android Usage" msgstr "" #: src/platform/android.md:3 -msgid "#### Add ezlog to dependencies" +msgid "Add ezlog to dependencies" msgstr "" #: src/platform/android.md:5 msgid "Open top-level `build.gradle`, add `mavenCentral` to repositories." msgstr "" -#: src/platform/android.md:7 -msgid "" -"```groovy\n" -"buildscript {\n" -" repositories {\n" -" ...\n" -" mavenCentral()\n" -" ...\n" -" }\n" -"}\n" -"\n" -"allprojects {\n" -" repositories {\n" -" ...\n" -" mavenCentral()\n" -" ...\n" -" }\n" -"}\n" -"```" -msgstr "" - #: src/platform/android.md:25 msgid "Open app level `build.gradle`, add `ezlog`" msgstr "" @@ -217,7 +211,7 @@ msgid "Sync gradle" msgstr "" #: src/platform/android.md:35 -msgid "#### Setup in application" +msgid "Setup in application" msgstr "" #: src/platform/android.md:37 @@ -265,38 +259,24 @@ msgid "" msgstr "" #: src/platform/ios.md:1 -msgid "### iOS Usage" +msgid "iOS Usage" msgstr "" #: src/platform/ios.md:3 #: src/platform/rust.md:3 -msgid "#### Add ezlog" +msgid "Add ezlog" msgstr "" #: src/platform/ios.md:5 msgid "Add dependency to Podfile" msgstr "" -#: src/platform/ios.md:7 -msgid "" -"```shell\n" -"pod 'EZLog', '~> 0.1'\n" -"```" -msgstr "" - #: src/platform/ios.md:10 msgid "then" msgstr "" -#: src/platform/ios.md:12 -msgid "" -"```shell\n" -"pod update\n" -"```" -msgstr "" - #: src/platform/ios.md:15 -msgid "#### Open Xcode, add sample code" +msgid "Open Xcode, add sample code" msgstr "" #: src/platform/ios.md:17 @@ -353,7 +333,7 @@ msgid "click run and see console ouput." msgstr "" #: src/platform/rust.md:1 -msgid "### Rust Usage" +msgid "Rust Usage" msgstr "" #: src/platform/rust.md:5 @@ -399,118 +379,226 @@ msgstr "" msgid "see more examples in examples dir." msgstr "" -#: src/benchmark.md:1 -msgid "## Benchmark" -msgstr "" - #: src/benchmark.md:3 -msgid "### Android Benchmark" +msgid "Android Benchmark" msgstr "" #: src/benchmark.md:5 -msgid "#### measure log method" +msgid "measure log method" msgstr "" #: src/benchmark.md:7 -msgid "" -"| Library | Time (ns) | Allocations |\n" -"|---------|-----------|-------------|\n" -"| logcat | 2,427 | 7 |\n" -"| logan | 4,726 | 14 |\n" -"| ezlog | 8,404 | 7 |\n" -"| xlog | 12,459 | 7 |" +msgid "Library" msgstr "" -#: src/benchmark.md:14 -msgid "#### startup time" +#: src/benchmark.md:7 +msgid "Time (ns)" msgstr "" -#: src/benchmark.md:16 -msgid "startup baseline" +#: src/benchmark.md:7 +msgid "Allocations" msgstr "" -#: src/benchmark.md:17 -msgid "" -"```\n" -"min 206.4, median 218.5, max 251.9\n" -"```" +#: src/benchmark.md:9 +msgid "logcat" msgstr "" -#: src/benchmark.md:21 -msgid "startup with ezlog time:" +#: src/benchmark.md:9 +msgid "2,427" msgstr "" -#: src/benchmark.md:22 -msgid "" -"```\n" -"min 206.8, median 216.6, max 276.6\n" -"```" +#: src/benchmark.md:9 +#: src/benchmark.md:11 +#: src/benchmark.md:12 +msgid "7" msgstr "" -#: src/architecture.md:1 -msgid "## Architecture" +#: src/benchmark.md:10 +msgid "logan" msgstr "" -#: src/architecture.md:3 -msgid "### Code structure" +#: src/benchmark.md:10 +msgid "4,726" msgstr "" -#: src/architecture.md:5 -msgid "" -"```\n" -"├── android\n" -"│   ├── app # android demo app\n" -"│   └── lib-ezlog # ezlog android library\n" -"├── examples # Rust examples\n" -"├── ezlog_flutter # Flutter plugin\n" -"├── ezlogcli # Rust command line tool\n" -"├── ezlog-core # Rust core library\n" -"├── ios\n" -"│   ├── EZLog # ezlog iOS library\n" -"│   ├── demo # iOS demo app\n" -"│   └── framework # ezlog XCFramework\n" -"```" +#: src/benchmark.md:10 +msgid "14" +msgstr "" + +#: src/benchmark.md:11 +msgid "8,404" +msgstr "" + +#: src/benchmark.md:12 +msgid "xlog" +msgstr "" + +#: src/benchmark.md:12 +msgid "12,459" +msgstr "" + +#: src/benchmark.md:14 +msgid "startup time" +msgstr "" + +#: src/benchmark.md:16 +msgid "startup baseline" +msgstr "" + +#: src/benchmark.md:21 +msgid "startup with ezlog time:" +msgstr "" + +#: src/architecture.md:3 +msgid "Code structure" msgstr "" #: src/architecture.md:19 -msgid "### Log file format" +msgid "Log file format" msgstr "" #: src/architecture.md:21 -msgid "#### Header " +msgid "Header" msgstr "" #: src/architecture.md:23 -msgid "" -"| Bytes Offset | Meaning |\n" -"|--------|------------------------------------------|\n" -"| 0-1 | 'ez' |\n" -"| 2 | Version number |\n" -"| 3 | Flag bits |\n" -"| 4-7 | Offset of recorder position in bytes |\n" -"| 8-15 | Unix timestamp (big-endian) |\n" -"| 16 | Compression type |\n" -"| 17 | Encryption type |\n" -"| 18-21 | Encryption key hash |" +msgid "Bytes Offset" +msgstr "" + +#: src/architecture.md:23 +msgid "Meaning" +msgstr "" + +#: src/architecture.md:25 +msgid "0-1" +msgstr "" + +#: src/architecture.md:25 +msgid "'ez'" +msgstr "" + +#: src/architecture.md:26 +msgid "2" +msgstr "" + +#: src/architecture.md:26 +msgid "Version number" +msgstr "" + +#: src/architecture.md:27 +msgid "3" +msgstr "" + +#: src/architecture.md:27 +msgid "Flag bits" +msgstr "" + +#: src/architecture.md:28 +msgid "4-7" +msgstr "" + +#: src/architecture.md:28 +msgid "Offset of recorder position in bytes" +msgstr "" + +#: src/architecture.md:29 +msgid "8-15" +msgstr "" + +#: src/architecture.md:29 +msgid "Unix timestamp (big-endian)" +msgstr "" + +#: src/architecture.md:30 +msgid "16" +msgstr "" + +#: src/architecture.md:30 +msgid "Compression type" +msgstr "" + +#: src/architecture.md:31 +msgid "17" +msgstr "" + +#: src/architecture.md:31 +msgid "Encryption type" +msgstr "" + +#: src/architecture.md:32 +msgid "18-21" +msgstr "" + +#: src/architecture.md:32 +msgid "Encryption key hash" msgstr "" #: src/architecture.md:34 -msgid "#### Per log record" +msgid "Per log record" msgstr "" #: src/architecture.md:36 -msgid "" -"| Byte Offset | Field Name| Description |\n" -"|----------|-----------|-----------------|\n" -"| 0| Start Byte| Always 0x3b indicating the start|\n" -"| 1-varint|Record Length| A variable-length integer that specifies the " -"length|\n" -"| varint+1-varint+n | Record Content | The actual log record content |\n" -"| varint+n+1| End Byte| Always 0x21 indicating the start |" +msgid "Byte Offset" +msgstr "" + +#: src/architecture.md:36 +msgid "Field Name" +msgstr "" + +#: src/architecture.md:36 +msgid "Description" +msgstr "" + +#: src/architecture.md:38 +msgid "0" +msgstr "" + +#: src/architecture.md:38 +msgid "Start Byte" +msgstr "" + +#: src/architecture.md:38 +msgid "Always 0x3b indicating the start" +msgstr "" + +#: src/architecture.md:39 +msgid "1-varint" +msgstr "" + +#: src/architecture.md:39 +msgid "Record Length" +msgstr "" + +#: src/architecture.md:39 +msgid "A variable-length integer that specifies the length" +msgstr "" + +#: src/architecture.md:40 +msgid "varint+1-varint+n" +msgstr "" + +#: src/architecture.md:40 +msgid "Record Content" +msgstr "" + +#: src/architecture.md:40 +msgid "The actual log record content" +msgstr "" + +#: src/architecture.md:41 +msgid "varint+n+1" +msgstr "" + +#: src/architecture.md:41 +msgid "End Byte" +msgstr "" + +#: src/architecture.md:41 +msgid "Always 0x21 indicating the end" msgstr "" #: src/architecture.md:43 -msgid "### Compression" +msgid "Compression" msgstr "" #: src/architecture.md:45 @@ -518,11 +606,11 @@ msgid "We use zlib as the compression algorithm." msgstr "" #: src/architecture.md:47 -msgid "### Encryption" +msgid "Encryption" msgstr "" #: src/architecture.md:49 -msgid "#### We use AES-GCM-SIV as the encryption algorithm." +msgid "We use AES-GCM-SIV as the encryption algorithm." msgstr "" #: src/architecture.md:51 @@ -533,7 +621,7 @@ msgid "" msgstr "" #: src/architecture.md:53 -msgid "### Make nonce not repeat" +msgid "Make nonce not repeat" msgstr "" #: src/architecture.md:55 @@ -544,20 +632,8 @@ msgid "" "calculate the nonce of the current log record by the following formula:" msgstr "" -#: src/architecture.md:57 -msgid "" -"```\n" -"nonce = init_nonce ^ timestamp.extend(index)\n" -"\n" -"```" -msgstr "" - -#: src/build.md:1 -msgid "## Build" -msgstr "" - #: src/build.md:3 -msgid "- install and config rust" +msgid "install and config rust" msgstr "" #: src/build.md:5 @@ -569,14 +645,7 @@ msgid "" msgstr "" #: src/build.md:10 -msgid "- use rust nightly" -msgstr "" - -#: src/build.md:12 -msgid "" -"```shell\n" -"rustup default nightly-2022-08-10\n" -"```" +msgid "use rust nightly" msgstr "" #: src/build.md:16 @@ -586,127 +655,54 @@ msgid "" "feature, so add nightly src component" msgstr "" -#: src/build.md:18 -msgid "" -"```shell\n" -"rustup component add rust-src --toolchain nightly-x86_64-apple-darwin\n" -"```" -msgstr "" - #: src/build.md:22 msgid "clone repository and open in command line tool. then run" msgstr "" -#: src/build.md:24 -msgid "" -"```shell\n" -"cargo check\n" -"```" -msgstr "" - #: src/build.md:28 msgid "wait crates download..." msgstr "" -#: src/build.md:30 -msgid "" -"```shell\n" -"cargo build -p ezlog\n" -"```" -msgstr "" - #: src/build.md:34 -msgid "### for Flutter build" -msgstr "" - -#: src/build.md:36 -msgid "" -"```dart\n" -"flutter packages get\n" -"\n" -"flutter packages upgrade\n" -"```" +msgid "for Flutter build" msgstr "" #: src/build.md:42 -msgid "### For android build" +msgid "For android build" msgstr "" #: src/build.md:44 -msgid "- add android targets" -msgstr "" - -#: src/build.md:46 -msgid "" -"```shell\n" -"rustup target add aarch64-linux-android armv7-linux-androideabi " -"i686-linux-android x86_64-linux-android\n" -"```" +msgid "add android targets" msgstr "" #: src/build.md:50 msgid "we use `cargo-ndk` to build dylib" msgstr "" -#: src/build.md:52 -msgid "" -"```shell\n" -"cargo install cargo-ndk\n" -"```" -msgstr "" - #: src/build.md:56 msgid "cd android" msgstr "" -#: src/build.md:58 -msgid "" -"```shell\n" -"sh b_android.sh\n" -"```" -msgstr "" - #: src/build.md:62 msgid "then open current workspace in AndroidStudio" msgstr "" #: src/build.md:64 -msgid "### For iOS build" +msgid "For iOS build" msgstr "" #: src/build.md:66 -msgid "- add iOS targets" -msgstr "" - -#: src/build.md:68 -msgid "" -"```shell\n" -"rustup target add aarch64-apple-ios aarch64-apple-ios-sim x86_64-apple-ios\n" -"```" +msgid "add iOS targets" msgstr "" #: src/build.md:73 msgid "install `cbindgen`" msgstr "" -#: src/build.md:75 -msgid "" -"```shell\n" -"cargo install --force cbindgen\n" -"```" -msgstr "" - #: src/build.md:79 msgid "cd ios dir" msgstr "" -#: src/build.md:81 -msgid "" -"```shell\n" -"sh b_ios.sh\n" -"```" -msgstr "" - #: src/build.md:85 msgid "open the `ios/EZlog.xcworkspace` in Xcode" msgstr "" diff --git a/docs/po/zh.po b/docs/po/zh.po index 89e912d..c89caae 100644 --- a/docs/po/zh.po +++ b/docs/po/zh.po @@ -1,7 +1,7 @@ msgid "" msgstr "" "Project-Id-Version: ezlog documentation\n" -"POT-Creation-Date: \n" +"POT-Creation-Date: 2023-10-17T00:51:44+08:00\n" "PO-Revision-Date: 2023-05-14 21:00+0800\n" "Last-Translator: al dmgmgw \n" "Language-Team: Chinese\n" @@ -35,29 +35,29 @@ msgstr "" msgid "Rust" msgstr "" -#: src/SUMMARY.md:12 +#: src/SUMMARY.md:12 src/benchmark.md:1 msgid "Benchmark" msgstr "性能" -#: src/SUMMARY.md:14 +#: src/SUMMARY.md:14 src/architecture.md:1 msgid "Architecture" msgstr "架构设计" -#: src/SUMMARY.md:16 +#: src/SUMMARY.md:16 src/build.md:1 msgid "Build" msgstr "本地构建" -#: src/introduction.md:1 -msgid "# ezlog" +#: src/introduction.md:1 src/benchmark.md:11 +msgid "ezlog" msgstr "" #: src/introduction.md:3 -msgid "[中文介绍](https://s1rius.github.io/ezlog/zh/index.html)

" +msgid "[中文介绍](https://s1rius.github.io/ezlog/zh/index.html)" msgstr "" #: src/introduction.md:5 -msgid "## What is ezlog?" -msgstr "## 介绍" +msgid "What is ezlog?" +msgstr "介绍" #: src/introduction.md:7 msgid "ezlog is a high-performance cross-platform file logging library." @@ -76,33 +76,44 @@ msgstr "" "com/Meituan-Dianping/Logan), 使用[Rust](https://www.rust-lang.org/)重写。" #: src/introduction.md:13 -msgid "### Features" -msgstr "### 特性" +msgid "Features" +msgstr "特性" #: src/introduction.md:14 +msgid "multi platform: Flutter, Android, iOS, Windows, Linux, MacOS" +msgstr "可以用在Flutter,android,iOS,Windows,Linux,MacOS。" + +#: src/introduction.md:15 +msgid "" +"map file into memory by [mmap](https://man7.org/linux/man-pages/man2/mmap.2." +"html)." +msgstr "使用mmap做文件映射" + +#: src/introduction.md:16 +msgid "compression support, eg: [zlib](https://en.wikipedia.org/wiki/Zlib)." +msgstr "支持压缩" + +#: src/introduction.md:17 msgid "" -"- multi platform: Flutter, Android, iOS, Windows, Linux, MacOS\n" -"- map file into memory by [mmap](https://man7.org/linux/man-pages/man2/" -"mmap.2.html).\n" -"- compression support, eg: [zlib](https://en.wikipedia.org/wiki/Zlib).\n" -"- encryption support, eg: [AEAD encryption](https://en.wikipedia.org/wiki/" -"Authenticated_encryption).\n" -"- fetch log by callback.\n" -"- trim out of date files.\n" -"- command line parser support." -msgstr "" -"- 多平台支持 Flutter, iOS, Android, Windows, Linux, MacOS\n" -"- 使用[mmap](https://man7.org/linux/man-pages/man2/mmap.2.html)做日志映射\n" -"- 支持压缩,如[zilb](https://en.wikipedia.org/wiki/Zlib)\n" -"- 支持加密,如[AEAD](https://en.wikipedia.org/wiki/" -"Authenticated_encryption)\n" -"- 日志回捞\n" -"- 日志清理\n" -"- 命令行解析工具\n" +"encryption support, eg: [AEAD encryption](https://en.wikipedia.org/wiki/" +"Authenticated_encryption)." +msgstr "支持加密" + +#: src/introduction.md:18 +msgid "fetch log by callback." +msgstr "接口回调获取日志文件" + +#: src/introduction.md:19 +msgid "trim out of date files." +msgstr "支持日志过期清理" + +#: src/introduction.md:20 +msgid "command line parser support." +msgstr "命令行解析" #: src/introduction.md:22 -msgid "### License" -msgstr "" +msgid "License" +msgstr "开源协议" #: src/introduction.md:24 msgid "" @@ -110,24 +121,16 @@ msgid "" msgstr "" #: src/platform/flutter.md:1 -msgid "### Flutter Usage" -msgstr "### Flutter 用例" +msgid "Flutter Usage" +msgstr "Flutter 用例" #: src/platform/flutter.md:3 -msgid "#### Add ezlog_flutter as a dependency in your pubspec.yaml file." -msgstr "#### 在pubspec.yaml中添加ezlog_flutter依赖" - -#: src/platform/flutter.md:5 -msgid "" -"```yaml\n" -"dependencies:\n" -" ezlog_flutter: ^0.2.0\n" -"```" -msgstr "" +msgid "Add ezlog_flutter as a dependency in your pubspec.yaml file." +msgstr "在pubspec.yaml中添加ezlog_flutter依赖" #: src/platform/flutter.md:10 src/platform/rust.md:12 -msgid "#### Example" -msgstr "#### 示例" +msgid "Example" +msgstr "示例" #: src/platform/flutter.md:12 msgid "" @@ -175,38 +178,17 @@ msgid "" msgstr "" #: src/platform/android.md:1 -msgid "### Android Usage" -msgstr "### Android用例" +msgid "Android Usage" +msgstr "Android用例" #: src/platform/android.md:3 -msgid "#### Add ezlog to dependencies" -msgstr "#### 添加ezlog依赖" +msgid "Add ezlog to dependencies" +msgstr "添加ezlog依赖" #: src/platform/android.md:5 msgid "Open top-level `build.gradle`, add `mavenCentral` to repositories." msgstr "打开项目`build.gradle`文件,添加`mavenCentral`仓库" -#: src/platform/android.md:7 -msgid "" -"```groovy\n" -"buildscript {\n" -" repositories {\n" -" ...\n" -" mavenCentral()\n" -" ...\n" -" }\n" -"}\n" -"\n" -"allprojects {\n" -" repositories {\n" -" ...\n" -" mavenCentral()\n" -" ...\n" -" }\n" -"}\n" -"```" -msgstr "" - #: src/platform/android.md:25 msgid "Open app level `build.gradle`, add `ezlog`" msgstr "在App层级的`build.gradle`添加ezlog依赖" @@ -225,8 +207,8 @@ msgid "Sync gradle" msgstr "同步gradle" #: src/platform/android.md:35 -msgid "#### Setup in application" -msgstr "#### 在应用中初始化" +msgid "Setup in application" +msgstr "在应用中初始化" #: src/platform/android.md:37 msgid "" @@ -273,38 +255,24 @@ msgid "" msgstr "" #: src/platform/ios.md:1 -msgid "### iOS Usage" -msgstr "### iOS用例" +msgid "iOS Usage" +msgstr "iOS用例" #: src/platform/ios.md:3 src/platform/rust.md:3 -msgid "#### Add ezlog" -msgstr "#### 添加ezlog依赖" +msgid "Add ezlog" +msgstr "添加ezlog依赖" #: src/platform/ios.md:5 msgid "Add dependency to Podfile" msgstr "在Podfile中添加依赖" -#: src/platform/ios.md:7 -msgid "" -"```shell\n" -"pod 'EZLog', '~> 0.1'\n" -"```" -msgstr "" - #: src/platform/ios.md:10 msgid "then" -msgstr "" - -#: src/platform/ios.md:12 -msgid "" -"```shell\n" -"pod update\n" -"```" -msgstr "" +msgstr "接下来" #: src/platform/ios.md:15 -msgid "#### Open Xcode, add sample code" -msgstr "#### 打开Xcode,添加示例代码" +msgid "Open Xcode, add sample code" +msgstr "打开Xcode,添加示例代码" #: src/platform/ios.md:17 msgid "" @@ -360,8 +328,8 @@ msgid "click run and see console ouput." msgstr "点击运行,查看控制台输出" #: src/platform/rust.md:1 -msgid "### Rust Usage" -msgstr "### Rust用例" +msgid "Rust Usage" +msgstr "Rust用例" #: src/platform/rust.md:5 msgid "Add this to your Cargo.toml" @@ -406,159 +374,237 @@ msgstr "" msgid "see more examples in examples dir." msgstr "在examples文件夹中查看更多示例" -#: src/benchmark.md:1 -msgid "## Benchmark" -msgstr "## 性能" - #: src/benchmark.md:3 -msgid "### Android Benchmark" -msgstr "### Android平台性能测试" +msgid "Android Benchmark" +msgstr "Android平台性能测试" #: src/benchmark.md:5 -msgid "#### measure log method" -msgstr "#### 单条日志格式" +msgid "measure log method" +msgstr "单条日志格式" #: src/benchmark.md:7 -msgid "" -"| Library | Time (ns) | Allocations |\n" -"|---------|-----------|-------------|\n" -"| logcat | 2,427 | 7 |\n" -"| logan | 4,726 | 14 |\n" -"| ezlog | 8,404 | 7 |\n" -"| xlog | 12,459 | 7 |" -msgstr "" -"| Library | Time (ns) | Allocations |\n" -"|---------|-----------|-------------|\n" -"| logcat | 2,427 | 7 |\n" -"| logan | 4,726 | 14 |\n" -"| ezlog | 8,404 | 7 |\n" -"| xlog | 12,459 | 7 |" +msgid "Library" +msgstr "" + +#: src/benchmark.md:7 +msgid "Time (ns)" +msgstr "" + +#: src/benchmark.md:7 +msgid "Allocations" +msgstr "" + +#: src/benchmark.md:9 +msgid "logcat" +msgstr "" + +#: src/benchmark.md:9 +msgid "2,427" +msgstr "" + +#: src/benchmark.md:9 src/benchmark.md:11 src/benchmark.md:12 +msgid "7" +msgstr "" + +#: src/benchmark.md:10 +msgid "logan" +msgstr "" + +#: src/benchmark.md:10 +msgid "4,726" +msgstr "" + +#: src/benchmark.md:10 +msgid "14" +msgstr "" + +#: src/benchmark.md:11 +msgid "8,404" +msgstr "" + +#: src/benchmark.md:12 +msgid "xlog" +msgstr "" + +#: src/benchmark.md:12 +msgid "12,459" +msgstr "" #: src/benchmark.md:14 -msgid "#### startup time" -msgstr "#### 启动时间" +msgid "startup time" +msgstr "启动时间" #: src/benchmark.md:16 msgid "startup baseline" msgstr "启动时间基线" -#: src/benchmark.md:17 -msgid "" -"```\n" -"min 206.4, median 218.5, max 251.9\n" -"```" -msgstr "" -"```\n" -"min 206.4, median 218.5, max 251.9\n" -"```" - #: src/benchmark.md:21 msgid "startup with ezlog time:" msgstr "启动时初始化ezlog" -#: src/benchmark.md:22 -msgid "" -"```\n" -"min 206.8, median 216.6, max 276.6\n" -"```" +#: src/architecture.md:3 +msgid "Code structure" +msgstr "代码结构" + +#: src/architecture.md:19 +msgid "Log file format" +msgstr "日志文件格式" + +#: src/architecture.md:21 +msgid "Header" +msgstr "文件头" + +#: src/architecture.md:23 +msgid "Bytes Offset" +msgstr "字节范围" + +#: src/architecture.md:23 +msgid "Meaning" +msgstr "内容" + +#: src/architecture.md:25 +msgid "0-1" msgstr "" -"```\n" -"min 206.8, median 216.6, max 276.6\n" -"```" -#: src/architecture.md:1 -msgid "## Architecture" -msgstr "## 架构设计" +#: src/architecture.md:25 +msgid "'ez'" +msgstr "固定字符" -#: src/architecture.md:3 -msgid "### Code structure" -msgstr "### 代码结构" +#: src/architecture.md:26 +msgid "2" +msgstr "" -#: src/architecture.md:5 -msgid "" -"```\n" -"├── android\n" -"│   ├── app # android demo app\n" -"│   └── lib-ezlog # ezlog android library\n" -"├── examples # Rust examples\n" -"├── ezlog_flutter # Flutter plugin\n" -"├── ezlogcli # Rust command line tool\n" -"├── ezlog-core # Rust core library\n" -"├── ios\n" -"│   ├── EZLog # ezlog iOS library\n" -"│   ├── demo # iOS demo app\n" -"│   └── framework # ezlog XCFramework\n" -"```" +#: src/architecture.md:26 +msgid "Version number" +msgstr "版本号" + +#: src/architecture.md:27 +msgid "3" msgstr "" -#: src/architecture.md:19 -msgid "### Log file format" -msgstr "### 日志文件格式" +#: src/architecture.md:27 +msgid "Flag bits" +msgstr "Flag位" -#: src/architecture.md:21 -msgid "#### Header " -msgstr "#### 文件头" +#: src/architecture.md:28 +msgid "4-7" +msgstr "" -#: src/architecture.md:23 -msgid "" -"| Bytes Offset | Meaning |\n" -"|--------|------------------------------------------|\n" -"| 0-1 | 'ez' |\n" -"| 2 | Version number |\n" -"| 3 | Flag bits |\n" -"| 4-7 | Offset of recorder position in bytes |\n" -"| 8-15 | Unix timestamp (big-endian) |\n" -"| 16 | Compression type |\n" -"| 17 | Encryption type |\n" -"| 18-21 | Encryption key hash |" -msgstr "" -"| 字节范围 | 内容 |\n" -"|--------|------------------------------------------|\n" -"| 0-1 | 'ez'固定字符 |\n" -"| 2 | 版本号 |\n" -"| 3 | Flag位 |\n" -"| 4-7 | 日志的当前下标 |\n" -"| 8-15 | Unix时间戳(大端) |\n" -"| 16 | 压缩算法 |\n" -"| 17 | 加密算法 |\n" -"| 18-21 | 密钥哈希 |" +#: src/architecture.md:28 +msgid "Offset of recorder position in bytes" +msgstr "日志的当前下标" + +#: src/architecture.md:29 +msgid "8-15" +msgstr "" + +#: src/architecture.md:29 +msgid "Unix timestamp (big-endian)" +msgstr "Unix时间戳(大端)" + +#: src/architecture.md:30 +msgid "16" +msgstr "" + +#: src/architecture.md:30 +msgid "Compression type" +msgstr "压缩算法" + +#: src/architecture.md:31 +msgid "17" +msgstr "" + +#: src/architecture.md:31 +msgid "Encryption type" +msgstr "加密算法" + +#: src/architecture.md:32 +msgid "18-21" +msgstr "" + +#: src/architecture.md:32 +msgid "Encryption key hash" +msgstr "密钥哈希" #: src/architecture.md:34 -msgid "#### Per log record" -msgstr "#### 单条日志格式" +msgid "Per log record" +msgstr "单条日志格式" #: src/architecture.md:36 -msgid "" -"| Byte Offset | Field Name| Description |\n" -"|----------|-----------|-----------------|\n" -"| 0| Start Byte| Always 0x3b indicating the start|\n" -"| 1-varint|Record Length| A variable-length integer that specifies the " -"length|\n" -"| varint+1-varint+n | Record Content | The actual log record content |\n" -"| varint+n+1| End Byte| Always 0x21 indicating the start |" -msgstr "" -"|字节范围 |字段名称 | 描述 |\n" -"|----------|-----------|-----------------|\n" -"| 0| 开始标记| 0x3b|\n" -"| 1-可变下标|日志长度| 描述日志内容长度的字节数|\n" -"| 可变下标+1-可变下标+日志长度 | 日志内容 | 日志内容|\n" -"| 可变下标+日志长度+1 | 结束标记 | 0x21|\n" +msgid "Byte Offset" +msgstr "字节范围" + +#: src/architecture.md:36 +msgid "Field Name" +msgstr "字段名称" + +#: src/architecture.md:36 +msgid "Description" +msgstr "描述" + +#: src/architecture.md:38 +msgid "0" +msgstr "" + +#: src/architecture.md:38 +msgid "Start Byte" +msgstr "开始标记" + +#: src/architecture.md:38 +msgid "Always 0x3b indicating the start" +msgstr "固定字符0x3b标记开始" + +#: src/architecture.md:39 +msgid "1-varint" +msgstr "1-可变下标" + +#: src/architecture.md:39 +msgid "Record Length" +msgstr "日志长度" + +#: src/architecture.md:39 +msgid "A variable-length integer that specifies the length" +msgstr "描述日志内容长度的字节数" + +#: src/architecture.md:40 +msgid "varint+1-varint+n" +msgstr "可变下标+1-可变下标+日志长度" + +#: src/architecture.md:40 +msgid "Record Content" +msgstr "日志内容" + +#: src/architecture.md:40 +msgid "The actual log record content" +msgstr "日志内容" + +#: src/architecture.md:41 +msgid "varint+n+1" +msgstr "可变下标+日志长度+1" + +#: src/architecture.md:41 +msgid "End Byte" +msgstr "结束标记" + +#: src/architecture.md:41 +msgid "Always 0x21 indicating the end" +msgstr "固定字符0x21表示结束" #: src/architecture.md:43 -msgid "### Compression" -msgstr "### 压缩算法" +msgid "Compression" +msgstr "压缩算法" #: src/architecture.md:45 msgid "We use zlib as the compression algorithm." msgstr "我们使用zlib作为默认压缩算法" #: src/architecture.md:47 -msgid "### Encryption" -msgstr "### 加密算法" +msgid "Encryption" +msgstr "加密算法" #: src/architecture.md:49 -msgid "#### We use AES-GCM-SIV as the encryption algorithm." -msgstr "#### 我们使用AES-GCM-SIV作为默认加密算法" +msgid "We use AES-GCM-SIV as the encryption algorithm." +msgstr "我们使用AES-GCM-SIV作为默认加密算法" #: src/architecture.md:51 msgid "" @@ -571,8 +617,8 @@ msgstr "" "特点。" #: src/architecture.md:53 -msgid "### Make nonce not repeat" -msgstr "### 确保 nonce 不重复" +msgid "Make nonce not repeat" +msgstr "确保 nonce 不重复" #: src/architecture.md:55 msgid "" @@ -585,21 +631,9 @@ msgstr "" "建时的时间戳。当我们写入日志记录时,我们知道当前日志文件的索引,并且我们可以" "使用以下公式计算当前日志记录的nonce:" -#: src/architecture.md:57 -msgid "" -"```\n" -"nonce = init_nonce ^ timestamp.extend(index)\n" -"\n" -"```" -msgstr "" - -#: src/build.md:1 -msgid "## Build" -msgstr "## 本地构建" - #: src/build.md:3 -msgid "- install and config rust" -msgstr "- 安装并配置 rust" +msgid "install and config rust" +msgstr "安装并配置 rust" #: src/build.md:5 msgid "" @@ -610,15 +644,8 @@ msgid "" msgstr "" #: src/build.md:10 -msgid "- use rust nightly" -msgstr "- 使用nightly版本的rust" - -#: src/build.md:12 -msgid "" -"```shell\n" -"rustup default nightly-2022-08-10\n" -"```" -msgstr "" +msgid "use rust nightly" +msgstr "使用nightly版本的rust" #: src/build.md:16 msgid "" @@ -628,130 +655,54 @@ msgstr "" "我们使用 [build-std](https://doc.rust-lang.org/nightly/cargo/reference/" "unstable.html#build-std) 特性,所以需要添加 nightly src 组件" -#: src/build.md:18 -msgid "" -"```shell\n" -"rustup component add rust-src --toolchain nightly-x86_64-apple-darwin\n" -"```" -msgstr "" - #: src/build.md:22 msgid "clone repository and open in command line tool. then run" msgstr "clone 仓库并在命令行工具中打开。然后运行" -#: src/build.md:24 -msgid "" -"```shell\n" -"cargo check\n" -"```" -msgstr "" - #: src/build.md:28 msgid "wait crates download..." msgstr "等待依赖下载..." -#: src/build.md:30 -msgid "" -"```shell\n" -"cargo build -p ezlog\n" -"```" -msgstr "" - #: src/build.md:34 -msgid "### for Flutter build" -msgstr "### Flutter 构建" - -#: src/build.md:36 -msgid "" -"```dart\n" -"flutter packages get\n" -"\n" -"flutter packages upgrade\n" -"```" -msgstr "" +msgid "for Flutter build" +msgstr "Flutter 构建" #: src/build.md:42 -msgid "### For android build" -msgstr "### Android 构建" +msgid "For android build" +msgstr "Android 构建" #: src/build.md:44 -msgid "- add android targets" -msgstr "- 添加 android targets" - -#: src/build.md:46 -msgid "" -"```shell\n" -"rustup target add aarch64-linux-android armv7-linux-androideabi i686-linux-" -"android x86_64-linux-android\n" -"```" -msgstr "" +msgid "add android targets" +msgstr "添加 android targets" #: src/build.md:50 msgid "we use `cargo-ndk` to build dylib" msgstr "我们使用 `cargo-ndk` 来构建 dylib" -#: src/build.md:52 -msgid "" -"```shell\n" -"cargo install cargo-ndk\n" -"```" -msgstr "" - #: src/build.md:56 msgid "cd android" msgstr "" -#: src/build.md:58 -msgid "" -"```shell\n" -"sh b_android.sh\n" -"```" -msgstr "" - #: src/build.md:62 msgid "then open current workspace in AndroidStudio" msgstr "然后在 AndroidStudio 中打开当前工作区" #: src/build.md:64 -msgid "### For iOS build" -msgstr "### iOS 构建" +msgid "For iOS build" +msgstr "iOS 构建" #: src/build.md:66 -msgid "- add iOS targets" -msgstr "- 添加 iOS targets" - -#: src/build.md:68 -msgid "" -"```shell\n" -"rustup target add aarch64-apple-ios aarch64-apple-ios-sim x86_64-apple-ios\n" -"```" -msgstr "" +msgid "add iOS targets" +msgstr "添加 iOS targets" #: src/build.md:73 msgid "install `cbindgen`" msgstr "安装 `cbindgen`" -#: src/build.md:75 -msgid "" -"```shell\n" -"cargo install --force cbindgen\n" -"```" -msgstr "" - #: src/build.md:79 msgid "cd ios dir" msgstr "" -#: src/build.md:81 -msgid "" -"```shell\n" -"sh b_ios.sh\n" -"```" -msgstr "" - #: src/build.md:85 msgid "open the `ios/EZlog.xcworkspace` in Xcode" msgstr "在 Xcode 中打开 `ios/EZlog.xcworkspace`" - -#~ msgid "Example" -#~ msgstr "示例" diff --git a/docs/src/architecture.md b/docs/src/architecture.md index 9abc234..81a5cd1 100644 --- a/docs/src/architecture.md +++ b/docs/src/architecture.md @@ -38,7 +38,7 @@ | 0| Start Byte| Always 0x3b indicating the start| | 1-varint|Record Length| A variable-length integer that specifies the length| | varint+1-varint+n | Record Content | The actual log record content | -| varint+n+1| End Byte| Always 0x21 indicating the start | +| varint+n+1| End Byte| Always 0x21 indicating the end | ### Compression diff --git a/docs/src/build.md b/docs/src/build.md index 7dd72b0..1c8fe4d 100644 --- a/docs/src/build.md +++ b/docs/src/build.md @@ -10,7 +10,7 @@ source $HOME/.cargo/env - use rust nightly ```shell -rustup default nightly-2022-08-10 +rustup default nightly ``` we use [build-std](https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#build-std) feature, so add nightly src component diff --git a/docs/theme/index.hbs b/docs/theme/index.hbs index cabafa6..cf217f3 100644 --- a/docs/theme/index.hbs +++ b/docs/theme/index.hbs @@ -1,33 +1,23 @@ - + {{ title }} {{#if is_print }} - + {{/if}} {{#if base_url}} {{/if}} - - - - {{> head}} - + {{#if favicon_svg}} @@ -63,7 +53,8 @@ {{/if}} - + +
+ + + + +
{{> header}} -