diff --git a/en/device-dev/Readme-EN.md b/en/device-dev/Readme-EN.md index beaa8563a7e804992c8df5d6b9a93899a2cb2612..2e69d001546138f62485054ac99131acaa9a4151 100644 --- a/en/device-dev/Readme-EN.md +++ b/en/device-dev/Readme-EN.md @@ -43,7 +43,7 @@ - [Mini- and Small-System Devices](guide/device-lite.md) - [Standard-System Devices](guide/device-standard.md) - Debugging - - [Test Subsystem](subsystems/subsys-testguide-test.md) + - [Test](subsystems/subsys-testguide-test.md) - [R&D Tools](subsystems/subsys-toolchain.md) - XTS Certification - [XTS](subsystems/subsys-xts-guide.md) @@ -52,8 +52,8 @@ - [IDE](get-code/gettools-ide.md) - Hands-On Tutorials - [Samples](https://gitee.com/openharmony/app_samples/blob/master/README.md) - - [Codelabs](https://gitee.com/openharmony/codelabs/blob/master/README.md) + - [Codelabs](https://gitee.com/openharmony/codelabs) - References - [FAQs](faqs/Readme-EN.md) - Contribution - - [How to Contribute](../contribute/how-to-contribute.md) \ No newline at end of file + - [How to Contribute](../contribute/documentation-contribution.md) \ No newline at end of file diff --git a/en/device-dev/subsystems/Readme-EN.md b/en/device-dev/subsystems/Readme-EN.md index b6e16c8bb006b7be020ecc6ad60361e1794d21c6..3a88076442ee79d3184f6e683441d2ffae480813 100644 --- a/en/device-dev/subsystems/Readme-EN.md +++ b/en/device-dev/subsystems/Readme-EN.md @@ -1,77 +1,77 @@ # Subsystems -- [Compilation and Building](subsys-build.md) - - [Building Guidelines for Mini and Small Systems](subsys-build-mini-lite.md) - - [Building Guidelines for the Standard System](subsys-build-standard-large.md) +- Compilation and Building + - [Building Mini and Small Systems](subsys-build-mini-lite.md) + - [Building the Standard System](subsys-build-standard-large.md) - [Build System Coding Specifications and Best Practices](subsys-build-gn-coding-style-and-best-practice.md) - - [Building the Kconfig Visual Configuration](subsys-build-gn-kconfig-visual-config-guid.md) + - [Building the Kconfig Visual Configuration](subsys-build-gn-kconfig-visual-config-guide.md) - [Distributed Remote Startup](subsys-remote-start.md) -- [Graphics](subsys-graphics.md) - - [Graphics](subsys-graphics-overview.md) - - [Development Guidelines on Container Components](subsys-graphics-container-guide.md) - - [Development Guidelines on Layout Container Components](subsys-graphics-layout-guide.md) - - [Development Guidelines on Common Components](subsys-graphics-common-guide.md) - - [Development Guidelines on Animators](subsys-graphics-animation-guide.md) -- [Multimedia](subsys-multimedia.md) - - [Camera](subsys-multimedia-camera.md) - - [Overview](subsys-multimedia-camera-overview.md) - - [Development Guidelines on Photographing](subsys-multimedia-camera-photo-guide.md) - - [Development Guidelines on Video Recording](subsys-multimedia-camera-record-guide.md) - - [Development Guidelines on Previewing](subsys-multimedia-camera-preview-guide.md) - - [Audio/Video](subsys-multimedia-video.md) - - [Overview](subsys-multimedia-video-overview.md) - - [Development Guidelines on Media Playback](subsys-multimedia-video-play-guide.md) - - [Development Guidelines on Media Recording](subsys-multimedia-video-record-guide.md) -- [Utils](subsys-utils.md) +- Graphics + - [Graphics Overview](subsys-graphics-overview.md) + - [Container Component Development](subsys-graphics-container-guide.md) + - [Development of Layout Container Components](subsys-graphics-layout-guide.md) + - [Common Component Development](subsys-graphics-common-guide.md) + - [Animator Development](subsys-graphics-animation-guide.md) +- Multimedia + - Camera + - [Camera Overview](subsys-multimedia-camera-overview.md) + - [Photographing Development](subsys-multimedia-camera-photo-guide.md) + - [Video Recording Development](subsys-multimedia-camera-record-guide.md) + - [Previewing Development](subsys-multimedia-camera-preview-guide.md) + - Audio/Video + - [Audio/Video Overview](subsys-multimedia-video-overview.md) + - [Audio/Video Playback Development](subsys-multimedia-video-play-guide.md) + - [Audio/Video Recording Development](subsys-multimedia-video-record-guide.md) +- Utils - [Utils Overview](subsys-utils-overview.md) - - [Utils Development Guidelines](subsys-utils-guide.md) + - [Utils Development](subsys-utils-guide.md) - [Utils FAQ](subsys-utils-faqs.md) -- [AI Framework](subsys-aiframework.md) +- AI Framework - [AI Engine Framework](subsys-aiframework-guide.md) - [Development Environment](subsys-aiframework-envbuild.md) - - [Technical Specifications](subsys-aiframework-tech.md) + - Technical Specifications - [Code Management](subsys-aiframework-tech-codemanage.md) - [Naming](subsys-aiframework-tech-name.md) - [API Development](subsys-aiframework-tech-interface.md) - - [Development Guidelines](subsys-aiframework-devguide.md) + - Development Guidelines - [SDK](subsys-aiframework-devguide-sdk.md) - [Plug-in](subsys-aiframework-devguide-plugin.md) - [Configuration File](subsys-aiframework-devguide-conf.md) - - [Development Examples](subsys-aiframework-demo.md) + - Development Examples - [KWS SDK](subsys-aiframework-demo-sdk.md) - [KWS Plug-in](subsys-aiframework-demo-plugin.md) - [KWS Configuration File](subsys-aiframework-demo-conf.md) -- [Data Management](subsys-data.md) - - [RDB](subsys-data-relational-database.md) +- Data Management + - RDB - [RDB Overview](subsys-data-relational-database-overview.md) - [RDB Development](subsys-data-relational-database-guide.md) - - [Lightweight Data Store](subsys-data-storage.md) + - Lightweight Data Store - [Lightweight Data Store Overview](subsys-data-storage-overview.md) - [Lightweight Data Store Development](subsys-data-storage-guide.md) -- [Sensor](subsys-sensor.md) +- Sensor - [Sensor Overview](subsys-sensor-overview.md) - [Sensor Usage Guidelines](subsys-sensor-guide.md) - [Sensor Usage Example](subsys-sensor-demo.md) -- [USB](subsys-usbservice.md) +- USB - [USB Overview](subsys-usbservice-overview.md) - [USB Usage Guidelines](subsys-usbservice-guide.md) - [USB Usage Example](subsys-usbservice-demo.md) -- [Application Framework](subsys-application-framework.md) - - [Overview](subsys-application-framework-overview.md) +- Application Framework + - [Application Framework Overview](subsys-application-framework-overview.md) - [Setting Up a Development Environment](subsys-application-framework-envbuild.md) - [Development Guidelines](subsys-application-framework-guide.md) - [Development Example](subsys-application-framework-demo.md) -- [OTA Upgrade](subsys-ota-guide.md) -- [Telephony ](subsys-tel.md) +- [OTA Update](subsys-ota-guide.md) +- Telephony - [Telephony Overview](subsys-tel-overview.md) - [Telephony Development](subsys-tel-guide.md) -- [Security](subsys-security.md) - - [Overview](subsys-security-overview.md) +- Security + - [Security Overview](subsys-security-overview.md) - [Development on Application Signature Verification](subsys-security-sigverify.md) - [Development on Application Permission Management](subsys-security-rightmanagement.md) - [Development on IPC Authentication](subsys-security-communicationverify.md) - [Development on Device Security Level Management](subsys-security-devicesecuritylevel.md) -- [Startup](subsys-boot.md) +- Startup - [Startup](subsys-boot-overview.md) - [init Module](subsys-boot-init.md) - [appspawn Module](subsys-boot-appspawn.md) @@ -80,14 +80,14 @@ - [syspara Module](subsys-boot-syspara.md) - [FAQs](subsys-boot-faqs.md) - [Reference](subsys-boot-ref.md) -- [Testing](subsys-testguide-test.md) -- [DFX](subsys-dfx.md) - - [DFX](subsys-dfx-overview.md) +- [Test](subsys-testguide-test.md) +- DFX + - [DFX Overview](subsys-dfx-overview.md) - [HiLog Development](subsys-dfx-hilog-rich.md) - [HiLog\_Lite Development](subsys-dfx-hilog-lite.md) - [HiTrace Development](subsys-dfx-hitrace.md) - [HiCollie Development](subsys-dfx-hicollie.md) - - [HiSysEvent Development](subsys-dfx-hisysevent.md) + - HiSysEvent Development - [HiSysEvent Logging Configuration](subsys-dfx-hisysevent-logging-config.md) - [HiSysEvent Logging](subsys-dfx-hisysevent-logging.md) - [HiSysEvent Listening](subsys-dfx-hisysevent-listening.md) @@ -98,6 +98,6 @@ - [FaultLogger Development](subsys-dfx-faultlogger.md) - [R&D Tools](subsys-toolchain.md) - [bytrace Usage Guidelines](subsys-toolchain-bytrace-guide.md) - - [hdc\_std Usage Guidelines](subsys-toolchain-hdc-guide.md) + - [hdc\_stds Usage Guidelines](subsys-toolchain-hdc-guide.md) - [hiperf Usage Guidelines](subsys-toolchain-hiperf.md) - [XTS](subsys-xts-guide.md) \ No newline at end of file diff --git a/en/device-dev/subsystems/subsys-application-framework-overview.md b/en/device-dev/subsystems/subsys-application-framework-overview.md index 740476413264c5e15d6e78376aa626e0f6e5573a..601e65a26fddc9a4a01cec37297a0157a388eab1 100644 --- a/en/device-dev/subsystems/subsys-application-framework-overview.md +++ b/en/device-dev/subsystems/subsys-application-framework-overview.md @@ -1,4 +1,4 @@ -# Overview +# Application Framework Overview The application framework is provided by OpenHarmony for you to develop OpenHarmony applications. It consists of two modules: ability management framework \(also called the ability framework\) and bundle management framework. diff --git a/en/device-dev/subsystems/subsys-application-framework.md b/en/device-dev/subsystems/subsys-application-framework.md index d293e2f842b321e985360648f945a4005e0b0081..d182dd67a37a05d615a169b96a08ea0091b578fd 100644 --- a/en/device-dev/subsystems/subsys-application-framework.md +++ b/en/device-dev/subsystems/subsys-application-framework.md @@ -1,6 +1,6 @@ # Application Framework -- **[Overview](subsys-application-framework-overview.md)** +- **[Application Framework Overview](subsys-application-framework-overview.md)** - **[Setting Up a Development Environment](subsys-application-framework-envbuild.md)** diff --git a/en/device-dev/subsystems/subsys-boot.md b/en/device-dev/subsystems/subsys-boot.md index b8f465d360614689758d2a538638e51da9f70007..f4d2e36562e6766d51b5f4bcbef0843ac69488c7 100644 --- a/en/device-dev/subsystems/subsys-boot.md +++ b/en/device-dev/subsystems/subsys-boot.md @@ -1,17 +1,12 @@ # Startup - **[Startup](subsys-boot-overview.md)** - - **[init Module](subsys-boot-init.md)** - -- **[appspawn Module](subsys-boot-appspawn.md)** - +- **[appspawn Module](subsys-boot-appspawn.md)** +- **[appspawn Module for the Standard System](subsys-boot-appspawn-standard.md)** - **[bootstrap Module](subsys-boot-bootstrap.md)** - - **[syspara Module](subsys-boot-syspara.md)** - - **[FAQs](subsys-boot-faqs.md)** - - **[Reference](subsys-boot-ref.md)** diff --git a/en/device-dev/subsystems/subsys-build-gn-kconfig-visual-config-guid.md b/en/device-dev/subsystems/subsys-build-gn-kconfig-visual-config-guide.md similarity index 95% rename from en/device-dev/subsystems/subsys-build-gn-kconfig-visual-config-guid.md rename to en/device-dev/subsystems/subsys-build-gn-kconfig-visual-config-guide.md index 5320f094594a7aa868d634745eafbed9da87f99b..929b6e4d050e0ed0428c0a423e2beca86936f8de 100644 --- a/en/device-dev/subsystems/subsys-build-gn-kconfig-visual-config-guid.md +++ b/en/device-dev/subsystems/subsys-build-gn-kconfig-visual-config-guide.md @@ -30,7 +30,7 @@ This function has the following advantages: 2. Set up the environment. - The Kconfiglib required for environment configuration has been embedded in the OpenHarmony hb tool. + The Kconfiglib required for environment configuration has been embedded in the OpenHarmony hb tool. For details about how to install the hb tool, see [Install hb](https://gitee.com/openharmony/docs/blob/master/en/device-dev/quick-start/quickstart-lite-env-setup.md#install-hb). 3. Open the Kconfig configuration interface. diff --git a/en/device-dev/subsystems/subsys-build-standard-large.md b/en/device-dev/subsystems/subsys-build-standard-large.md index 8f6dad88baa4a1046da2fb014c00b84d42bc062f..4412923e4bfbc0b84e2b167dce7018e60aeed8dc 100644 --- a/en/device-dev/subsystems/subsys-build-standard-large.md +++ b/en/device-dev/subsystems/subsys-build-standard-large.md @@ -1,4 +1,4 @@ -# Building a Standard System +# Building the Standard System ## Overview diff --git a/en/device-dev/subsystems/subsys-build.md b/en/device-dev/subsystems/subsys-build.md index 8bbf1247ff453b5ae36058be1879ed81224ed4da..dfe1731e91314cf37d587462a3fcc27ee1b0a3f4 100644 --- a/en/device-dev/subsystems/subsys-build.md +++ b/en/device-dev/subsystems/subsys-build.md @@ -2,8 +2,8 @@ - **[Building Mini and Small Systems](subsys-build-mini-lite.md)** -- **[Building a Standard System](subsys-build-standard-large.md)** +- **[Building the Standard System](subsys-build-standard-large.md)** - **[Build System Coding Specifications and Best Practices](subsys-build-gn-coding-style-and-best-practice.md)** -- **[Building the Kconfig Visual Configuration](subsys-build-gn-kconfig-visual-config-guid.md)** +- **[Building the Kconfig Visual Configuration](subsys-build-gn-kconfig-visual-config-guide.md)** diff --git a/en/device-dev/subsystems/subsys-dfx-hisysevent-listening.md b/en/device-dev/subsystems/subsys-dfx-hisysevent-listening.md index 445c43acafcac18eb778f34eb42d5ca3fe2e78fc..203f131c7baff6d80e226a96ba35db3e28f34ccb 100644 --- a/en/device-dev/subsystems/subsys-dfx-hisysevent-listening.md +++ b/en/device-dev/subsystems/subsys-dfx-hisysevent-listening.md @@ -1,12 +1,5 @@ # HiSysEvent Listening -- [Overview](#section315316685112) - - [Introduction](#section123181433335224) - - [Constraints](#section123181433375224) -- [Development Guidelines](#section315316685113) - - [Available APIs](#section0342191810519) - - [Development Example](#section123181432175110) - ## Overview ### Introduction diff --git a/en/device-dev/subsystems/subsys-dfx-hisysevent-logging-config.md b/en/device-dev/subsystems/subsys-dfx-hisysevent-logging-config.md index dcd9adb69fa11e84260d8f8352b671710325cfa8..7647bf18fd3c41c38e9472222f730580ec02e4f7 100644 --- a/en/device-dev/subsystems/subsys-dfx-hisysevent-logging-config.md +++ b/en/device-dev/subsystems/subsys-dfx-hisysevent-logging-config.md @@ -1,16 +1,5 @@ # HiSysEvent Logging Configuration -- [Overview](#section315316685115) - - [Basic Concepts](#section123181432175143) - - [Constraints](#section123181432175114) -- [Writing a YAML File](#section123181432175113) - - [Writing Rules](#section123181432175133) - - [Example](#section123181432175123) -- [Verifying the YAML File](#section123181432175115) - - [Configuring the YAML File Path](#section123181432175135) - - [Compiling the YAML File](#section123181432175137) - - [Logging and Querying Events](#section123181432175139) - ## Overview If HiSysEvent logging is required for a component, you need to define a YAML file and [configure the YAML file path](#section123181432175135) in the **bundle.js** file. During compilation, the OpenHarmony compilation framework will use the Python compilation script to parse and verify all the YAML files configured in the **bundle.js** file. On completion, the compilation framework will summarize the configuration information in the YAML files and convert the information into a JSON file named **hisysevent.def**. After that, the compilation framework will put the JSON file to a specified path as the basis for the system to determine whether to log system events. diff --git a/en/device-dev/subsystems/subsys-dfx-hisysevent-logging.md b/en/device-dev/subsystems/subsys-dfx-hisysevent-logging.md index e0c70f789d5991a8b54760a90f54d3fe6edc65bd..7c08b1ef336a377fea1da22efb291c9be19f4e64 100644 --- a/en/device-dev/subsystems/subsys-dfx-hisysevent-logging.md +++ b/en/device-dev/subsystems/subsys-dfx-hisysevent-logging.md @@ -1,12 +1,5 @@ # HiSysEvent Logging -- [Overview](#section77571101789) - - [Introduction](#section123133332175224) - - [Constraints](#section123181432175224) -- [Development Guidelines](#section314416685113) - - [Available APIs](#section13480315886) - - [Development Example](#section112771171317) - ## Overview ### Introduction diff --git a/en/device-dev/subsystems/subsys-dfx-hisysevent-query.md b/en/device-dev/subsystems/subsys-dfx-hisysevent-query.md index f6c072308141ba071e5017c0c5212040c1b15cc9..d743a8fbda8832246e7098bb2f2d7b0177d61eda 100644 --- a/en/device-dev/subsystems/subsys-dfx-hisysevent-query.md +++ b/en/device-dev/subsystems/subsys-dfx-hisysevent-query.md @@ -1,10 +1,5 @@ # HiSysEvent Query -- [Overview](#section279684125212) -- [Development Guidelines](#section315316761113) - - [Available APIs](#section03869128521) - - [Development Example](#section14286111855212) - ## Overview HiSysEvent provides an API for you to query system events. You can query concerned events by specifying search criteria. For example, for a power consumption module, you can query required system events for analysis. diff --git a/en/device-dev/subsystems/subsys-dfx-hisysevent-tool.md b/en/device-dev/subsystems/subsys-dfx-hisysevent-tool.md index 960f21fac12f1440187454447b04b5c963267425..79e3539bbb9d4248344c93664e21715b40895c16 100644 --- a/en/device-dev/subsystems/subsys-dfx-hisysevent-tool.md +++ b/en/device-dev/subsystems/subsys-dfx-hisysevent-tool.md @@ -1,9 +1,5 @@ # HiSysEvent Tool Usage -- [Overview](#section1886702718521) -- [Subscribing to Real-Time System Events](#section1210623418527) -- [Querying Historical System Events](#section1210623418539) - ## Overview The HiSysEvent tool is a command line tool preconfigured in the **/system/bin** directory of the system. You can use this tool to subscribe to real-time system events or query historical system vents. diff --git a/en/device-dev/subsystems/subsys-dfx-overview.md b/en/device-dev/subsystems/subsys-dfx-overview.md index ad0ada15bbcde99d901ea4e8d914467cc95aa63d..10d57285496c2534e1f78ea3eecac6bc40449fd9 100644 --- a/en/device-dev/subsystems/subsys-dfx-overview.md +++ b/en/device-dev/subsystems/subsys-dfx-overview.md @@ -1,4 +1,4 @@ -# DFX +# DFX Overview [Design for X](https://en.wikipedia.org/wiki/Design_for_X) \(DFX\) refers to the software design that aims to improve the quality attributes in OpenHarmony. It mainly consists of two parts: design for reliability \(DFR\) and design for testability \(DFT\). diff --git a/en/device-dev/subsystems/subsys-dfx.md b/en/device-dev/subsystems/subsys-dfx.md index cce0e6ee8c57ea413f3df4b1f3c08306b6dc24ce..6ede18fca604394d71e5663f631568a7a911561b 100644 --- a/en/device-dev/subsystems/subsys-dfx.md +++ b/en/device-dev/subsystems/subsys-dfx.md @@ -1,14 +1,10 @@ # DFX Development Guide -- [DFX Overview](subsys-dfx-overview.md) -- [HiLog Development](subsys-dfx-hilog-rich.md) -- [HiLog_Lite Development](subsys-dfx-hilog-lite.md) -- [HiTrace Development](subsys-dfx-hitrace.md) -- [HiCollie Development](subsys-dfx-hicollie.md) -- [HiSysEvent Development](subsys-dfx-hisysevent.md) - - [HiSysEvent Logging Configuration](subsys-dfx-hisysevent-logging-config.md) - - [HiSysEvent Logging](subsys-dfx-hisysevent-logging.md) - - [HiSysEvent Listening](subsys-dfx-hisysevent-listening.md) - - [HiSysEvent Query](subsys-dfx-hisysevent-query.md) - - [HiSysEvent Tool Usage](subsys-dfx-hisysevent-tool.md) - +- **[DFX Overview](subsys-dfx-overview.md)** +- **[HiLog Development](subsys-dfx-hilog-rich.md)** +- **[HiLog_Lite Development](subsys-dfx-hilog-lite.md)** +- **[HiTrace Development](subsys-dfx-hitrace.md)** +- **[HiCollie Development](subsys-dfx-hicollie.md)** +- **[HiSysEvent Development](subsys-dfx-hisysevent.md)** +- **[HiDumper Development](subsys-dfx-hidumper.md)** +- **[HiChecker Development](subsys-dfx-hichecker.md)** diff --git a/en/device-dev/subsystems/subsys-graphics-animation-guide.md b/en/device-dev/subsystems/subsys-graphics-animation-guide.md index e1e325583c1cbb89671e907b071fe1d776a40509..61bc52cbe893b9ac1675b9c9bb0df9b2edbe7de8 100644 --- a/en/device-dev/subsystems/subsys-graphics-animation-guide.md +++ b/en/device-dev/subsystems/subsys-graphics-animation-guide.md @@ -1,4 +1,4 @@ -# Development Guidelines on Animators +# Animator Development ## When to Use diff --git a/en/device-dev/subsystems/subsys-graphics-common-guide.md b/en/device-dev/subsystems/subsys-graphics-common-guide.md index b7c3caa23392bb87bc0c123b03a8c55c94669be9..72ee8265bce4e34edc5130abfebde78347cdbae9 100644 --- a/en/device-dev/subsystems/subsys-graphics-common-guide.md +++ b/en/device-dev/subsystems/subsys-graphics-common-guide.md @@ -1,4 +1,4 @@ -# Development Guidelines on Common Components +# Common Component Development Common components inherit from the base class **UIView**. Child components cannot be added to common components, such as buttons, images, and labels. diff --git a/en/device-dev/subsystems/subsys-graphics-container-guide.md b/en/device-dev/subsystems/subsys-graphics-container-guide.md index 610b6fd166b60acd12b6465c97e10e1012b08f89..90fd506671fe1fcd416a8e8f79d20bb148a923d6 100644 --- a/en/device-dev/subsystems/subsys-graphics-container-guide.md +++ b/en/device-dev/subsystems/subsys-graphics-container-guide.md @@ -1,4 +1,4 @@ -# Development Guidelines on Container Components +# Container Component Development Container components are capable of containing UI components and inherit from **UIViewGroup**. Components that are commonly used and need to contain child components are placed in the container class inheritance structure. For example, you need to call the **Add** function to add information such as time statistics and icons to **UIAnalogClock**. diff --git a/en/device-dev/subsystems/subsys-graphics-layout-guide.md b/en/device-dev/subsystems/subsys-graphics-layout-guide.md index 232e02f89104abdfa8b1c946e98c95ccfe6d2c4e..404af81512dcf14f7b84596a6b6a3d6dd6bbd41c 100644 --- a/en/device-dev/subsystems/subsys-graphics-layout-guide.md +++ b/en/device-dev/subsystems/subsys-graphics-layout-guide.md @@ -1,4 +1,4 @@ -# Development Guidelines on Layout Container Components +# Development of Layout Container Components Layout container components consist of basic view classes. You can set the view positions to achieve nested and overlapped layouts, set the layout type and margin to standardize the child components in the layout, and call certain functions to implement layout views based on parent and sibling components. diff --git a/en/device-dev/subsystems/subsys-graphics-overview.md b/en/device-dev/subsystems/subsys-graphics-overview.md index 51c370066e3ef23276a977e6d365632a5b9ca8ce..57ceef1960edb42bbcdbac9a2d7e89c7bf972a67 100644 --- a/en/device-dev/subsystems/subsys-graphics-overview.md +++ b/en/device-dev/subsystems/subsys-graphics-overview.md @@ -1,4 +1,4 @@ -# Graphics +# Graphics Overview The OpenHarmony graphics subsystem provides you with basic UI and container components, including buttons, images, labels, lists, animators, scroll views, swipe views, fonts, clock, charts, canvas, sliders, and layouts. In addition, this subsystem provides the Design for X \(DFX\) capability to capture screenshots and export the component tree. It also implements features such as component rendering, animation, and input event distribution. diff --git a/en/device-dev/subsystems/subsys-graphics.md b/en/device-dev/subsystems/subsys-graphics.md index 33ec9d2591be8e49ea9f039a09b4382c7f85d464..b687f2f46074750639367f99f76de6abb8c11063 100644 --- a/en/device-dev/subsystems/subsys-graphics.md +++ b/en/device-dev/subsystems/subsys-graphics.md @@ -1,13 +1,13 @@ # Graphics -- **[Graphics](subsys-graphics-overview.md)** +- **[Graphics Overview](subsys-graphics-overview.md)** -- **[Development Guidelines on Container Components](subsys-graphics-container-guide.md)** +- **[Container Component Development](subsys-graphics-container-guide.md)** -- **[Development Guidelines on Layout Container Components](subsys-graphics-layout-guide.md)** +- **[Development of Layout Container Components](subsys-graphics-layout-guide.md)** -- **[Development Guidelines on Common Components](subsys-graphics-common-guide.md)** +- **[Common Component Development](subsys-graphics-common-guide.md)** -- **[Development Guidelines on Animators](subsys-graphics-animation-guide.md)** +- **[Animator Development](subsys-graphics-animation-guide.md)** diff --git a/en/device-dev/subsystems/subsys-multimedia-camera-overview.md b/en/device-dev/subsystems/subsys-multimedia-camera-overview.md index 4096512ed30b2642165bb94ee012451db5dd97cc..b0f7fdeefa3823bbb3d199321ea2fb6412834c1b 100644 --- a/en/device-dev/subsystems/subsys-multimedia-camera-overview.md +++ b/en/device-dev/subsystems/subsys-multimedia-camera-overview.md @@ -1,4 +1,4 @@ -# Overview +# Camera Overview ## Basic Concepts diff --git a/en/device-dev/subsystems/subsys-multimedia-camera-photo-guide.md b/en/device-dev/subsystems/subsys-multimedia-camera-photo-guide.md index c862dff967b54cac0087a5e324849fbcc3d61729..ec5d8870524f3a581fb178d56205f2ac2bcc99cf 100644 --- a/en/device-dev/subsystems/subsys-multimedia-camera-photo-guide.md +++ b/en/device-dev/subsystems/subsys-multimedia-camera-photo-guide.md @@ -1,4 +1,4 @@ -# Development Guidelines on Photographing +# Photographing Development ## When to Use diff --git a/en/device-dev/subsystems/subsys-multimedia-camera-preview-guide.md b/en/device-dev/subsystems/subsys-multimedia-camera-preview-guide.md index 381697174c2824f79d5216ac7017e7b1345eb385..ff82dd15e65c193109e2d51ed2eca5aebc35d4c1 100644 --- a/en/device-dev/subsystems/subsys-multimedia-camera-preview-guide.md +++ b/en/device-dev/subsystems/subsys-multimedia-camera-preview-guide.md @@ -1,4 +1,4 @@ -# Development Guidelines on Previewing +# Previewing Development ## When to Use diff --git a/en/device-dev/subsystems/subsys-multimedia-camera-record-guide.md b/en/device-dev/subsystems/subsys-multimedia-camera-record-guide.md index eb938a26e85fd2a57e5460c0998e0eb0762acff8..b590d6222e362130e3d1ee3c2d8a20bb9e8c4049 100644 --- a/en/device-dev/subsystems/subsys-multimedia-camera-record-guide.md +++ b/en/device-dev/subsystems/subsys-multimedia-camera-record-guide.md @@ -1,4 +1,4 @@ -# Development Guidelines on Video Recording +# Video Recording Development ## When to Use diff --git a/en/device-dev/subsystems/subsys-multimedia-camera.md b/en/device-dev/subsystems/subsys-multimedia-camera.md index a4fac683ab17078ed5dd196da525256463c77df1..d98f596ccb6373eef7b306d15ad1d2bdebd75b00 100644 --- a/en/device-dev/subsystems/subsys-multimedia-camera.md +++ b/en/device-dev/subsystems/subsys-multimedia-camera.md @@ -1,11 +1,11 @@ # Camera -- **[Overview](subsys-multimedia-camera-overview.md)** +- **[Camera Overview](subsys-multimedia-camera-overview.md)** -- **[Development Guidelines on Photographing](subsys-multimedia-camera-photo-guide.md)** +- **[Photographing Development](subsys-multimedia-camera-photo-guide.md)** -- **[Development Guidelines on Video Recording](subsys-multimedia-camera-record-guide.md)** +- **[Video Recording Development](subsys-multimedia-camera-record-guide.md)** -- **[Development Guidelines on Previewing](subsys-multimedia-camera-preview-guide.md)** +- **[Previewing Development](subsys-multimedia-camera-preview-guide.md)** diff --git a/en/device-dev/subsystems/subsys-multimedia-video-overview.md b/en/device-dev/subsystems/subsys-multimedia-video-overview.md index ae286a6e51211a4824d9514f6dc60f3781fee9ee..7fb2620d32a9bd794863c5639af3440f8cc88315 100644 --- a/en/device-dev/subsystems/subsys-multimedia-video-overview.md +++ b/en/device-dev/subsystems/subsys-multimedia-video-overview.md @@ -1,4 +1,4 @@ -# Overview +# Audio/Video Overview OpenHarmony multimedia services help you to develop for audio and video playback and recording. diff --git a/en/device-dev/subsystems/subsys-multimedia-video-play-guide.md b/en/device-dev/subsystems/subsys-multimedia-video-play-guide.md index 1ec491d5d18d8b4415cb3c12874183a0ac1b210d..eada32f1ed4700da2abc87942b47e207f2838047 100644 --- a/en/device-dev/subsystems/subsys-multimedia-video-play-guide.md +++ b/en/device-dev/subsystems/subsys-multimedia-video-play-guide.md @@ -1,4 +1,4 @@ -# Development Guidelines on Media Playback +# Audio/Video Playback Development ## When to Use diff --git a/en/device-dev/subsystems/subsys-multimedia-video-record-guide.md b/en/device-dev/subsystems/subsys-multimedia-video-record-guide.md index b698f727273d853f10a936ad88921871f9928884..191ef11e8f1edc928dc6f75847ab07c57b106c5d 100644 --- a/en/device-dev/subsystems/subsys-multimedia-video-record-guide.md +++ b/en/device-dev/subsystems/subsys-multimedia-video-record-guide.md @@ -1,4 +1,4 @@ -# Development Guidelines on Media Recording +# Audio/Video Recording Development ## When to Use diff --git a/en/device-dev/subsystems/subsys-multimedia-video.md b/en/device-dev/subsystems/subsys-multimedia-video.md index 9d075f20b5a9a5ec0570bc6610b7bab093f230fe..c1ef1b3965da35d397c3ff3a3dc7bbb324e660dd 100644 --- a/en/device-dev/subsystems/subsys-multimedia-video.md +++ b/en/device-dev/subsystems/subsys-multimedia-video.md @@ -1,9 +1,9 @@ # Audio/Video -- **[Overview](subsys-multimedia-video-overview.md)** +- **[Audio/Video Overview](subsys-multimedia-video-overview.md)** -- **[Development Guidelines on Media Playback](subsys-multimedia-video-play-guide.md)** +- **[Audio/Video Playback Development](subsys-multimedia-video-play-guide.md)** -- **[Development Guidelines on Media Recording](subsys-multimedia-video-record-guide.md)** +- **[Audio/Video Recording Development](subsys-multimedia-video-record-guide.md)** diff --git a/en/device-dev/subsystems/subsys-security-overview.md b/en/device-dev/subsystems/subsys-security-overview.md index 7746a8d2680e3621551e3619ff6225dd58640518..f4e17ed0818e37519cfe6c1b6a1cb8122af5666f 100644 --- a/en/device-dev/subsystems/subsys-security-overview.md +++ b/en/device-dev/subsystems/subsys-security-overview.md @@ -1,4 +1,4 @@ -# Overview +# Security Overview The OpenHarmony security subsystem provides security capabilities that make your applications and devices more secure and help you manage permissions. This subsystem has the following modules: diff --git a/en/device-dev/subsystems/subsys-security.md b/en/device-dev/subsystems/subsys-security.md index 1ea65be900fc2a6f2bbaa97c697d6c22a33e3230..7658eee732e6120279604ff10f5132c8d12fca95 100644 --- a/en/device-dev/subsystems/subsys-security.md +++ b/en/device-dev/subsystems/subsys-security.md @@ -1,6 +1,6 @@ # Security -- **[Overview](subsys-security-overview.md)** +- **[Security Overview](subsys-security-overview.md)** - **[Development on Application Signature Verification](subsys-security-sigverify.md)** diff --git a/en/device-dev/subsystems/subsys-testguide-test.md b/en/device-dev/subsystems/subsys-testguide-test.md index c6ad47131a60b665506005bb249b46378de01b61..3440111dfcfbcfaf79b016d4a690aed4b52f7e29 100644 --- a/en/device-dev/subsystems/subsys-testguide-test.md +++ b/en/device-dev/subsystems/subsys-testguide-test.md @@ -1,4 +1,4 @@ -# Test Subsystem +# Test OpenHarmony provides a comprehensive auto-test framework for designing test cases. Detecting defects in the development process can improve code quality. This document describes how to use the OpenHarmony test framework. diff --git a/en/device-dev/subsystems/subsys-usbservice-demo.md b/en/device-dev/subsystems/subsys-usbservice-demo.md index d39ca0544427d05db7b8a8b55f29ed5e8955b280..e78028f32a2f5b20d27267809d35b6bdcd1a0369 100644 --- a/en/device-dev/subsystems/subsys-usbservice-demo.md +++ b/en/device-dev/subsystems/subsys-usbservice-demo.md @@ -1,4 +1,4 @@ -# USB Usage Demo +# USB Usage Example ```cpp diff --git a/en/device-dev/subsystems/subsys-usbservice.md b/en/device-dev/subsystems/subsys-usbservice.md index 369a182c4f3507d622b2759f0bf2429d9f50244f..9369d067cb3d73b3a9b074e4fc7c383b0bea429e 100644 --- a/en/device-dev/subsystems/subsys-usbservice.md +++ b/en/device-dev/subsystems/subsys-usbservice.md @@ -4,4 +4,5 @@ - **[USB Usage Guidelines](subsys-usbservice-guide.md)** -- **[USB Usage Example](subsys-usbservice-demo.md)** \ No newline at end of file +- **[USB Usage Example](subsys-usbservice-demo.md)** + diff --git a/en/device-dev/subsystems/subsys-utils-guide.md b/en/device-dev/subsystems/subsys-utils-guide.md index 6a6a786790f00aed60848586b64bb4861eb1738f..0bfc9faab094b6f5ceff476e3300c3615963fa30 100644 --- a/en/device-dev/subsystems/subsys-utils-guide.md +++ b/en/device-dev/subsystems/subsys-utils-guide.md @@ -1,4 +1,4 @@ -# Utils Development Guidelines +# Utils Development ## Available APIs diff --git a/en/device-dev/subsystems/subsys-utils.md b/en/device-dev/subsystems/subsys-utils.md index 1eb9ae9db3897341a33608f3f585eb059ca29bf6..96b98bfb785eb0dbfca81f57ad9242fa7dd3f41e 100644 --- a/en/device-dev/subsystems/subsys-utils.md +++ b/en/device-dev/subsystems/subsys-utils.md @@ -2,7 +2,7 @@ - **[Utils Overview](subsys-utils-overview.md)** -- **[Utils Development Guidelines](subsys-utils-guide.md)** +- **[Utils Development](subsys-utils-guide.md)** - **[Utils FAQ](subsys-utils-faqs.md)** diff --git a/en/device-dev/subsystems/subsys.md b/en/device-dev/subsystems/subsys.md index 06318d2b2abd90d69be1f43052432d103f5c3330..1b2c9674870709f5ae43d34292298387a16dda28 100644 --- a/en/device-dev/subsystems/subsys.md +++ b/en/device-dev/subsystems/subsys.md @@ -1,35 +1,22 @@ # Subsystem Development Guidelines - **[Compilation and Building](subsys-build.md)** - - **[Distributed Remote Startup](subsys-remote-start.md)** - - **[Graphics](subsys-graphics.md)** - - **[Multimedia](subsys-multimedia.md)** - -- **[Data Management](subsys-data.md)** - - **[Utils](subsys-utils.md)** - - **[AI Framework](subsys-aiframework.md)** - -- **[Sensors](subsys-sensor.md)** - +- **[Data Management](subsys-data.md)** +- **[Sensor](subsys-sensor.md)** +- **[USB](subsys-usbservice.md)** - **[Application Framework](subsys-application-framework.md)** - -- **[OTA Upgrade](subsys-ota-guide.md)** - +- **[OTA Updade](subsys-ota-guide.md)** +- **[Telephony](subsys-tel.md)** - **[Security](subsys-security.md)** - - **[Startup](subsys-boot.md)** - -- **[Testing](subsys-testguide-test.md)** - +- **[Test](subsys-testguide-test.md)** - **[DFX](subsys-dfx.md)** - - **[R&D Tools](subsys-toolchain.md)** - - **[XTS](subsys-xts-guide.md)** diff --git a/en/device-dev/website.md b/en/device-dev/website.md index dfc0cd795d99acef502d3968f168bb8bc00717a6..d8cffc4d611143831068382fef26cf802e30eee0 100644 --- a/en/device-dev/website.md +++ b/en/device-dev/website.md @@ -386,30 +386,30 @@ - [Vibrator](driver-peripherals-vibrator-des.md) - [Light](driver-peripherals-light-des.md) - Compilation and Building - - [Building Guidelines for Mini and Small Systems](subsystems/subsys-build-mini-lite.md) - - [Building Guidelines for Standard Systems](subsystems/subsys-build-standard-large.md) + - [Building Mini and Small Systems](subsystems/subsys-build-mini-lite.md) + - [Building the Standard System](subsystems/subsys-build-standard-large.md) - [Build System Coding Specifications and Best Practices](subsystems/subsys-build-gn-coding-style-and-best-practice.md) - - [Building the Kconfig Visual Configuration](subsystems/subsys-build-gn-kconfig-visual-config-guid.md) + - [Building the Kconfig Visual Configuration](subsystems/subsys-build-gn-kconfig-visual-config-guide.md) - [Distributed Remote Startup](subsystems/subsys-remote-start.md) - Graphics - - [Graphics](subsystems/subsys-graphics-overview.md) - - [Development Guidelines on Container Components](subsystems/subsys-graphics-container-guide.md) - - [Development Guidelines on Layout Container Components](subsystems/subsys-graphics-layout-guide.md) - - [Development Guidelines on Common Components](subsystems/subsys-graphics-common-guide.md) - - [Development Guidelines on Animators](subsystems/subsys-graphics-animation-guide.md) + - [Graphics Overview](subsystems/subsys-graphics-overview.md) + - [Container Component Development](subsystems/subsys-graphics-container-guide.md) + - [Development of Layout Container Components](subsystems/subsys-graphics-layout-guide.md) + - [Common Component Development](subsystems/subsys-graphics-common-guide.md) + - [Animator Development](subsystems/subsys-graphics-animation-guide.md) - Multimedia - Camera - - [Overview](subsystems/subsys-multimedia-camera-overview.md) - - [Development Guidelines on Photographing](subsystems/subsys-multimedia-camera-photo-guide.md) - - [Development Guidelines on Video Recording](subsystems/subsys-multimedia-camera-record-guide.md) - - [Development Guidelines on Previewing](subsystems/subsys-multimedia-camera-preview-guide.md) + - [Camera Overview](subsystems/subsys-multimedia-camera-overview.md) + - [Photographing Development ](subsystems/subsys-multimedia-camera-photo-guide.md) + - [Video Recording Development ](subsystems/subsys-multimedia-camera-record-guide.md) + - [Previewing Development ](subsystems/subsys-multimedia-camera-preview-guide.md) - Audio and Video - - [Overview](subsystems/subsys-multimedia-video-overview.md) - - [Development Guidelines on Media Playback](subsystems/subsys-multimedia-video-play-guide.md) - - [Development Guidelines on Media Recording](subsystems/subsys-multimedia-video-record-guide.md) + - [Audio/Video Overview](subsystems/subsys-multimedia-video-overview.md) + - [Audio/Video Playback Development](subsystems/subsys-multimedia-video-play-guide.md) + - [Audio/Video Recording Development](subsystems/subsys-multimedia-video-record-guide.md) - Utils - [Utils Overview](subsystems/subsys-utils-overview.md) - - [Utils Development Guidelines](subsystems/subsys-utils-guide.md) + - [Utils Development](subsystems/subsys-utils-guide.md) - [Utils FAQ](subsystems/subsys-utils-faqs.md) - AI Framework - [AI Engine Framework](subsystems/subsys-aiframework-guide.md) @@ -442,7 +442,7 @@ - [USB Usage Guidelines](subsystems/subsys-usbservice-guide.md) - [USB Usage Example](subsystems/subsys-usbservice-demo.md) - Application Framework - - [Overview](subsystems/subsys-application-framework-overview.md) + - [Application Framework Overview](subsystems/subsys-application-framework-overview.md) - [Setting Up a Development Environment](subsystems/subsys-application-framework-envbuild.md) - [Development Guidelines](subsystems/subsys-application-framework-guide.md) - [Development Example](subsystems/subsys-application-framework-demo.md) @@ -451,7 +451,7 @@ - [Telephony Overview](subsystems/subsys-tel-overview.md) - [Telephony Development](subsystems/subsys-tel-guide.md) - Security - - [Overview](subsystems/subsys-security-overview.md) + - [Security Overview](subsystems/subsys-security-overview.md) - [Development on Application Signature Verification](subsystems/subsys-security-sigverify.md) - [Development on Application Permission Management](subsystems/subsys-security-rightmanagement.md) - [Development on IPC Authentication](subsystems/subsys-security-communicationverify.md) @@ -519,7 +519,7 @@ - [Development Example for Peripheral Drivers](guide/device-outerdriver-demo.md) - Debugging - - [Test Subsystem](subsystems/subsys-testguide-test.md) + - [Test](subsystems/subsys-testguide-test.md) - Debugging Tools - [bytrace](subsystems/subsys-toolchain-bytrace-guide.md) - [hdc\_std](subsystems/subsys-toolchain-hdc-guide.md) diff --git a/en/readme.md b/en/readme.md index 9168f0abf8e2142427ab6ccead628f60d02cff10..5ca900639a5e2c02862d44681ece181b503cf386 100644 --- a/en/readme.md +++ b/en/readme.md @@ -8,6 +8,6 @@ This repository stores a complete range of OpenHarmony documentation. The conten - [Release Notes](release-notes/Readme.md) - [Subsystems](./readme) - OpenHarmony Contribution - - [How to Contribute](contribute/how-to-contribute.md) + - [Contribution Guide](contribute/how-to-contribute.md) - [OpenHarmony Part and API Design Reference](./design) diff --git a/zh-cn/device-dev/subsystems/Readme-CN.md b/zh-cn/device-dev/subsystems/Readme-CN.md index 84dc4d42279148a94130c9ff78ca05aae1d8ac0b..575b7c7176e8169cc29860fefb7e1857f11fff36 100755 --- a/zh-cn/device-dev/subsystems/Readme-CN.md +++ b/zh-cn/device-dev/subsystems/Readme-CN.md @@ -4,7 +4,7 @@ - [轻量和小型系统编译构建指导](subsys-build-mini-lite.md) - [标准系统编译构建指导](subsys-build-standard-large.md) - [构建系统编码规范与最佳实践](subsys-build-gn-coding-style-and-best-practice.md) - - [编译构建Kconfig可视化配置指导](subsys-build-gn-kconfig-visual-config-guid.md) + - [编译构建Kconfig可视化配置指导](subsys-build-gn-kconfig-visual-config-guide.md) - [分布式远程启动](subsys-remote-start.md) - 图形图像 - [图形图像概述](subsys-graphics-overview.md) @@ -42,10 +42,10 @@ - [唤醒词识别插件的开发示例](subsys-aiframework-demo-plugin.md) - [唤醒词识别配置文件的开发示例](subsys-aiframework-demo-conf.md) - 数据管理 - - [关系型数据库](subsys-data-relational-database.md) + - 关系型数据库 - [关系型数据库概述](subsys-data-relational-database-overview.md) - [关系型数据库开发指导](subsys-data-relational-database-guide.md) - - [轻量级数据存储](subsys-data-storage.md) + - 轻量级数据存储 - [轻量级数据存储概述](subsys-data-storage-overview.md) - [轻量级数据存储开发指导](subsys-data-storage-guide.md) - Sensor服务 diff --git a/zh-cn/device-dev/subsystems/subsys-boot.md b/zh-cn/device-dev/subsystems/subsys-boot.md index b2302512738c6f1338f3455bf0a4d390eecb8667..42e3f43579058f170978a15ed014580baaf11cea 100644 --- a/zh-cn/device-dev/subsystems/subsys-boot.md +++ b/zh-cn/device-dev/subsystems/subsys-boot.md @@ -3,15 +3,10 @@ - **[启动恢复子系统概述](subsys-boot-overview.md)** - - **[init启动引导组件](subsys-boot-init.md)** - - **[appspawn应用孵化组件](subsys-boot-appspawn.md)** - +- **[appspawn标准系统应用孵化组件](subsys-boot-appspawn-standard.md)** - **[bootstrap服务启动组件](subsys-boot-bootstrap.md)** - - **[syspara系统属性组件](subsys-boot-syspara.md)** - - **[常见问题](subsys-boot-faqs.md)** - - **[参考](subsys-boot-ref.md)** \ No newline at end of file diff --git a/zh-cn/device-dev/subsystems/subsys-build-gn-kconfig-visual-config-guid.md b/zh-cn/device-dev/subsystems/subsys-build-gn-kconfig-visual-config-guide.md similarity index 95% rename from zh-cn/device-dev/subsystems/subsys-build-gn-kconfig-visual-config-guid.md rename to zh-cn/device-dev/subsystems/subsys-build-gn-kconfig-visual-config-guide.md index 4c771af2b08831fd54c9bdc88c4456882d9b1622..78d686a60a99296691ce6653b3156a0c399c9829 100644 --- a/zh-cn/device-dev/subsystems/subsys-build-gn-kconfig-visual-config-guid.md +++ b/zh-cn/device-dev/subsystems/subsys-build-gn-kconfig-visual-config-guide.md @@ -1,114 +1,114 @@ -# 编译构建Kconfig可视化配置指导 - -## 概述 - -### 功能简介 -该功能基于[Kconfiglib](https://github.com/ulfalizer/Kconfiglib)与[Kconfig]( https://www.kernel.org/doc/html/latest/kbuild/kconfig-language.html#introduction)实现，方便用户个性化配置OpenHarmony产品子系统部件。 - -基于Kconfig实现的可视化配置功能具有以下优点： - -- 能直观且全面地展示软件的组件选项。 -- 可靠性强，如Linux-kernel、buildroot等知名软件都采用Kconfig进行可视化配置。 - -### 基本概念 - -- [Kconfig]( https://www.kernel.org/doc/html/latest/kbuild/kconfig-language.html#introduction) ：是一款Linux可视化配置文件格式。 - -- [Kconfiglib](https://github.com/ulfalizer/Kconfiglib)：是一款基于Kconfig格式实现的Linux可视化配置工具。 - -### 相关模块 - -- [Kconfig更新模块](https://gitee.com/openharmony/build/blob/master/tools/component_tools/generate_kconfig.py)：用于更新Kconfig菜单栏目最新的部件信息列表。 - -- [config配置格式转换](https://gitee.com/openharmony/build/blob/master/tools/component_tools/parse_kconf.py)：用于将界面生成的config文件，转化为系统编译构建的标准化格式配置文件。 - -## 操作指导 - -1. 获取源码 - - OpenHarmony版本发布的源码获取请参考：[源码获取教程](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/get-code/sourcecode-acquire.md) - -2. 环境准备 - - 环境配置所需要的Kconfiglib已内置在OpenHarmony自带的hb工具中，如需安装hb工具，可参考：[hb安装教程](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/quick-start/quickstart-lite-package-environment.md#%E5%AE%89%E8%A3%85hb) - -3. 开启可视化配置界面 - - ```shell - #进入build仓下目录 - cd build/tools/component_tools - menuconfig kconfig - ``` - - ![界面示例](figures/kconfig界面.PNG) - -4. 参数填写 - - 参数配置项可以参考：[productdefine/common/base/base_product.json](https://gitee.com/openharmony/productdefine_common/blob/master/base/base_product.json) - - ![参数填写](figures/kconfig参数输入.gif) - -5. 选择部件并配置 - - 1. 点击方向键->选择子系统，进入子系统的部件列表。 - - 2. 按回车健选择子系统。 - - 3. 输入`feature`时，注意用英语逗号隔开多项输入。 - - ![部件选择](figures/kconfig部件选择.gif) - -6. 保存所选配置 - - 按S键保存文件，可自定义输出文件名，默认为当前目录下`.config`文件。 - - ![保存配置](figures/kconfig保存.PNG) - -7. 生成OpenHarmony Style配置文件 - - 示例步骤： - - 1. gn编译全量产品 - - ```shell - cp productdefine/common/base/base_product.json productdefine/common/products/ohos-arm64.json - ./build.sh --product-name ohos-arm64 --build-only-gn --ccache --gn-args pycache_enable=true --gn-args check_deps=true --build-only-gn - ``` - - 2. 生成部件依赖文件 - - ```shell - ./build/tools/module_dependence/part_deps.py --deps-files-path out/arm64/deps_files - # output: out/arm64/part_deps_info/part_deps_info.json - ``` - - 3. 生成OpenHarmony Style配置文件 - - ```shell - cd build/tools/component_tools - python3 parse_kconf.py --deps=/path/to/out/arm64/part_deps_info/part_deps_info.json - ``` - - 输出文件默认为当前目录下：`product.json`， 也可以使用`python3 parse_kconf.py --out="example/out.json"`来指定输出文件位置 - - 更多操作可查看`python3 parse_kconf.py -h` - -​ - -## 常见问题 - -### 菜单列表缺失最新部件信息 - -由于产品不断的更新迭代，全量部件列表[productdefine/common/base/base_product.json](https://gitee.com/openharmony/productdefine_common/blob/master/base/base_product.json)也会随之不断更新，从而导致Kconfig菜单缺少最新部件。 - -解决办法： - -- 更新[Kconfig文件](https://gitee.com/openharmony/build/blob/master/tools/component_tools/kconfig) - - ```shell - cd build/tools/component_tools - python3 generate_kconfig.py - ``` - - 更多选项通过`python3 generate_kconfig.py -h`查看。 - +# 编译构建Kconfig可视化配置指导 + +## 概述 + +### 功能简介 +该功能基于[Kconfiglib](https://github.com/ulfalizer/Kconfiglib)与[Kconfig]( https://www.kernel.org/doc/html/latest/kbuild/kconfig-language.html#introduction)实现，方便用户个性化配置OpenHarmony产品子系统部件。 + +基于Kconfig实现的可视化配置功能具有以下优点： + +- 能直观且全面地展示软件的组件选项。 +- 可靠性强，如Linux-kernel、buildroot等知名软件都采用Kconfig进行可视化配置。 + +### 基本概念 + +- [Kconfig]( https://www.kernel.org/doc/html/latest/kbuild/kconfig-language.html#introduction) ：是一款Linux可视化配置文件格式。 + +- [Kconfiglib](https://github.com/ulfalizer/Kconfiglib)：是一款基于Kconfig格式实现的Linux可视化配置工具。 + +### 相关模块 + +- [Kconfig更新模块](https://gitee.com/openharmony/build/blob/master/tools/component_tools/generate_kconfig.py)：用于更新Kconfig菜单栏目最新的部件信息列表。 + +- [config配置格式转换](https://gitee.com/openharmony/build/blob/master/tools/component_tools/parse_kconf.py)：用于将界面生成的config文件，转化为系统编译构建的标准化格式配置文件。 + +## 操作指导 + +1. 获取源码 + + OpenHarmony版本发布的源码获取请参考：[源码获取教程](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/get-code/sourcecode-acquire.md) + +2. 环境准备 + + 环境配置所需要的Kconfiglib已内置在OpenHarmony自带的hb工具中，如需安装hb工具，可参考：[hb安装教程](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/quick-start/quickstart-lite-env-setup.md#%E5%AE%89%E8%A3%85hb) + +3. 开启可视化配置界面 + + ```shell + #进入build仓下目录 + cd build/tools/component_tools + menuconfig kconfig + ``` + + ![界面示例](figures/kconfig界面.PNG) + +4. 参数填写 + + 参数配置项可以参考：[productdefine/common/base/base_product.json](https://gitee.com/openharmony/productdefine_common/blob/master/base/base_product.json) + + ![参数填写](figures/kconfig参数输入.gif) + +5. 选择部件并配置 + + 1. 点击方向键->选择子系统，进入子系统的部件列表。 + + 2. 按回车健选择子系统。 + + 3. 输入`feature`时，注意用英语逗号隔开多项输入。 + + ![部件选择](figures/kconfig部件选择.gif) + +6. 保存所选配置 + + 按S键保存文件，可自定义输出文件名，默认为当前目录下`.config`文件。 + + ![保存配置](figures/kconfig保存.PNG) + +7. 生成OpenHarmony Style配置文件 + + 示例步骤： + + 1. gn编译全量产品 + + ```shell + cp productdefine/common/base/base_product.json productdefine/common/products/ohos-arm64.json + ./build.sh --product-name ohos-arm64 --build-only-gn --ccache --gn-args pycache_enable=true --gn-args check_deps=true --build-only-gn + ``` + + 2. 生成部件依赖文件 + + ```shell + ./build/tools/module_dependence/part_deps.py --deps-files-path out/arm64/deps_files + # output: out/arm64/part_deps_info/part_deps_info.json + ``` + + 3. 生成OpenHarmony Style配置文件 + + ```shell + cd build/tools/component_tools + python3 parse_kconf.py --deps=/path/to/out/arm64/part_deps_info/part_deps_info.json + ``` + + 输出文件默认为当前目录下：`product.json`， 也可以使用`python3 parse_kconf.py --out="example/out.json"`来指定输出文件位置 + + 更多操作可查看`python3 parse_kconf.py -h` + +​ + +## 常见问题 + +### 菜单列表缺失最新部件信息 + +由于产品不断的更新迭代，全量部件列表[productdefine/common/base/base_product.json](https://gitee.com/openharmony/productdefine_common/blob/master/base/base_product.json)也会随之不断更新，从而导致Kconfig菜单缺少最新部件。 + +解决办法： + +- 更新[Kconfig文件](https://gitee.com/openharmony/build/blob/master/tools/component_tools/kconfig) + + ```shell + cd build/tools/component_tools + python3 generate_kconfig.py + ``` + + 更多选项通过`python3 generate_kconfig.py -h`查看。 + diff --git a/zh-cn/device-dev/subsystems/subsys-build.md b/zh-cn/device-dev/subsystems/subsys-build.md index bf8667d708b2574196adf43deed137d685890312..1652a6cf1a7fea85f54e9603dcd9944cce51aaaf 100644 --- a/zh-cn/device-dev/subsystems/subsys-build.md +++ b/zh-cn/device-dev/subsystems/subsys-build.md @@ -3,7 +3,7 @@ - **[轻量和小型系统编译构建指导](subsys-build-mini-lite.md)** - - **[标准系统编译构建指导](subsys-build-standard-large.md)** +- **[构建系统编码规范与最佳实践](subsys-build-gn-coding-style-and-best-practice.md)** +- **[编译构建Kconfig可视化配置指导](subsys-build-gn-kconfig-visual-config-guide.md)** -- **[构建系统编码规范与最佳实践](subsys-build-gn-coding-style-and-best-practice.md)** \ No newline at end of file diff --git a/zh-cn/device-dev/subsystems/subsys-dfx.md b/zh-cn/device-dev/subsystems/subsys-dfx.md index 8b9776195470a88e6df782171eff1ae82e83e4a3..b8ea56af1cd9448804682fad904e1705780e5bd5 100644 --- a/zh-cn/device-dev/subsystems/subsys-dfx.md +++ b/zh-cn/device-dev/subsystems/subsys-dfx.md @@ -3,13 +3,10 @@ - **[DFX概述](subsys-dfx-overview.md)** - - **[HiLog开发指导](subsys-dfx-hilog-rich.md)** - - **[HiLog_Lite开发指导](subsys-dfx-hilog-lite.md)** - - **[HiTrace开发指导](subsys-dfx-hitrace.md)** - - **[HiCollie开发指导](subsys-dfx-hicollie.md)** - -- **[HiSysEvent开发指导](subsys-dfx-hisysevent.md)** \ No newline at end of file +- **[HiSysEvent开发指导](subsys-dfx-hisysevent.md)** +- **[HiDumper开发指导](subsys-dfx-hidumper.md)** +- **[HiChecker开发指导](subsys-dfx-hichecker.md)** \ No newline at end of file diff --git a/zh-cn/device-dev/subsystems/subsys.md b/zh-cn/device-dev/subsystems/subsys.md index c7332d5a16c97ce33a768f6e57ddf0f33da0e1ef..b81e82499001d3a53532e65f5e82bbe260f93a8c 100755 --- a/zh-cn/device-dev/subsystems/subsys.md +++ b/zh-cn/device-dev/subsystems/subsys.md @@ -3,33 +3,20 @@ - **[编译构建](subsys-build.md)** - - **[分布式远程启动](subsys-remote-start.md)** - -- **[测试用例开发指导](subsys-testguide-test.md)** - -- **[XTS认证用例开发指导](subsys-xts-guide.md)** - - **[图形图像](subsys-graphics.md)** - - **[媒体](subsys-multimedia.md)** - - **[公共基础](subsys-utils.md)** - - **[AI框架](subsys-aiframework.md)** - +- **[数据管理](subsys-data.md)** - **[Sensor服务](subsys-sensor.md)** - +- **[USB](subsys-usbservice.md)** - **[用户程序框架](subsys-application-framework.md)** - -- **[升级服务](subsys-ota.md)** - +- **[升级服务](subsys-ota-guide.md)** - **[电话服务](subsys-tel.md)** - - **[安全](subsys-security.md)** - - **[启动恢复](subsys-boot.md)** - +- **[测试用例开发指导](subsys-testguide-test.md)** - **[DFX](subsys-dfx.md)** - -- **[调测工具](subsys-toolchain.md)** \ No newline at end of file +- **[调测工具](subsys-toolchain.md)** +- **[XTS认证用例开发指导](subsys-xts-guide.md)** \ No newline at end of file diff --git a/zh-cn/device-dev/website.md b/zh-cn/device-dev/website.md index edf90f5cbda80b26afeaa41f86e51e48d2b1c82f..c4d6b2366a08aa6e163477a61cdf8ab93a31b40d 100644 --- a/zh-cn/device-dev/website.md +++ b/zh-cn/device-dev/website.md @@ -402,7 +402,7 @@ - [轻量和小型系统编译构建指导](subsystems/subsys-build-mini-lite.md) - [标准系统编译构建指导](subsystems/subsys-build-standard-large.md) - [构建系统编码规范和最佳实践指导](subsystems/subsys-build-gn-coding-style-and-best-practice.md) - - [编译构建Kconfig可视化配置指导](subsystems/subsys-build-gn-kconfig-visual-config-guid.md) + - [编译构建Kconfig可视化配置指导](subsystems/subsys-build-gn-kconfig-visual-config-guide.md) - [分布式远程启动](subsystems/subsys-remote-start.md) - 图形图像 - [图形图像概述](subsystems/subsys-graphics-overview.md)