未验证 提交 be428bec 编写于 作者: O openharmony_ci 提交者: Gitee

!4122 更正device-dev下的readme等文档

Merge pull request !4122 from wusongqing/E0518V2
......@@ -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
# 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
# Overview<a name="EN-US_TOPIC_0000001062225512"></a>
# Application Framework Overview<a name="EN-US_TOPIC_0000001062225512"></a>
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.
......
# Application Framework<a name="EN-US_TOPIC_0000001111199418"></a>
- **[Overview](subsys-application-framework-overview.md)**
- **[Application Framework Overview](subsys-application-framework-overview.md)**
- **[Setting Up a Development Environment](subsys-application-framework-envbuild.md)**
......
# Startup<a name="EN-US_TOPIC_0000001157319415"></a>
- **[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)**
......@@ -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.
......
# Building a Standard System<a name="EN-US_TOPIC_0000001076490572"></a>
# Building the Standard System<a name="EN-US_TOPIC_0000001076490572"></a>
## Overview<a name="section17466112012244"></a>
......
......@@ -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)**
# HiSysEvent Listening<a name="EN-US_TOPIC_0000001185655868"></a>
- [Overview](#section315316685112)
- [Introduction](#section123181433335224)
- [Constraints](#section123181433375224)
- [Development Guidelines](#section315316685113)
- [Available APIs](#section0342191810519)
- [Development Example](#section123181432175110)
## Overview<a name="section315316685112"></a>
### Introduction<a name="section123181433335224"></a>
......
# HiSysEvent Logging Configuration<a name="EN-US_TOPIC_0000001080478132"></a>
- [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<a name="section315316685115"></a>
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.
......
# HiSysEvent Logging<a name="EN-US_TOPIC_0000001231373947"></a>
- [Overview](#section77571101789)
- [Introduction](#section123133332175224)
- [Constraints](#section123181432175224)
- [Development Guidelines](#section314416685113)
- [Available APIs](#section13480315886)
- [Development Example](#section112771171317)
## Overview<a name="section77571101789"></a>
### Introduction<a name="section123133332175224"></a>
......
# HiSysEvent Query<a name="EN-US_TOPIC_0000001231455461"></a>
- [Overview](#section279684125212)
- [Development Guidelines](#section315316761113)
- [Available APIs](#section03869128521)
- [Development Example](#section14286111855212)
## Overview<a name="section279684125212"></a>
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.
......
# HiSysEvent Tool Usage<a name="EN-US_TOPIC_0000001231614021"></a>
- [Overview](#section1886702718521)
- [Subscribing to Real-Time System Events](#section1210623418527)
- [Querying Historical System Events](#section1210623418539)
## Overview<a name="section1886702718521"></a>
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.
......
# DFX<a name="EN-US_TOPIC_0000001185974398"></a>
# DFX Overview<a name="EN-US_TOPIC_0000001185974398"></a>
[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\).
......
# 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)**
# Development Guidelines on Animators<a name="EN-US_TOPIC_0000001051451654"></a>
# Animator Development<a name="EN-US_TOPIC_0000001051451654"></a>
## When to Use<a name="section726685714018"></a>
......
# Development Guidelines on Common Components<a name="EN-US_TOPIC_0000001052170409"></a>
# Common Component Development<a name="EN-US_TOPIC_0000001052170409"></a>
Common components inherit from the base class **UIView**. Child components cannot be added to common components, such as buttons, images, and labels.
......
# Development Guidelines on Container Components<a name="EN-US_TOPIC_0000001052810390"></a>
# Container Component Development<a name="EN-US_TOPIC_0000001052810390"></a>
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**.
......
# Development Guidelines on Layout Container Components<a name="EN-US_TOPIC_0000001052661991"></a>
# Development of Layout Container Components<a name="EN-US_TOPIC_0000001052661991"></a>
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.
......
# Graphics<a name="EN-US_TOPIC_0000001051770388"></a>
# Graphics Overview<a name="EN-US_TOPIC_0000001051770388"></a>
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.
......
# Graphics<a name="EN-US_TOPIC_0000001157479391"></a>
- **[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)**
# Overview<a name="EN-US_TOPIC_0000001051690589"></a>
# Camera Overview<a name="EN-US_TOPIC_0000001051690589"></a>
## Basic Concepts<a name="section175012297491"></a>
......
# Development Guidelines on Photographing<a name="EN-US_TOPIC_0000001052170554"></a>
# Photographing Development<a name="EN-US_TOPIC_0000001052170554"></a>
## When to Use<a name="section1963312376119"></a>
......
# Development Guidelines on Previewing<a name="EN-US_TOPIC_0000001051930577"></a>
# Previewing Development<a name="EN-US_TOPIC_0000001051930577"></a>
## When to Use<a name="section186634310418"></a>
......
# Development Guidelines on Video Recording<a name="EN-US_TOPIC_0000001051451869"></a>
# Video Recording Development<a name="EN-US_TOPIC_0000001051451869"></a>
## When to Use<a name="section186634310418"></a>
......
# Camera<a name="EN-US_TOPIC_0000001111199462"></a>
- **[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)**
# Overview<a name="EN-US_TOPIC_0000001051770578"></a>
# Audio/Video Overview<a name="EN-US_TOPIC_0000001051770578"></a>
OpenHarmony multimedia services help you to develop for audio and video playback and recording.
......
# Development Guidelines on Media Playback<a name="EN-US_TOPIC_0000001051930589"></a>
# Audio/Video Playback Development<a name="EN-US_TOPIC_0000001051930589"></a>
## When to Use<a name="section186634310418"></a>
......
# Development Guidelines on Media Recording<a name="EN-US_TOPIC_0000001052170566"></a>
# Audio/Video Recording Development<a name="EN-US_TOPIC_0000001052170566"></a>
## When to Use<a name="section186634310418"></a>
......
# Audio/Video<a name="EN-US_TOPIC_0000001157479403"></a>
- **[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)**
# 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:
......
# Security<a name="EN-US_TOPIC_0000001157319395"></a>
- **[Overview](subsys-security-overview.md)**
- **[Security Overview](subsys-security-overview.md)**
- **[Development on Application Signature Verification](subsys-security-sigverify.md)**
......
# 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.
......
# USB Usage Demo<a name="EN-US_TOPIC_0000001092792986"></a>
# USB Usage Example<a name="EN-US_TOPIC_0000001092792986"></a>
```cpp
......
......@@ -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)**
# Utils Development Guidelines<a name="EN-US_TOPIC_0000001059307279"></a>
# Utils Development<a name="EN-US_TOPIC_0000001059307279"></a>
## Available APIs<a name="section1633115419401"></a>
......
......@@ -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)**
......
# Subsystem Development Guidelines<a name="EN-US_TOPIC_0000001111199452"></a>
- **[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)**
......@@ -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)
......
......@@ -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)
......@@ -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服务
......
......@@ -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
# 编译构建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`查看。
......@@ -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
......@@ -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
......@@ -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
......@@ -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)
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册