已合并
docs(Docs): complete README TOCs and symbols archive layout #3652
fangzhen创建于 13 天前
docs(Docs): complete README TOCs and symbols archive layout #3652
已合并
共 8 个文件变更+146-111
| @@ -6,16 +6,16 @@ This directory contains core guide documents for RNOH development, including fea | |||
| 6 | 6 | ||
| 7 | ## Document Navigation (Usage Order) | 7 | ## Document Navigation (Usage Order) |
| 8 | 8 | ||
| 9 | -| No. | Document/Directory | Description | Usage Scenario | | 9 | +| No. | Document/Directory | Description | Usage Scenario | |
| 10 | -|-----|--------------------|-------------| ----------------| | 10 | +| --- | ----------------------------------------------------------------------------------------- | ---------------------------------- | ------------------------------------------------ | |
| 11 | -| 1 | [Feature Development](./feature-development.md) | Basic feature development process | Reference when developing new features | | 11 | +| 1 | [Feature Development](./feature-development.md) | Basic feature development process | Reference when developing new features | |
| 12 | -| 2 | [Custom Components](./custom-components.md) | Custom component development guide | Developing custom components | | 12 | +| 2 | [Custom Components](./custom-components.md) | Custom component development guide | Developing custom components | |
| 13 | -| 3 | [Codegen](./Codegen.md) | Codegen code generation | Using Codegen to generate code | | 13 | +| 3 | [Codegen](./Codegen.md) | Codegen code generation | Using Codegen to generate code | |
| 14 | -| 4 | [TurboModule](./TurboModule.md) | TurboModule development | Developing TurboModule | | 14 | +| 4 | [TurboModule](./TurboModule.md) | TurboModule development | Developing TurboModule | |
| 15 | -| 5 | [Autolinking](./autolinking.md) | Auto-linking configuration | Configure third-party library auto-linking | | 15 | +| 5 | [Autolinking](./autolinking.md) | Auto-linking configuration | Configure third-party library auto-linking | |
| 16 | -| 6 | [RN-Native Integration](./rn-native-integration.md) | Native module integration | Integrating native modules | | 16 | +| 6 | [RN-Native Integration](./rn-native-integration.md) | Native module integration | Integrating native modules | |
| 17 | -| 7 | [Usage of C-API Component Hybrid Solution](./usage-of-c-api-component-hybrid-solution.md) | C-API component hybrid usage | Hybrid C-API component usage | | 17 | +| 7 | [Usage of C-API Component Hybrid Solution](./usage-of-c-api-component-hybrid-solution.md) | C-API component hybrid usage | Hybrid C-API component usage | |
| 18 | -| 8 | [Build Configuration](./build-configuration/) | Build and compilation guide | Debug/Release package usage, CMake configuration | | 18 | +| 8 | [Build Configuration](./build-configuration/) | Build and compilation guide | Debug/Release package usage, CMake configuration | |
| 19 | 19 | ||
| 20 | --- | 20 | --- |
| 21 | 21 | ||
| @@ -24,17 +24,17 @@ This directory contains core guide documents for RNOH development, including fea | |||
| 24 | ``` | 24 | ``` |
| 25 | 02-development-guide/ | 25 | 02-development-guide/ |
| 26 | │ | 26 | │ |
| 27 | -├── feature-development.md # Basic feature development | 27 | +├── feature-development.md # Basic feature development |
| 28 | -├── custom-components.md # Custom component development | 28 | +├── custom-components.md # Custom component development |
| 29 | ├── Codegen.md # Codegen usage | 29 | ├── Codegen.md # Codegen usage |
| 30 | ├── TurboModule.md # TurboModule development | 30 | ├── TurboModule.md # TurboModule development |
| 31 | ├── autolinking.md # Auto-linking | 31 | ├── autolinking.md # Auto-linking |
| 32 | ├── rn-native-integration.md # Native integration | 32 | ├── rn-native-integration.md # Native integration |
| 33 | ├── usage-of-c-api-component-hybrid-solution.md # C-API hybrid solution | 33 | ├── usage-of-c-api-component-hybrid-solution.md # C-API hybrid solution |
| 34 | │ | 34 | │ |
| 35 | -├── build-configuration/ # Build and compilation guide | 35 | +├── build-configuration/ # Build and compilation guide |
| 36 | │ ├── build-and-compilation-guide.md # Debug/Release package usage | 36 | │ ├── build-and-compilation-guide.md # Debug/Release package usage |
| 37 | -│ ├── RNOH Build and Symbol Management Guide.md # Symbol management | 37 | +│ └── RNOH Build and Symbol Management Guide.md # Symbol management |
G | |||
| 38 | │ | 38 | │ |
| 39 | └── README.md | 39 | └── README.md |
| 40 | ``` | 40 | ``` |
| @@ -45,10 +45,8 @@ This directory contains core guide documents for RNOH development, including fea | |||
| 45 | 45 | ||
| 46 | [Build Configuration](./build-configuration/) directory contains: | 46 | [Build Configuration](./build-configuration/) directory contains: |
| 47 | 47 | ||
| 48 | -- **Build and Compilation Guide**: How to obtain, configure and use Debug/Release packages | 48 | +- **Build and Compilation Guide**: How to obtain, configure and use Debug/Release packages, including CMakeLists.txt configuration details and DevEco Studio / command-line environment setup |
| 49 | -- **CMake Configuration Details**: CMakeLists.txt configuration examples | 49 | +- **RNOH Build and Symbol Management Guide**: Build mode comparison and Release package symbol file management |
| 50 | -- **Environment Configuration**: DevEco Studio and command line environment setup | ||
| 51 | -- **Symbol Management**: Release package symbol file management | ||
| 52 | 50 | ||
| 53 | --- | 51 | --- |
| 54 | 52 | ||
| @@ -56,4 +54,4 @@ This directory contains core guide documents for RNOH development, including fea | |||
| 56 | 54 | ||
| 57 | - [Environment and Tools](../01-environment-and-tools/) - Environment setup, SDK configuration | 55 | - [Environment and Tools](../01-environment-and-tools/) - Environment setup, SDK configuration |
| 58 | - [Scenarios and Practices](../03-scenarios-and-practices/) - Common development scenarios, best practices | 56 | - [Scenarios and Practices](../03-scenarios-and-practices/) - Common development scenarios, best practices |
| 59 | -- [Debugging Stage Docs](../../03-debugging/) - Debugging methods, issue diagnosis | 57 | +- [Debugging Stage Docs](../../03-debugging/) - Debugging methods, issue diagnosis |
| @@ -6,10 +6,10 @@ This directory contains community governance, contribution guides, and standards | |||
| 6 | 6 | ||
| 7 | ## Document Navigation | 7 | ## Document Navigation |
| 8 | 8 | ||
| 9 | -| No. | Document | Description | Usage Scenario | | 9 | +| No. | Document | Description | Usage Scenario | |
| 10 | -|-----|----------|-------------|----------------| | 10 | +| --- | ------------------------------------------------------------------------- | -------------------------------- | ------------------------------ | |
| 11 | -| 1 | [roadmap](./roadmap.md) | Community version roadmap | Understanding version planning | | 11 | +| 1 | [roadmap](./roadmap.md) | Community version roadmap | Understanding version planning | |
| 12 | -| 2 | [documentation-contribution-guide](./documentation-contribution-guide.md) | Documentation contribution guide | Contributing documentation | | 12 | +| 2 | [documentation-contribution-guide](./documentation-contribution-guide.md) | Documentation contribution guide | Contributing documentation | |
| 13 | 13 | ||
| 14 | --- | 14 | --- |
| 15 | 15 | ||
| @@ -17,7 +17,15 @@ This directory contains community governance, contribution guides, and standards | |||
| 17 | 17 | ||
| 18 | ``` | 18 | ``` |
| 19 | 06-community/ | 19 | 06-community/ |
| 20 | +│ | ||
| 21 | +├── roadmap.md # Community version roadmap | ||
| 22 | +├── documentation-contribution-guide.md # Documentation contribution guide | ||
| 23 | +│ | ||
| 24 | +└── README.md | ||
| 25 | +``` | ||
| 20 | 26 | ||
| 21 | -... | 27 | +--- |
| 22 | 28 | ||
| 23 | -- [Operations Stage Docs](../05-operations/) - Version management | 29 | +## Related Documents |
| 30 | + | ||
| 31 | +- [Operations Stage Docs](../05-operations/) - Version management | ||
| @@ -39,6 +39,7 @@ docs/en/ | |||
| 39 | │ │ ├── SDK version configuration guide.md # SDK version selection | 39 | │ │ ├── SDK version configuration guide.md # SDK version selection |
| 40 | │ │ └── samples-guide.md # Sample project list | 40 | │ │ └── samples-guide.md # Sample project list |
| 41 | │ ├── 02-development-guide/ # Development Guide | 41 | │ ├── 02-development-guide/ # Development Guide |
| 42 | +│ │ ├── README.md # Development Guide navigation | ||
| 42 | │ │ ├── feature-development.md # Development process guide | 43 | │ │ ├── feature-development.md # Development process guide |
| 43 | │ │ ├── custom-components.md # Component development | 44 | │ │ ├── custom-components.md # Component development |
| 44 | │ │ ├── Codegen.md # Code generation tool | 45 | │ │ ├── Codegen.md # Code generation tool |
| @@ -68,6 +69,7 @@ docs/en/ | |||
| 68 | │ | 69 | │ |
| 69 | ├── 04-optimization/ # Optimization Stage | 70 | ├── 04-optimization/ # Optimization Stage |
| 70 | │ ├── performance-optimization.md | 71 | │ ├── performance-optimization.md |
| 72 | +│ ├── memory-optimization-guide.md | ||
| 71 | │ ├── application-performance-optimization.md | 73 | │ ├── application-performance-optimization.md |
| 72 | │ ├── performance-optimization-practice/ | 74 | │ ├── performance-optimization-practice/ |
| 73 | │ │ └── page-transition-and-sliding-optimization.md | 75 | │ │ └── page-transition-and-sliding-optimization.md |
| @@ -83,10 +85,9 @@ docs/en/ | |||
| 83 | │ ├── AI-assisted-issue-diagnosis-guide.md # AI diagnosis | 85 | │ ├── AI-assisted-issue-diagnosis-guide.md # AI diagnosis |
| 84 | │ ├── release-notes/ # Detailed release notes | 86 | │ ├── release-notes/ # Detailed release notes |
| 85 | │ │ └── react-native-harmony-v0.86.1.md | 87 | │ │ └── react-native-harmony-v0.86.1.md |
| 86 | -│ ├── build-configuration/ | ||
| 87 | │ ├── stability-coding-standards/ # Stability coding standards | 88 | │ ├── stability-coding-standards/ # Stability coding standards |
| 88 | │ │ └── stability-coding-standards.md | 89 | │ │ └── stability-coding-standards.md |
| 89 | -│ ├── stability-skill/ # Stability analysis tools | 90 | +│ ├── stability-skill/ # Stability analysis tools *(Chinese version only - English version to be added)* |
| 90 | │ │ ├── rnoh-stability-review/ | 91 | │ │ ├── rnoh-stability-review/ |
| 91 | │ │ └── rnoh-stability-triage/ | 92 | │ │ └── rnoh-stability-triage/ |
| 92 | │ ├── stability-overview/ # Stability issue overview | 93 | │ ├── stability-overview/ # Stability issue overview |
| @@ -98,7 +99,6 @@ docs/en/ | |||
| 98 | ├── 06-community/ # Community Governance | 99 | ├── 06-community/ # Community Governance |
| 99 | │ ├── documentation-contribution-guide.md # Documentation contribution | 100 | │ ├── documentation-contribution-guide.md # Documentation contribution |
| 100 | │ ├── roadmap.md # Community roadmap | 101 | │ ├── roadmap.md # Community roadmap |
| 101 | -│ ├── community-guidelines/ | ||
| 102 | │ └── README.md | 102 | │ └── README.md |
| 103 | │ | 103 | │ |
| 104 | ├── figures/ # Image resources | 104 | ├── figures/ # Image resources |
| @@ -6,16 +6,16 @@ | |||
| 6 | 6 | ||
| 7 | ## 文档导航(按使用顺序) | 7 | ## 文档导航(按使用顺序) |
| 8 | 8 | ||
| 9 | -| 序号 | 文档/目录 | 说明 | 使用场景 | | 9 | +| 序号 | 文档/目录 | 说明 | 使用场景 | |
| 10 | -|------|-----------|------|----------| | 10 | +| ---- | ------------------------------------------------------- | ------------------ | -------------------------------- | |
| 11 | -| 1 | [功能开发](./功能开发.md) | 基础功能开发流程 | 开发新功能时参考 | | 11 | +| 1 | [功能开发](./功能开发.md) | 基础功能开发流程 | 开发新功能时参考 | |
| 12 | -| 2 | [自定义组件](./自定义组件.md) | 自定义组件开发指南 | 开发自定义组件 | | 12 | +| 2 | [自定义组件](./自定义组件.md) | 自定义组件开发指南 | 开发自定义组件 | |
| 13 | -| 3 | [Codegen](./Codegen.md) | Codegen 代码生成 | 使用 Codegen 生成代码 | | 13 | +| 3 | [Codegen](./Codegen.md) | Codegen 代码生成 | 使用 Codegen 生成代码 | |
| 14 | -| 4 | [TurboModule](./TurboModule.md) | TurboModule 开发 | 开发 TurboModule | | 14 | +| 4 | [TurboModule](./TurboModule.md) | TurboModule 开发 | 开发 TurboModule | |
| 15 | -| 5 | [Autolinking](./Autolinking.md) | 自动链接配置 | 配置第三方库自动链接 | | 15 | +| 5 | [Autolinking](./Autolinking.md) | 自动链接配置 | 配置第三方库自动链接 | |
| 16 | -| 6 | [RN-Native接入](./RN-Native接入.md) | Native 模块接入 | 接入原生模块 | | 16 | +| 6 | [RN-Native接入](./RN-Native接入.md) | Native 模块接入 | 接入原生模块 | |
| 17 | -| 7 | [C-API组件混合方案的使用](./C-API组件混合方案的使用.md) | C-API 组件混合 | 混合使用 C-API 组件 | | 17 | +| 7 | [C-API组件混合方案的使用](./C-API组件混合方案的使用.md) | C-API 组件混合 | 混合使用 C-API 组件 | |
| 18 | -| 8 | [编译构建](./编译构建/) | 编译构建指南 | Debug/Release 包使用、CMake 配置 | | 18 | +| 8 | [编译构建](./编译构建/) | 编译构建指南 | Debug/Release 包使用、CMake 配置 | |
| 19 | 19 | ||
| 20 | --- | 20 | --- |
| 21 | 21 | ||
| @@ -33,7 +33,8 @@ | |||
| 33 | ├── C-API组件混合方案的使用.md # C-API 混合方案 | 33 | ├── C-API组件混合方案的使用.md # C-API 混合方案 |
| 34 | │ | 34 | │ |
| 35 | ├── 编译构建/ # 编译构建指南 | 35 | ├── 编译构建/ # 编译构建指南 |
| 36 | -│ ├── 编译构建指南.md # Debug/Release 包使用 | 36 | +│ ├── 编译构建指南.md # Debug/Release 包使用、CMake 配置、环境配置 |
| 37 | +│ ├── RNOH包使用指南.md # RNOH 包切换使用与版本升级 | ||
| 37 | │ └── RNOH 构建与符号管理工程级指南.md # 符号管理 | 38 | │ └── RNOH 构建与符号管理工程级指南.md # 符号管理 |
| 38 | │ | 39 | │ |
| 39 | └── README.md | 40 | └── README.md |
| @@ -45,10 +46,9 @@ | |||
| 45 | 46 | ||
| 46 | [编译构建](./编译构建/) 目录包含: | 47 | [编译构建](./编译构建/) 目录包含: |
| 47 | 48 | ||
| 48 | -- **编译构建指南**:Debug/Release 包的获取、配置和使用方法 | 49 | +- **编译构建指南**:Debug/Release 包的获取、配置和使用方法,以及 CMakeLists.txt 配置详解、DevEco Studio 和命令行环境配置 |
| 49 | -- **CMake 配置详解**:CMakeLists.txt 配置示例 | 50 | +- **RNOH包使用指南**:Debug/Release 包的切换使用、CMake 配置差异对照、版本升级与常见问题排查 |
| 50 | -- **环境配置**:DevEco Studio 和命令行环境配置 | 51 | +- **RNOH 构建与符号管理工程级指南**:构建模式对比与 Release 包符号文件管理 |
| 51 | -- **符号管理**:Release 包的符号文件管理 | ||
| 52 | 52 | ||
| 53 | --- | 53 | --- |
| 54 | 54 | ||
| @@ -56,4 +56,4 @@ | |||
| 56 | 56 | ||
| 57 | - [环境与工具](../01-环境与工具/) - 环境搭建、SDK 配置 | 57 | - [环境与工具](../01-环境与工具/) - 环境搭建、SDK 配置 |
| 58 | - [场景与实践](../03-场景与实践/) - 常见开发场景、最佳实践 | 58 | - [场景与实践](../03-场景与实践/) - 常见开发场景、最佳实践 |
| 59 | -- [调测阶段文档](../../03-调测/) - 调试方法、问题定位 | 59 | +- [调测阶段文档](../../03-调测/) - 调试方法、问题定位 |
| @@ -25,6 +25,7 @@ | |||
| 25 | │ └── 示例工程索引.md # 示例工程快速入口 | 25 | │ └── 示例工程索引.md # 示例工程快速入口 |
| 26 | │ | 26 | │ |
| 27 | ├── 02-开发指南/ # 开发过程中的核心指南 | 27 | ├── 02-开发指南/ # 开发过程中的核心指南 |
| 28 | +│ ├── README.md # 本目录导航 | ||
| 28 | │ ├── 功能开发.md # 开发流程总览 | 29 | │ ├── 功能开发.md # 开发流程总览 |
| 29 | │ ├── 自定义组件.md # 组件开发指南 | 30 | │ ├── 自定义组件.md # 组件开发指南 |
| 30 | │ ├── Codegen.md # 代码生成工具 | 31 | │ ├── Codegen.md # 代码生成工具 |
| @@ -34,6 +35,7 @@ | |||
| 34 | │ ├── C-API组件混合方案的使用.md | 35 | │ ├── C-API组件混合方案的使用.md |
| 35 | │ └── 编译构建/ # Debug/Release包、CMake配置 ⚡版本相关 | 36 | │ └── 编译构建/ # Debug/Release包、CMake配置 ⚡版本相关 |
| 36 | │ ├── 编译构建指南.md | 37 | │ ├── 编译构建指南.md |
| 38 | +│ ├── RNOH包使用指南.md | ||
| 37 | │ └── RNOH 构建与符号管理工程级指南.md | 39 | │ └── RNOH 构建与符号管理工程级指南.md |
| 38 | │ | 40 | │ |
| 39 | ├── 03-场景与实践/ # 场景化开发参考 | 41 | ├── 03-场景与实践/ # 场景化开发参考 |
| @@ -6,11 +6,11 @@ | |||
| 6 | 6 | ||
| 7 | ## 文档导航 | 7 | ## 文档导航 |
| 8 | 8 | ||
| 9 | -| 序号 | 文档 | 说明 | 使用场景 | | 9 | +| 序号 | 文档 | 说明 | 使用场景 | |
| 10 | -|------|------|------|----------| | 10 | +| ---- | --------------------------------------------- | -------------- | ------------ | |
| 11 | -| 1 | [Roadmap](./roadmap.md) | 社区版本路线图 | 了解版本规划 | | 11 | +| 1 | [Roadmap](./roadmap.md) | 社区版本路线图 | 了解版本规划 | |
| 12 | -| 2 | [开发者文档共建指南](./开发者文档共建指南.md) | 文档共建规范 | 参与文档共建 | | 12 | +| 2 | [开发者文档共建指南](./开发者文档共建指南.md) | 文档共建规范 | 参与文档共建 | |
| 13 | -| 3 | [社区规范](./社区规范/) | 社区各类规范 | 参与社区贡献 | | 13 | +| 3 | [社区规范](./社区规范/) | 社区各类规范 | 参与社区贡献 | |
| 14 | 14 | ||
| 15 | --- | 15 | --- |
| 16 | 16 | ||
| @@ -18,7 +18,23 @@ | |||
| 18 | 18 | ||
| 19 | ``` | 19 | ``` |
| 20 | 06-社区/ | 20 | 06-社区/ |
| 21 | +│ | ||
| 22 | +├── roadmap.md # 社区版本路线图 | ||
| 23 | +├── 开发者文档共建指南.md # 文档共建规范 | ||
| 24 | +├── 社区规范/ # 社区规范目录 | ||
| 25 | +│ ├── rnoh包管理规范.md # RNOH 包管理规范 | ||
| 26 | +│ ├── 仓库分支管理规范.md # 仓库与分支管理规范 | ||
| 27 | +│ ├── 开发者共建指南.md # 开发者共建流程 | ||
| 28 | +│ ├── 社区changelog规范.md # changelog 提交规范 | ||
| 29 | +│ ├── 社区commit和pr规范.md # commit / PR 提交规范 | ||
| 30 | +│ ├── 社区issue管理规范.md # issue 管理规范 | ||
| 31 | +│ └── 社区符号表归档规范.md # 符号表归档规范 | ||
| 32 | +│ | ||
| 33 | +└── README.md # 本文件 | ||
| 34 | +``` | ||
| 21 | 35 | ||
| 22 | -... | 36 | +--- |
| 23 | 37 | ||
| 24 | -- [运维阶段文档](../05-运维/) - 版本管理 | 38 | +## 相关文档 |
| 39 | + | ||
| 40 | +- [运维阶段文档](../05-运维/) - 版本管理 | ||
| @@ -1,11 +1,11 @@ | |||
| 1 | # 社区符号表归档规范 | 1 | # 社区符号表归档规范 |
| 2 | 2 | ||
| 3 | -| 项目 | 说明 | | 3 | +| 项目 | 说明 | |
| 4 | -|------|------| | 4 | +| ------------ | ---------------------------------------------------------------------- | |
| 5 | -| **适用范围** | RNOH 各版本线(0.72 / 0.77 / 0.82 / 0.84 / 0.86 …)的正式发布与预发布 | | 5 | +| **适用范围** | RNOH 各版本线(0.72 / 0.77 / 0.82 / 0.84 / 0.86 …)的正式发布与预发布 | |
| 6 | -| **归档对象** | Release HAR 内自研与预编译 `.so` 对应的符号文件(`.sym`) | | 6 | +| **归档对象** | Release HAR 内自研与预编译 `.so` 对应的符号文件(`.sym`) | |
| 7 | -| **归档位置** | GitCode RNOH 主仓库对应版本 Release 页面(附件 + 正文符号链接表) | | 7 | +| **归档位置** | GitCode RNOH 主仓库对应版本 Release 页面(附件 + 正文符号链接表) | |
| 8 | -| **匹配键** | ELF BuildID | | 8 | +| **匹配键** | ELF BuildID | |
| 9 | | **核心目标** | 任意历史版本的线上崩溃均可符号化;符号与发布物一一对应、可校验、不可变 | | 9 | | **核心目标** | 任意历史版本的线上崩溃均可符号化;符号与发布物一一对应、可校验、不可变 | |
| 10 | 10 | ||
| 11 | ## 目录 | 11 | ## 目录 |
| @@ -38,22 +38,22 @@ | |||
| 38 | 38 | ||
| 39 | ### 1. 归档清单 | 39 | ### 1. 归档清单 |
| 40 | 40 | ||
| 41 | -| 模块 | 归属 | 当前符号状态 | | 41 | +| 模块 | 归属 | 当前符号状态 | |
| 42 | -|------|------|--------------| | 42 | +| ------------------------- | ------------------------------------------------- | ------------ | |
| 43 | -| `librnoh_core.so` | RNOH 平台引擎 | ✅ 已产出 | | 43 | +| `librnoh_core.so` | RNOH 平台引擎 | ✅ 已产出 | |
| 44 | -| `librnoh_core_package.so` | RNOH 框架核心包 | ✅ 已产出 | | 44 | +| `librnoh_core_package.so` | RNOH 框架核心包 | ✅ 已产出 | |
| 45 | -| `libreactnative.so` | 上游 ReactCommon 编译产物 | ✅ 已产出 | | 45 | +| `libreactnative.so` | 上游 ReactCommon 编译产物 | ✅ 已产出 | |
| 46 | -| `libjsvmtooling.so` | ArkJS 调试胶水 | ✅ 已产出 | | 46 | +| `libjsvmtooling.so` | ArkJS 调试胶水 | ✅ 已产出 | |
| 47 | -| `libhermesvm.so` | Hermes V1 预编译(版本由 `build-hermes.sh` 钉死) | ✅ 已产出 | | 47 | +| `libhermesvm.so` | Hermes V1 预编译(版本由 `build-hermes.sh` 钉死) | ✅ 已产出 | |
| 48 | -| `libhermestooling.so` | Hermes 引擎胶水 | ✅ 已产出 | | 48 | +| `libhermestooling.so` | Hermes 引擎胶水 | ✅ 已产出 | |
| 49 | -| `libjsi.so` | ReactCommon/jsi | ✅ 已产出 | | 49 | +| `libjsi.so` | ReactCommon/jsi | ✅ 已产出 | |
| 50 | 50 | ||
| 51 | ### 2. 分类维度:构建配置 | 51 | ### 2. 分类维度:构建配置 |
| 52 | 52 | ||
| 53 | -| 归档包 | 覆盖产物 | 状态 | | 53 | +| 归档包 | 覆盖产物 | 状态 | |
| 54 | -|--------|---------|------| | 54 | +| --------- | --------------------------------------------------------------------------------- | ---------------------- | |
| 55 | -| `release` | `react_native_openharmony_release.har` 与 `react_native_openharmony_release2.har` | **强制** | | 55 | +| `release` | `react_native_openharmony_release.har` 与 `react_native_openharmony_release2.har` | **强制** | |
| 56 | -| `debug` | `react_native_openharmony.har`(源码 HAR) | **不归档**(长期决策) | | 56 | +| `debug` | `react_native_openharmony.har`(源码 HAR) | **不归档**(长期决策) | |
| 57 | 57 | ||
| 58 | **debug 不归档规则**:`react_native_openharmony.har` 是源码 HAR,native 代码由使用方工程自行编译,产物 BuildID 与 RNOH 流水线构建必然不同,流水线侧归档的 debug 符号永远无法匹配;包内唯一的预编译产物 `libhermesvm.so`,其 `.sym` 已随包内置,符号自包含。 | 58 | **debug 不归档规则**:`react_native_openharmony.har` 是源码 HAR,native 代码由使用方工程自行编译,产物 BuildID 与 RNOH 流水线构建必然不同,流水线侧归档的 debug 符号永远无法匹配;包内唯一的预编译产物 `libhermesvm.so`,其 `.sym` 已随包内置,符号自包含。 |
| 59 | 59 | ||
| @@ -61,12 +61,12 @@ | |||
| 61 | 61 | ||
| 62 | ### 3. 不归档清单 | 62 | ### 3. 不归档清单 |
| 63 | 63 | ||
| 64 | -| 类别 | 示例 | 原因 | | 64 | +| 类别 | 示例 | 原因 | |
| 65 | -|------|------|------| | 65 | +| -------------- | ----------------------------------- | ------------------------------------------------------------------------- | |
| 66 | -| 工具链运行时 | `libc++_shared.so` | 随 SDK 提供 | | 66 | +| 工具链运行时 | `libc++_shared.so` | 随 SDK 提供 | |
| 67 | -| 系统 / NDK 库 | `libjsvm.so`、`libace_napi.z.so` 等 | 随设备或 SDK 提供,获取方式见[七、符号使用指引](#七符号使用指引)第 2 节 | | 67 | +| 系统 / NDK 库 | `libjsvm.so`、`libace_napi.z.so` 等 | 随设备或 SDK 提供,获取方式见[七、符号使用指引](#七符号使用指引)第 2 节 | |
| 68 | -| ArkTS 字节码 | `modules.abc`(release2 HAR 内) | 非 native 符号范畴;如未来需行号级反解,属构建期 sourcemap 机制,另立规范 | | 68 | +| ArkTS 字节码 | `modules.abc`(release2 HAR 内) | 非 native 符号范畴;如未来需行号级反解,属构建期 sourcemap 机制,另立规范 | |
| 69 | -| 应用 JS bundle | `hermes_bundle.hbc` | 应用开发者自有产物,不随 RNOH 发布 | | 69 | +| 应用 JS bundle | `hermes_bundle.hbc` | 应用开发者自有产物,不随 RNOH 发布 | |
| 70 | 70 | ||
| 71 | --- | 71 | --- |
| 72 | 72 | ||
| @@ -78,7 +78,7 @@ | |||
| 78 | rnoh-symbols-[RNOH版本号]-[构建配置].tar.gz | 78 | rnoh-symbols-[RNOH版本号]-[构建配置].tar.gz |
| 79 | ``` | 79 | ``` |
| 80 | 80 | ||
| 81 | -- 版本号取 `packages/react-native-harmony/package.json` 的 `version`,与 HAR 同版本; | 81 | +- 版本号取 `packages/react-native-harmony/package.json` 的 `version`,与 HAR 同版本。 |
| 82 | - 构建配置取值:`release`(唯一归档配置,debug 源码包不归档)。 | 82 | - 构建配置取值:`release`(唯一归档配置,debug 源码包不归档)。 |
| 83 | 83 | ||
| 84 | 示例: | 84 | 示例: |
| @@ -93,19 +93,21 @@ rnoh-symbols-0.86.1-release.tar.gz | |||
| 93 | 93 | ||
| 94 | ```text | 94 | ```text |
| 95 | rnoh-symbols-0.86.1-release.tar.gz | 95 | rnoh-symbols-0.86.1-release.tar.gz |
| 96 | +├── libhermestooling.so.sym | ||
| 96 | ├── libhermesvm.so.sym | 97 | ├── libhermesvm.so.sym |
| 98 | +├── libjsi.so.sym | ||
| 99 | +├── libjsvmtooling.so.sym | ||
| 97 | ├── libreactnative.so.sym | 100 | ├── libreactnative.so.sym |
| 98 | ├── librnoh_core.so.sym | 101 | ├── librnoh_core.so.sym |
| 99 | -├── librnoh_core_package.so.sym | 102 | +└── librnoh_core_package.so.sym |
| 100 | -└── libjsvmtooling.so.sym | ||
| 101 | ``` | 103 | ``` |
| 102 | 104 | ||
| 103 | ### 3. libhermesvm.so 特殊规则 | 105 | ### 3. libhermesvm.so 特殊规则 |
| 104 | 106 | ||
| 105 | -| 配置 | 是否归档 | 理由 | | 107 | +| 配置 | 是否归档 | 理由 | |
| 106 | -|------|---------|------| | 108 | +| ---------- | ---------- | --------------------------------------------------------------------------- | |
| 107 | -| release 包 | **归档** | HAR 内已剥离调试符号,`.sym` 是 hermes 内部崩溃帧符号化的唯一来源,且体积小 | | 109 | +| release 包 | **归档** | HAR 内已剥离调试符号,`.sym` 是 hermes 内部崩溃帧符号化的唯一来源,且体积小 | |
| 108 | -| debug 包 | **不归档** | 源码 HAR 内部已自带 `.sym`(随 `third-party/prebuilt/` 打包),归档属纯重复 | | 110 | +| debug 包 | **不归档** | 源码 HAR 内部已自带 `.sym`(随 `third-party/prebuilt/` 打包),归档属纯重复 | |
| 109 | 111 | ||
| 110 | > `libhermesvm.so` 的 `.sym` 必须继续产出:它是 `build-hermes.sh` 剥离符号的必然伴随产物,不产出即等于永久丢失符号。 | 112 | > `libhermesvm.so` 的 `.sym` 必须继续产出:它是 `build-hermes.sh` 剥离符号的必然伴随产物,不产出即等于永久丢失符号。 |
| 111 | 113 | ||
| @@ -122,17 +124,21 @@ RNOH Symbols: | |||
| 122 | 124 | ||
| 123 | | 模块 | BuildID | | 125 | | 模块 | BuildID | |
| 124 | |------|---------| | 126 | |------|---------| |
| 125 | -| librnoh_core.so | 804e3c45b58b68be9f9074d5e17d25942c84b599 | | 127 | +| libhermestooling.so | 0426452f9714d449fef5df1d8c9d647aa3418fb9 | |
| 126 | -| librnoh_core_package.so | 9b84552734abe30a1c5c459af92e4c0b86b4009e | | ||
| 127 | -| libreactnative.so | 8fa7aec0e244e143385e971f5cca9900abaa966b | | ||
| 128 | -| libjsvmtooling.so | e70c9fa8c0ae8821e584d8e060db33cef34974ad | | ||
| 129 | | libhermesvm.so | c09dd5a82a16e41f1cb5a9c3abc42925286cf48e | | 128 | | libhermesvm.so | c09dd5a82a16e41f1cb5a9c3abc42925286cf48e | |
| 129 | +| libjsi.so | 1ee871fa7f3cc9f370faafb1a8d604569142955b | | ||
| 130 | +| libjsvmtooling.so | b147bae673b816363f85aa992dccbe7acf1b807f | | ||
| 131 | +| libreactnative.so | 690f4aa51053e41bb7ab308316124637fc315e94 | | ||
| 132 | +| librnoh_core.so | 51daea39d125a3934d8d704e548bdc50b3371015 | | ||
| 133 | +| librnoh_core_package.so | 12f2fa2cc882a7e9a6c9548d9dcfdc3596648723 | | ||
| 134 | + | ||
| 135 | +> Hermes: 250829098.0.17 / 3477757eb2475555cf8d8df24bfb1deb0613880d(for RN 0.86.3,RNOH 独立编译,BuildID 与上游不同,不可用上游符号替代) | ||
| 130 | ``` | 136 | ``` |
| 131 | 137 | ||
| 132 | **说明**: | 138 | **说明**: |
| 133 | 139 | ||
| 134 | -1. BuildID 内嵌于每个 `.sym` 文件(`.note.gnu.build-id` 段),**无需单独归档**,正文表格仅为下载前核对的便利项; | 140 | +1. BuildID 表须覆盖[归档清单](#1-归档清单)全部模块;数值取自每个 `.sym` 的 `.note.gnu.build-id` 段,**无需单独归档**。每次构建 BuildID 会变,发版以当次 `release-notes-symbols.md` 为准。 |
| 135 | -2. Hermes 版本与 commit 须随表标注,用于追溯;RNOH 独立编译 Hermes,BuildID 与上游不同,**不可**用上游符号替代。 | 141 | +2. Hermes 版本与 commit 由同一脚本从 `build-hermes.sh` 读取并随表标注,用于追溯;RNOH 独立编译 Hermes,BuildID 与上游不同,**不可**用上游符号替代。 |
| 136 | 142 | ||
| 137 | --- | 143 | --- |
| 138 | 144 | ||
| @@ -146,13 +152,13 @@ RNOH Symbols: | |||
| 146 | 152 | ||
| 147 | ## 六、发布前校验清单 | 153 | ## 六、发布前校验清单 |
| 148 | 154 | ||
| 149 | -| # | 校验项 | 方法 | 说明 | | 155 | +| # | 校验项 | 方法 | 说明 | |
| 150 | -|---|--------|------|------| | 156 | +| --- | ------------------- | ------------------------------------------- | ------------------------------------------------------------------------ | |
| 151 | -| 1 | 符号完整性 | 对比 HAR `libs/` 与归档包清单 | HAR 内每个自研/预编译 `.so` 均有 `.sym`(`libc++_shared.so` 白名单除外) | | 157 | +| 1 | 符号完整性 | 对比 HAR `libs/` 与归档包清单 | HAR 内每个自研/预编译 `.so` 均有 `.sym`(`libc++_shared.so` 白名单除外) | |
| 152 | -| 2 | BuildID 一致 | `llvm-readelf -n <so>` 逐库比对 | HAR 内 `.so` 与 `.sym` 的 BuildID 一致 | | 158 | +| 2 | BuildID 一致 | `llvm-readelf -n <so>` 逐库比对 | HAR 内 `.so` 与 `.sym` 的 BuildID 一致 | |
| 153 | -| 3 | 符号可用性 | `llvm-addr2line -e <sym> -f -C <地址>` 抽查 | 能解出函数名与行号 | | 159 | +| 3 | 符号可用性 | `llvm-addr2line -e <sym> -f -C <地址>` 抽查 | 能解出函数名与行号 | |
| 154 | -| 4 | 符号形态 | `llvm-readelf -S <sym>` | `.text` 为 NOBITS(only-keep-debug 型,不可执行) | | 160 | +| 4 | 符号形态 | `llvm-readelf -S <sym>` | `.text` 为 NOBITS(only-keep-debug 型,不可执行) | |
| 155 | -| 5 | release2 合并合法性 | 与 release 的 `.sym` 逐文件 MD5 比对 | 一致方可声明覆盖;不一致必须分开归档 | | 161 | +| 5 | release2 合并合法性 | 与 release 的 `.sym` 逐文件 MD5 比对 | 一致方可声明覆盖;不一致必须分开归档 | |
| 156 | 162 | ||
| 157 | --- | 163 | --- |
| 158 | 164 | ||
| @@ -171,10 +177,10 @@ llvm-addr2line -e librnoh_core.so.sym -f -C 0x12345 | |||
| 171 | 177 | ||
| 172 | ### 2. 系统 / NDK 库帧(不在归档范围) | 178 | ### 2. 系统 / NDK 库帧(不在归档范围) |
| 173 | 179 | ||
| 174 | -| 需求 | 做法 | | 180 | +| 需求 | 做法 | |
| 175 | -|------|------| | 181 | +| -------- | ---------------------------------------------------------------------------------------- | |
| 176 | -| 函数名 | **无需符号文件**:faultloggerd 已在设备侧解析,cppcrash 日志的系统帧自带函数名与 BuildID | | 182 | +| 函数名 | **无需符号文件**:faultloggerd 已在设备侧解析,cppcrash 日志的系统帧自带函数名与 BuildID | |
| 177 | -| 深入分析 | `hdc file recv` 拉取设备库后提取 MiniDebugInfo(仅函数名,无行号): | | 183 | +| 深入分析 | `hdc file recv` 拉取设备库后提取 MiniDebugInfo(仅函数名,无行号): | |
| 178 | 184 | ||
| 179 | ```bash | 185 | ```bash |
| 180 | hdc file recv /system/lib64/platformsdk/libace_napi.z.so . | 186 | hdc file recv /system/lib64/platformsdk/libace_napi.z.so . |
| @@ -183,8 +189,8 @@ xz -dc mini.xz > mini.elf | |||
| 183 | llvm-addr2line -e mini.elf -f -C 0x<偏移> # 行号显示 ??:0 属正常 | 189 | llvm-addr2line -e mini.elf -f -C 0x<偏移> # 行号显示 ??:0 属正常 |
| 184 | ``` | 190 | ``` |
| 185 | 191 | ||
| 186 | -| 禁止 | 原因 | | 192 | +| 禁止 | 原因 | |
| 187 | -|------|------| | 193 | +| ----------------------------------------- | ------------------------------------------------ | |
| 188 | | ❌ 用 SDK sysroot 的 `.so` 符号化设备崩溃 | SDK 与设备是两批构建,BuildID 不同,仅供链接使用 | | 194 | | ❌ 用 SDK sysroot 的 `.so` 符号化设备崩溃 | SDK 与设备是两批构建,BuildID 不同,仅供链接使用 | |
| 189 | 195 | ||
| 190 | --- | 196 | --- |
| @@ -202,9 +208,9 @@ llvm-addr2line -e mini.elf -f -C 0x<偏移> # 行号显示 ??:0 属正常 | |||
| 202 | 208 | ||
| 203 | ## 九、总结 | 209 | ## 九、总结 |
| 204 | 210 | ||
| 205 | -| 要点 | 内容 | | 211 | +| 要点 | 内容 | |
| 206 | -|------|------| | 212 | +| ------------ | ------------------------------------------------------------------------------------------------- | |
| 207 | -| **归档位置** | GitCode Release 页面附件 + 正文链接表(对齐上游形态) | | 213 | +| **归档位置** | GitCode Release 页面附件 + 正文链接表(对齐上游形态) | |
| 208 | | **归档分类** | 仅 `release`(强制归档);`debug` 为源码包不归档(自行编译、符号自包含);release2 一致时合并声明 | | 214 | | **归档分类** | 仅 `release`(强制归档);`debug` 为源码包不归档(自行编译、符号自包含);release2 一致时合并声明 | |
| 209 | -| **匹配键** | ELF BuildID,内嵌于 `.sym`,正文表格仅作核对便利项 | | 215 | +| **匹配键** | ELF BuildID,内嵌于 `.sym`,正文表格仅作核对便利项 | |
| 210 | -| **红线** | 无符号不发布;BuildID 不匹配不使用;已归档不可变 | | 216 | +| **红线** | 无符号不发布;BuildID 不匹配不使用;已归档不可变 | |
| @@ -36,6 +36,7 @@ docs/zh-cn/ | |||
| 36 | │ │ ├── SDK版本配置指导.md # SDK版本选择 | 36 | │ │ ├── SDK版本配置指导.md # SDK版本选择 |
| 37 | │ │ └── 示例工程索引.md # 示例工程列表 | 37 | │ │ └── 示例工程索引.md # 示例工程列表 |
| 38 | │ ├── 02-开发指南/ # 开发指南 | 38 | │ ├── 02-开发指南/ # 开发指南 |
| 39 | +│ │ ├── README.md # 本目录导航 | ||
| 39 | │ │ ├── 功能开发.md # 开发流程指南 | 40 | │ │ ├── 功能开发.md # 开发流程指南 |
| 40 | │ │ ├── 自定义组件.md # 组件开发指南 | 41 | │ │ ├── 自定义组件.md # 组件开发指南 |
| 41 | │ │ ├── Codegen.md # 代码生成工具 | 42 | │ │ ├── Codegen.md # 代码生成工具 |
| @@ -45,7 +46,8 @@ docs/zh-cn/ | |||
| 45 | │ │ ├── C-API组件混合方案的使用.md # C-API混合方案 | 46 | │ │ ├── C-API组件混合方案的使用.md # C-API混合方案 |
| 46 | │ │ └── 编译构建/ | 47 | │ │ └── 编译构建/ |
| 47 | │ │ ├── 编译构建指南.md | 48 | │ │ ├── 编译构建指南.md |
| 48 | -│ │ └── RNOH构建与符号管理工程级指南.md | 49 | +│ │ ├── RNOH包使用指南.md |
| 50 | +│ │ └── RNOH 构建与符号管理工程级指南.md | ||
| 49 | │ ├── 03-场景与实践/ # 场景与实践 | 51 | │ ├── 03-场景与实践/ # 场景与实践 |
| 50 | │ │ ├── 常见开发场景.md # 场景化开发指南 | 52 | │ │ ├── 常见开发场景.md # 场景化开发指南 |
| 51 | │ │ ├── RN应用鸿蒙化开发指南.md # RN应用鸿蒙化开发全流程指南 | 53 | │ │ ├── RN应用鸿蒙化开发指南.md # RN应用鸿蒙化开发全流程指南 |
| @@ -59,13 +61,15 @@ docs/zh-cn/ | |||
| 59 | │ ├── 编译类FAQ.md # 编译问题排查 | 61 | │ ├── 编译类FAQ.md # 编译问题排查 |
| 60 | │ ├── 运行类FAQ.md # 运行问题排查 | 62 | │ ├── 运行类FAQ.md # 运行问题排查 |
| 61 | │ ├── 定位定界指导类FAQ.md # 问题定位方法 | 63 | │ ├── 定位定界指导类FAQ.md # 问题定位方法 |
| 64 | +│ ├── RNOH应用稳定性问题定位指南.md # 稳定性问题定位 | ||
| 62 | │ └── README.md | 65 | │ └── README.md |
| 63 | │ | 66 | │ |
| 64 | ├── 04-调优/ # 调优阶段 | 67 | ├── 04-调优/ # 调优阶段 |
| 65 | │ ├── 性能调优.md # 性能优化指南 | 68 | │ ├── 性能调优.md # 性能优化指南 |
| 66 | │ ├── 内存优化指导.md # 内存优化指导 | 69 | │ ├── 内存优化指导.md # 内存优化指导 |
| 67 | -│ └── 性能优化实践/ | 70 | +│ ├── 性能优化实践/ |
| 68 | -│ └── 页面转场与滑动场景优化.md | 71 | +│ │ ├── figures/ |
| 72 | +│ │ └── 页面转场与滑动场景优化.md | ||
| 69 | │ └── README.md | 73 | │ └── README.md |
| 70 | │ | 74 | │ |
| 71 | ├── 05-运维/ # 运维阶段 ⚡版本相关 | 75 | ├── 05-运维/ # 运维阶段 ⚡版本相关 |
| @@ -100,7 +104,8 @@ docs/zh-cn/ | |||
| 100 | │ │ ├── 社区changelog规范.md | 104 | │ │ ├── 社区changelog规范.md |
| 101 | │ │ ├── 仓库分支管理规范.md | 105 | │ │ ├── 仓库分支管理规范.md |
| 102 | │ │ ├── rnoh包管理规范.md | 106 | │ │ ├── rnoh包管理规范.md |
| 103 | -│ │ └── 开发者共建指南.md | 107 | +│ │ ├── 开发者共建指南.md |
| 108 | +│ │ └── 社区符号表归档规范.md | ||
| 104 | │ └── README.md | 109 | │ └── README.md |
| 105 | │ | 110 | │ |
| 106 | ├── figures/ # 图片资源 | 111 | ├── figures/ # 图片资源 |


中文版 02-开发/02-开发指南/README.md 的编译构建/ 目录下有 3 个文件(编译构建指南.md、RNOH包使用指南.md、RNOH 构建与符号管理工程级指南.md),英文版 build-configuration/ 只列了 2 个,漏了 RNOH 包使用指南的对应翻译条目。下面「directory contains」段落也只列了 2 项,和中文版 3 项对不上。要么补上英文翻译,要么标注 (Chinese version only - English version to be added),和 05-operations 里 stability-skill 的处理方式保持一致。