diff --git a/en/OpenHarmony-Overview.md b/en/OpenHarmony-Overview.md index 6df659c230c4fd691638228177c243b489844422..b793c92b4f0a1aa7c62e78f97a9dde67f216048e 100644 --- a/en/OpenHarmony-Overview.md +++ b/en/OpenHarmony-Overview.md @@ -1,18 +1,5 @@ # OpenHarmony -- [Introduction](#section1270210396435) -- [Technical Architecture](#section2502124574318) -- [Technical Features](#section12212842173518) -- [OS Types](#section145241459142416) -- [Subsystems](#section25831825174419) -- [Getting Started](#section44681652104210) -- [Code Repository Addresses](#section107651249181914) -- [OpenHarmony Documentation](#section21031470109) -- [Source Code Downloading](#section39011923144212) -- [How to Participate](#section19611528174215) -- [License Agreement](#section1245517472115) -- [Contact Info](#section61728335424) - ## Introduction OpenHarmony is an open-source project incubated and operated by the OpenAtom Foundation. It is an open-source operating system with a framework and platform applicable to smart devices in all scenarios of a fully-connected world. It aims to promote the development of the Internet of Everything (IoE). diff --git a/en/application-dev/media/Readme-EN.md b/en/application-dev/media/Readme-EN.md index b1c6ebf287d9b808004c4b7c1e619953004e1e0d..8e57cf850c58132fda114da0b2b9e31abf09ec27 100755 --- a/en/application-dev/media/Readme-EN.md +++ b/en/application-dev/media/Readme-EN.md @@ -2,9 +2,9 @@ - [Audio](audio.md) - [Audio Overview](audio-overview.md) - - [Development Guidelines on Audio Playback](audio-playback.md) + - [Audio Playback Development](audio-playback.md) - - [Development Guidelines on Audio Management](audio-management.md) + - [Audio Management Development](audio-management.md) - - [Development Guidelines on Audio Recording](audio-recorder.md) + - [Audio Recording Development](audio-recorder.md) diff --git a/en/application-dev/media/audio-management.md b/en/application-dev/media/audio-management.md index 3c3ab439b7ced206e5e53855b66e22d6e9383f3c..65bfb215f206954de5baf1fc7edb9416812b1c6f 100644 --- a/en/application-dev/media/audio-management.md +++ b/en/application-dev/media/audio-management.md @@ -1,4 +1,4 @@ -# Development Guidelines on Audio Management +# Audio Management Development ## When to Use diff --git a/en/application-dev/media/audio-playback.md b/en/application-dev/media/audio-playback.md index d2d2596e40035e761b7d2090ec2461628fa73742..573baf7669768528a5aa9bc434eca886f4283db8 100644 --- a/en/application-dev/media/audio-playback.md +++ b/en/application-dev/media/audio-playback.md @@ -1,7 +1,4 @@ -# Development Guidelines on Audio Playback - -- [When to Use](#When-to-Use) -- [Available APIs](#Available-APIs) +# Audio Playback Development ## When to Use diff --git a/en/application-dev/media/audio-recorder.md b/en/application-dev/media/audio-recorder.md index 691712f33176e6e9c8aaae16272fa17574b76e9f..7d2e040abcc077e9a428b46936dcc36d4d7b2cf5 100644 --- a/en/application-dev/media/audio-recorder.md +++ b/en/application-dev/media/audio-recorder.md @@ -1,4 +1,4 @@ -# Development Guidelines on Audio Recording +# Audio Recording Development ## When to Use diff --git a/en/application-dev/media/audio.md b/en/application-dev/media/audio.md deleted file mode 100755 index 78383b40df1f667736e43cddb1041266c0fee3df..0000000000000000000000000000000000000000 --- a/en/application-dev/media/audio.md +++ /dev/null @@ -1,11 +0,0 @@ -# Audio - -- **[Audio Overview](audio-overview.md)** - -- **[Development Guidelines on Audio Playback](audio-playback.md)** - -- **[Development Guidelines on Audio Management](audio-management.md)** - -- **[Development Guidelines on Audio Recording](audio-recorder.md)** - - diff --git a/en/application-dev/media/sound-manager.md b/en/application-dev/media/sound-manager.md index 0aa02458d1ff1bb2cac91c5eec6af667827411a2..a899fe0afabba47f0de3c5b85f70cbdc16787b30 100644 --- a/en/application-dev/media/sound-manager.md +++ b/en/application-dev/media/sound-manager.md @@ -1,4 +1,4 @@ -# Development Guide for usage of SoundManager +# SoundManager Development ## **Summary** This guide will show you how to use SoundManager to save and retrieve the ringtone, alarm and notification uris. diff --git a/en/application-dev/security/userauth-overview.md b/en/application-dev/security/userauth-overview.md index d02a8ec6df859ea48792d5c908665a32fbb0bdae..5bd678a630115cdb26686ce75945e45f90cdca39 100644 --- a/en/application-dev/security/userauth-overview.md +++ b/en/application-dev/security/userauth-overview.md @@ -1,8 +1,8 @@ # User Authentication Overview -HarmonyOS provides biometric recognition that can be used for identity authentication in device unlocking, application login, and payment. +OpenHarmony provides biometric recognition that can be used for identity authentication in device unlocking, application login, and payment. -HarmonyOS provides both 2D and 3D facial recognition. You can provide either or both of them on your device based on the hardware and technology applied on the device. 3D facial recognition is superior to 2D facial recognition in terms of recognition rate and anti-counterfeiting capability. However, you can use 3D facial recognition only if your device supports capabilities such as 3D structured light and 3D Time of Flight \(TOF\). +OpenHarmony provides both 2D and 3D facial recognition. You can provide either or both of them on your device based on the hardware and technology applied on the device. 3D facial recognition is superior to 2D facial recognition in terms of recognition rate and anti-counterfeiting capability. However, you can use 3D facial recognition only if your device supports capabilities such as 3D structured light and 3D Time of Flight \(TOF\). ## Basic Concepts @@ -18,7 +18,7 @@ Facial characteristics are stored in the TEE, which uses strong cryptographic al ## Limitations and Constraints -- HarmonyOS only supports facial recognition and local authentication, and does not support an authentication UI. +- OpenHarmony only supports facial recognition and local authentication, and does not support an authentication UI. - To use biometric recognition, a device must have a camera with a face image pixel greater than 100x100. - The device must have a TEE, where encrypted facial characteristics are stored. - Facial recognition may not work for people with similar looks and children whose facial features keep changing. If you are concerned about this, consider using other authentication modes. diff --git a/en/contribute/contribution-process.md b/en/contribute/contribution-process.md index de1dc328fe27122ddc3b5a9f977b75709c74782e..a477b8658a0915049cdd23f6dc994d7c6a7b06a9 100755 --- a/en/contribute/contribution-process.md +++ b/en/contribute/contribution-process.md @@ -1,12 +1,5 @@ # Contribution Process -- [Preparations](#section124971410183614) -- [Downloading Code](#section6125202333611) -- [Committing Code](#section338918220422) -- [Creating a Pull Request](#section28261522124316) -- [Building Access Control](#section981124754415) -- [Reviewing Code](#section17823849145014) - ## Preparations - Install, configure, and use Git. For details, visit [https://gitee.com/help/categories/43](https://gitee.com/help/categories/43). diff --git a/en/contribute/faqs.md b/en/contribute/faqs.md index d12e7680aa521062ece5d1a6ea41f6b95c918265..ec7ef6d5de3e99875995e98a2e780ee520506652 100755 --- a/en/contribute/faqs.md +++ b/en/contribute/faqs.md @@ -1,15 +1,5 @@ # FAQs -[How Do I Create PRs at the Same Time If Multiple Code Repositories Have Compilation Dependencies?](#section169732563435) - -[Sign-off-by Operations](#section-sign-off) - -[Handling Exceptions of DCO Verification](#section-dco) - -[Rollback](#section479422315253) - -[Resolving Merge Conflicts](#section94417232274) - ## How Do I Create PRs at the Same Time If Multiple Code Repositories Have Compilation Dependencies? During the development of the operating system \(OS\), it is common that multiple code repositories have compilation dependencies. Therefore, the PRs need to be created and merged at the same time. For this reason, Gitee uses issues as the association identifiers for code repositories with dependency dependencies to commit the PRs. Follow the operations below: diff --git a/en/contribute/template/readme-template.md b/en/contribute/template/readme-template.md index 127a3fc8b4483e13c80c0d6cdbf95e52a7e3e58b..0767214385422886ea50b3bfc291e15da25a7581 100644 --- a/en/contribute/template/readme-template.md +++ b/en/contribute/template/readme-template.md @@ -1,13 +1,5 @@ # ***ExampleName*** Subsystem/Part -- [Introduction](#Introduction) -- [Directory Structure](#Directory-Structure) -- [Constraints](#Constraints) -- [Compilation and Building](#Compilation-and-Building) -- [Usage](#Usage) - - [Available APIs](#Available-APIs) - - [How to Use](#How-to-Use) -- [Repositories Involved](#Repositories-Involved) [Title Description] Use **Subsystem** or **Part** based on the Readme file type. diff --git a/en/device-dev/Readme-EN.md b/en/device-dev/Readme-EN.md index e0c8070e8fe4feb3b8f3e65b3ff78d3c952bc668..91e7aa031b2f79291b219d5374d6ae7f4c4eb692 100644 --- a/en/device-dev/Readme-EN.md +++ b/en/device-dev/Readme-EN.md @@ -1,8 +1,5 @@ # Overview -- [System Types](#section767218232110) -- [Document Outline](#section19810171681218) - This topic provides a panorama of all documents for you to obtain helpful information quickly. These documents are classified based on your learning progress and development scenarios of OpenHarmony. ## System Types diff --git a/en/device-dev/bundles/bundles-demo-environment.md b/en/device-dev/bundles/bundles-demo-environment.md index ac3cbf3b0b19c60d50d847b7cbe03e767663790e..1c73ff4b5cdf26909ca3b5b358308eebd8d8db60 100644 --- a/en/device-dev/bundles/bundles-demo-environment.md +++ b/en/device-dev/bundles/bundles-demo-environment.md @@ -1,12 +1,5 @@ # Configuring the Compilation Environment -- [Linux Server](#section20979554791) -- [Node.js](#section9954105413153) -- [Installing hpm-cli Tool](#section15937194904819) -- [Python Environment](#section1621819180417) -- [File Packaging Tool](#section77617165913) -- [SCons](#section20558439191516) - ![](figure/3516dv300.png) ## Linux Server diff --git a/en/device-dev/bundles/bundles-guide-develop.md b/en/device-dev/bundles/bundles-guide-develop.md index a562a010d592217e9264cad36d5d1a36ee507893..efa3450cc1e0a4fb235bc000aba63421fe8e623c 100644 --- a/en/device-dev/bundles/bundles-guide-develop.md +++ b/en/device-dev/bundles/bundles-guide-develop.md @@ -1,17 +1,5 @@ # Developing Bundles -- [Creating a Bundle](#section717481119145) -- [Defining an Existing Project as a Bundle](#section102861955201410) -- [Releasing the Bundle on the HPM Platform](#section1318574233211) -- [Referencing a Bundle](#section19311124115315) -- [Installing a Bundle Globally](#section165131927192120) -- [Compiling a Bundle](#section136732148541) -- [Defining the Build Script](#section10274147111610) -- [Executing the Build Script](#section879301916172) -- [Defining a Distribution](#section413216495619) -- [Defining Scripts](#section11503171219190) -- [Building a Distribution](#section4694125521912) - You can use any of the following methods to develop OpenHarmony bundles: - Create a new bundle from scratch. diff --git a/en/device-dev/bundles/bundles-guide-overview.md b/en/device-dev/bundles/bundles-guide-overview.md index 445312c962065ba5fc1a8f06e90f89dc1505caab..0b2ed40a84f3725f8c611e0944998ee8916e14be 100644 --- a/en/device-dev/bundles/bundles-guide-overview.md +++ b/en/device-dev/bundles/bundles-guide-overview.md @@ -1,7 +1,5 @@ # Overview -- [Bundle](#section196713235514) -- [Distribution](#section155387501033) This section describes the bundle-specific concepts in HarmonyOS. It uses an example to step you through how to create, develop, build, release, and install a bundle using the **hpm-cli** tool. @@ -37,5 +35,5 @@ A distribution is a complete HarmonyOS release that integrates various bundles, **Figure 1** Relationship between bundles and a distribution -![](figure/组件和发行版的构成-英文.png) +![](figure/bundle-distribution.png) diff --git a/en/device-dev/bundles/bundles-guide-prepare.md b/en/device-dev/bundles/bundles-guide-prepare.md index 865279a0f1c34462045c70f2d405cd468f35e30a..a0ee4d7714a74b64ecdc5e5b31cc217ff30ddcce 100644 --- a/en/device-dev/bundles/bundles-guide-prepare.md +++ b/en/device-dev/bundles/bundles-guide-prepare.md @@ -1,9 +1,5 @@ # Installing hpm-cli Tool -- [Installing Node.js and hpm](#section106591616205311) -- [\(Optional\) Configuring hpm](#section71821165412) -- [Downloading OpenHarmony Code](#section102338221707) - To develop a bundle, you first need to install the HarmonyOS Package Manager \(hpm\), a cross-platform command line tool developed based on Node.js. To run the hpm, you need to install Node.js, and then install the hpm using the Node Package Manager \(npm\). ## Installing Node.js and hpm diff --git a/en/device-dev/bundles/bundles-standard-rules.md b/en/device-dev/bundles/bundles-standard-rules.md index cebbd0a3459341f6ff7770122774f188809a20a0..7c546461079b84e3b6fafdd3a6fb78ba4bfaf683 100644 --- a/en/device-dev/bundles/bundles-standard-rules.md +++ b/en/device-dev/bundles/bundles-standard-rules.md @@ -1,26 +1,5 @@ # Bundle Development Specifications -- [Overview](#section1725818533344) - - [Definition](#section4821219183514) - - [Bundle Division Rules](#section1089794263513) - - [Bundle Dependency](#section25701647163710) - -- [Bundle Composition](#section185538333914) - - [Code Files](#section8431268393) - - [README File](#section168121548173914) - - [Metadata Description File](#section7107181819406) - -- [Bundle Management](#section32061634104110) - - [Dependency](#section791115242423) - - [HPM Command Reference](#section1183205411429) - -- [Bundle Version](#section12612142864316) - - [Version Number Naming Specifications](#section1487612416432) - - [Version Publishing](#section1548171014440) - -- [Distribution](#section1264139114413) -- [Environment Variables](#section15352105174512) - ## Overview This document describes the basic concepts of a bundle and how to define it in compliance with specifications. diff --git "a/en/device-dev/bundles/figure/\347\273\204\344\273\266\345\222\214\345\217\221\350\241\214\347\211\210\347\232\204\346\236\204\346\210\220-\350\213\261\346\226\207.png" b/en/device-dev/bundles/figure/bundle-distribution.png similarity index 100% rename from "en/device-dev/bundles/figure/\347\273\204\344\273\266\345\222\214\345\217\221\350\241\214\347\211\210\347\232\204\346\236\204\346\210\220-\350\213\261\346\226\207.png" rename to en/device-dev/bundles/figure/bundle-distribution.png diff --git a/en/device-dev/driver/driver-hdf-development.md b/en/device-dev/driver/driver-hdf-development.md index b33052bf687c836944c115b573028446ec195224..e621198cf80240a8009212b3be53592fc2a9d179 100644 --- a/en/device-dev/driver/driver-hdf-development.md +++ b/en/device-dev/driver/driver-hdf-development.md @@ -1,8 +1,5 @@ # Driver Development -- [Driver Model](#section157425168112) -- [How to Develop](#section1969312275533) - ## Driver Model The HDF is designed based on the component-based driver model. This model allows refined driver management and normalizes driver development and deployment. Device drivers of the same type are placed in the same host. You can develop and deploy the drivers separately. One driver can have multiple nodes. [Figure 1](#fig3580184214210) shows the HDF driver model. diff --git a/en/device-dev/driver/driver-hdf-manage.md b/en/device-dev/driver/driver-hdf-manage.md index db1adbb6d5d0a9149fa245b34efd5319bf1696dd..1481fec76a6eb1ef3391de5b665ff3c1a981557c 100644 --- a/en/device-dev/driver/driver-hdf-manage.md +++ b/en/device-dev/driver/driver-hdf-manage.md @@ -1,22 +1,5 @@ # Driver Configuration Management -- [HDF Configuration Overview](#section59914284576) -- [Configuration Syntax](#section533713333580) - - [Keywords](#section4522107333) - - [Basic Structures](#section853042911312) - - [Data Types](#section177001259134) - - [Pre-Processing](#section14867121641) - - [Comments](#section1323412417) - - [Reference Modifications](#section193708571145) - - [Node Replication](#section1487792020513) - - [Delete](#section1096515391155) - - [Attribute References](#section20271317611) - - [Template](#section958819191063) - -- [Configuration Generation](#section106152531919) - - [Introduction to hc-gen](#section359734416616) - - ## HDF Configuration Overview HCS is the source code that describes the configuration of the HDF using key-value pairs. It decouples the configuration code from driver code, thereby facilitating configuration management. diff --git a/en/device-dev/driver/driver-hdf-message-management.md b/en/device-dev/driver/driver-hdf-message-management.md index 0ddcc4901fa34b10914b56d66268ad490491212e..14faab8e4025383db1d0e468c93b385d8fa8ebd4 100644 --- a/en/device-dev/driver/driver-hdf-message-management.md +++ b/en/device-dev/driver/driver-hdf-message-management.md @@ -1,9 +1,5 @@ # Driver Message Mechanism Management -- [When to Use](#section33014541954) -- [Available APIs](#section538852311616) -- [How to Develop](#section946912121153) - ## When to Use When user-level applications need to interact with kernel-level drivers, the driver message mechanism of the HDF can be used. diff --git a/en/device-dev/driver/driver-hdf-overview.md b/en/device-dev/driver/driver-hdf-overview.md index 115488b2dedf703f60cd57316bd199226d9628a9..c66ffc4d1627d2938517f4dd6d0b066edada4f0f 100644 --- a/en/device-dev/driver/driver-hdf-overview.md +++ b/en/device-dev/driver/driver-hdf-overview.md @@ -1,10 +1,5 @@ # HDF Overview -- [Introduction](#section0649162112376) -- [Driver Loading](#section68701942154319) -- [Driver Service Management](#section12453133414412) -- [Driver Message Mechanism](#section129410710451) - ## Introduction The Hardware Driver Foundation \(HDF\) provides the following driver framework capabilities: driver loading, driver service management, and driver message mechanism. This unified driver architecture platform is designed to provide a more precise and efficient development environment, where you can perform one-time development and multi-system deployment. diff --git a/en/device-dev/driver/driver-hdf-sample.md b/en/device-dev/driver/driver-hdf-sample.md index 56e8e4526df79e1a530210a3e31f63838ca732e5..1c06c77022089eb7a52198d7e61ab1e5693736b0 100644 --- a/en/device-dev/driver/driver-hdf-sample.md +++ b/en/device-dev/driver/driver-hdf-sample.md @@ -1,9 +1,5 @@ # HDF Development Example -- [Adding Configuration](#section27261067111) -- [Compiling the Driver Code](#section177988005) -- [Compiling the Code for Interaction](#section6205173816412) - The following example shows how to add driver configuration, compile the driver code, and implement interaction between the user-state applications and the driver. ## Adding Configuration diff --git a/en/device-dev/driver/driver-hdf-servicemanage.md b/en/device-dev/driver/driver-hdf-servicemanage.md index c979929089d87bfac749151989c5c90cbf790826..0e5485bfb882de99c150af31a9f57d6c352614d4 100644 --- a/en/device-dev/driver/driver-hdf-servicemanage.md +++ b/en/device-dev/driver/driver-hdf-servicemanage.md @@ -1,8 +1,5 @@ # Driver Service Management -- [When to Use](#section14244270117) -- [Available APIs](#section1432412561722) -- [How to Develop](#section393515164416) Driver services are objects of open capabilities provided by the HDF and are managed by the HDF in a unified manner. Using driver service management, you can release and obtain driver services. diff --git a/en/device-dev/driver/driver-peripherals-audio-des.md b/en/device-dev/driver/driver-peripherals-audio-des.md index 7529e34c2392c6661ec30ce34b2f62aead119457..09e81e82172012608dee4e3711f77345db5be608 100644 --- a/en/device-dev/driver/driver-peripherals-audio-des.md +++ b/en/device-dev/driver/driver-peripherals-audio-des.md @@ -1,54 +1,5 @@ # Audio -- **[Audio Driver Overview](#section1000)** - -- **[Audio Driver Architecture](#section2000)** - -- **[Audio Driver Development](#section3000)** - - - **[Audio ADM Architecture](#section3100)** - - [Startup Process](#section3111) - - [Playback Process](#section3112) - - [Control Process](#section3113) - - - **[Audio Driver Development Procedure](#section3200)** - - [Development on an Adapted Platform](#section3221) - - [Development on a New Platform](#section3222) - -- **[Audio Driver Development Examples](#section4000)** - - [Codec Driver Development Example](#section4100) - - [Filling in Codec Data Structures](#section4111) - - [Initializing the Codec Device and Codec DAI Device](#section4112) - - [Implementing the Codec Operation Function Set](#section4113) - - [Registering and Binding Codec to HDF](#section4114) - - [Configuring HCS](#section4115) - - [Accessory Driver Development Example](#section4200) - - [Filling in Accessory Data Structures](#section4221) - - [Initializing the Accessory Device and Accessory DAI Device](#section4222) - - [Implementing the Accessory Operation Function Set](#section4223) - - [Registering and Binding Accessory to HDF](#section4224) - - [Configuring HCS](#section4225) - - [Platform Driver Development Example](#section4300) - - [Filling in Platform Data Structures](#section4331) - - [Initializing the DMA Device](#section4332) - - [Implementing the DMA Operation Function Set](#section4333) - - [Registering and Binding Platform to HDF](#section4334) - - [Configuring HCS](#section4335) - - [DAI Driver Development Example](#section4400) - - [Filling in DAI Data Structures](#section4441) - - [Initializing the DAI Device](#section4442) - - [Implementing the DAI Operation Function Set](#section4443) - - [Registering and Binding DAI to HDF](#section4444) - - [Configuring HCS](#section4445) - - [Adding Compilation Configuration to Makefile](#section4500) - - [Source Code Structure and Directory](#section4600) - -- **[HAL-based Development Procedure and Example](#section5000)** - - [Development Procedure](#section5100) - - [Development Example](#section5200) - -- **[Summary](#section9999)** - # Audio Driver Overview A multimedia system is an indispensable part in Internet of Things (IoT) devices. Audio is an important module of the multimedia system, and building an audio driver model is particularly important in device development. diff --git a/en/device-dev/driver/driver-peripherals-camera-des.md b/en/device-dev/driver/driver-peripherals-camera-des.md index 24cf34f94b702f7c3fe7439adf8ae6df0bc04e38..cca003d566f83eaca6bb53af314ff22676de6495 100644 --- a/en/device-dev/driver/driver-peripherals-camera-des.md +++ b/en/device-dev/driver/driver-peripherals-camera-des.md @@ -1,13 +1,6 @@ # Camera -- [Introduction](#section353860995163604) -- [Development Guidelines](#section1291233039163604) - - [Available APIs](#section1192025723163604) - - [How to Develop](#section1407626053163604) - -- [Development Example](#section605457993163604) - -## Introduction +## Overview The OpenHarmony camera driver model implements the camera hardware driver interface \(HDI\) and the camera pipeline model to manage camera devices. @@ -20,8 +13,8 @@ The camera driver model consists of the following layers: - Adaptation layer: shields the differences between bottom-layer chips and OSs for multi-platform adaptation. -**Figure 1** Architecture of the camera driver model -![](figures/architecture-of-the-camera-driver-model.png "architecture-of-the-camera-driver-model") +**Figure 1** Architecture of the camera driver model +![](figures/camera-driver-model-architecture.png "camera-driver-model-architecture") 1. The CameraDeviceHost process is created during system startup. The process enumerates underlying devices, creates a **DeviceManager** instance that manages the device tree, an object for each underlying device, and a **CameraHost** instance, and registers the **CameraHost** instance with the UHDF service. Through this service, the upper layer can obtain the CameraDeviceHost process at the bottom layer to operate the underlying devices. Note that the **DeviceManager** instance can also be created by using the configuration table. @@ -42,13 +35,13 @@ The camera driver model consists of the following layers: 9. To implement dynamic frame control, a CollectBuffer thread is started in the StreamOperator. The CollectBuffer thread obtains a buffer from the buffer queue of each stream. If the frame rate of a stream needs to be controlled \(1/n of the sensor output frame rate\), the CollectBuffer thread can control the buffer packaging of each frame as required, and determine whether to collect the buffer of the stream. For example, if the output frame rate of the sensor is 120 fps and the preview stream frame rate is 30 fps, the CollectBuffer thread collects the buffer of the preview stream every 4 fps. -## Development Guidelines +## Development Guidelines -### Available APIs +### Available APIs For details about the HDI functionalities and the function passing rules, see "Available APIs" in [Camera](https://gitee.com/openharmony/drivers_peripheral/blob/master/camera/README_zh.md). -### How to Develop +### How to Develop The following describes the main APIs of the camera driver model, including the APIs for registering and detecting cameras, creating, capturing, and destroying streams, and enabling and disabling devices. \(To clearly describe the implementation of main functionalities, some error judgment and log source code are not described here.\) @@ -406,7 +399,7 @@ The following describes the main APIs of the camera driver model, including the Use the **Close\(\)** interface in the **CameraDeviceImpl** class to close the camera device. This interface calls **PowerDown\(\)** in the **DeviceManager** to power off the device. -## Development Example +## Development Example There is a camera demo in the **/drivers/peripheral/camera/hal/init** directory. After system startup, the executable file **ohos\_camera\_demo** is generated in the **/system/bin** directory. This demo can implement basic camera capabilities such as preview and photographing. The following uses the demo as an example to describe how to use the HDI to implement the **PreviewOn\(\)** and **CaptureON\(\)** interfaces. diff --git a/en/device-dev/driver/driver-peripherals-external-des.md b/en/device-dev/driver/driver-peripherals-external-des.md index 6520f590885d35a5201dbab3d01c4173cbf85527..fc358c852ff3678a5b863a80b0f533fd514b4458 100644 --- a/en/device-dev/driver/driver-peripherals-external-des.md +++ b/en/device-dev/driver/driver-peripherals-external-des.md @@ -1,12 +1,5 @@ # WLAN -- [Overview](#section729758162218) - - [WLAN Driver API Architecture](#section178022416377) - -- [Available APIs](#section7331102018815) -- [How to Develop](#section15957746172412) -- [Development Example](#section1395253612512) - ## Overview The WLAN module is developed based on the Hardware Driver Foundation \(HDF\). It supports cross-OS migration, component adaptation, and modular assembly and compilation. Based on the unified APIs provided by the WLAN module, driver developers of WLAN vendors can adapt their driver code and are capable of creating, disabling, scanning, and connecting to WLAN hotspots. The WLAN driver provides the Hardware Driver Interface \(HDI\) layer with the capabilities of setting and obtaining the device MAC address and setting the transmit power. The following figure shows the framework of the WLAN module: diff --git a/en/device-dev/driver/driver-peripherals-lcd-des.md b/en/device-dev/driver/driver-peripherals-lcd-des.md index 5d647c1ef836e539597a9c8203020f7c03634b66..0bed487f6cfde1253b21755f60d8ad9a8ee50e1d 100644 --- a/en/device-dev/driver/driver-peripherals-lcd-des.md +++ b/en/device-dev/driver/driver-peripherals-lcd-des.md @@ -1,10 +1,5 @@ # LCD -- [Overview](#section141575391542) -- [API Description](#section53793327396) -- [How to Develop](#section12394223125615) -- [Development Example](#section7441155155813) - ## Overview The Liquid Crystal Display \(LCD\) driver powers on the LCD and initializes internal LCD registers through APIs to enable the LCD to work properly. The display driver is developed based on the hardware driver foundation \([HDF](driver-hdf-overview.md)\). It provides power-on, power-off, and sending of the initialization sequence for LCD hardware across OSs and platforms. The display driver model is shown in [Figure 1](#fig69138814229). diff --git a/en/device-dev/driver/driver-peripherals-sensor-des.md b/en/device-dev/driver/driver-peripherals-sensor-des.md index f8720e9754ef2b0a1135f4b51a2c6d20be683884..4b54238b70d642fbc49825ef2324d9bc31644def 100644 --- a/en/device-dev/driver/driver-peripherals-sensor-des.md +++ b/en/device-dev/driver/driver-peripherals-sensor-des.md @@ -1,11 +1,5 @@ # Sensor -- [Overview](#section3634112111) -- [Available APIs](#section20930112117478) -- [How to Develop](#section1140943382) -- [Development Example](#section257750691) -- [Test Guidelines](#section106021256121219) - ## Overview The sensor driver module provides APIs for upper-layer sensor services to implement basic sensor capabilities, including querying the sensor list, enabling or disabling a sensor, subscribing to or unsubscribing from sensor data, and setting sensor options. The sensor driver model is developed based on the Hardware Driver Foundation \(HDF\) and supports functions such as cross-OS migration and differentiated device configuration. The following figure shows the architecture of the sensor driver model. diff --git a/en/device-dev/driver/driver-peripherals-touch-des.md b/en/device-dev/driver/driver-peripherals-touch-des.md index efe110318e3066c708d341a7f6ef32f7f3703a4b..15c1892db7902caa09c05182bae61ac9cdc35c16 100644 --- a/en/device-dev/driver/driver-peripherals-touch-des.md +++ b/en/device-dev/driver/driver-peripherals-touch-des.md @@ -1,14 +1,5 @@ # Touchscreen -- [Overview](#section175431838101617) -- [Available APIs](#section105459441659) -- [How to Develop](#section65745222184) -- [Development Example](#section263714411191) - - [Adding the Touchscreen Driver-related Description](#section18249155619195) - - [Adding Board Configuration and Touchscreen Private Configuration](#section3571192072014) - - [Adding the Touchscreen Driver](#section6356758162015) - - ## Overview - **Functions of the Touchscreen driver** diff --git a/en/device-dev/driver/driver-peripherals-usb-des.md b/en/device-dev/driver/driver-peripherals-usb-des.md index 0658b9dec90c975afe71f7f0e9d3edb6d1d215a6..b49faeb7ca96fee8a68fabc137a5138ae4c644cc 100644 --- a/en/device-dev/driver/driver-peripherals-usb-des.md +++ b/en/device-dev/driver/driver-peripherals-usb-des.md @@ -1,18 +1,5 @@ # USB -- [Overview](#section127mcpsimp) - - [Available APIs](#section141mcpsimp) - -- [Development Guidelines](#section581mcpsimp) - - [Developing Driver Using Host DDK APIs](#section584mcpsimp) - - [Developing Driver Using Host Raw APIs](#section594mcpsimp) - - [Developing Driver Using Device DDK APIs](#section600mcpsimp) - -- [Development Examples](#section607mcpsimp) - - [Developing Driver Using Host DDK APIs](#section609mcpsimp) - - [Developing Driver Using Host Raw APIs](#section612mcpsimp) - - [Developing Driver Using Device DDK APIs](#section615mcpsimp) - ## Overview diff --git a/en/device-dev/driver/driver-platform-adc-develop.md b/en/device-dev/driver/driver-platform-adc-develop.md index 4f5753bbed8f51339d7e2b9e6c082dc934ec2616..ef511390aed3ecf668542ea2f78b307267d58fcf 100644 --- a/en/device-dev/driver/driver-platform-adc-develop.md +++ b/en/device-dev/driver/driver-platform-adc-develop.md @@ -1,10 +1,5 @@ # ADC -- [Overview](#section268031773165048) -- [How to Develop](#section100579767165048) - - [AdcMethod](#section1618135285210) - -- [Development Example](#section1745221471165048) ## Overview diff --git a/en/device-dev/driver/driver-platform-gpio-des.md b/en/device-dev/driver/driver-platform-gpio-des.md index 1635338698156e5f8d22c4c3643f3fd795b0b2d7..356c30a3075382a03164112e2ca90690a87a7481 100644 --- a/en/device-dev/driver/driver-platform-gpio-des.md +++ b/en/device-dev/driver/driver-platform-gpio-des.md @@ -1,13 +1,5 @@ # GPIO -- [Overview](#section1635911016188) -- [Available APIs](#section589913442203) -- [Usage Guidelines](#section259614242196) - - [How to Use](#section103477714216) - - [Determining a GPIO Pin Number](#section370083272117) - - [Using APIs to Operate GPIO Pins](#section13604050132118) - -- [Usage Example](#section25941262111) ## Overview diff --git a/en/device-dev/faqs/burning.md b/en/device-dev/faqs/burning.md index 489443726730ba56c3df633d44c9ac090e77fe42..c157de63787c14d919c9a9b271849bcbfa27b7a0 100644 --- a/en/device-dev/faqs/burning.md +++ b/en/device-dev/faqs/burning.md @@ -1,11 +1,5 @@ # Burning -- [Mini and Small Systems](#section278314413530) - - ["Error: Opening COMxx: Access denied" Is Displayed After a Serial Port Is Selected for Burning](#section18988185615914) - - [What should I do when the image failed to be burnt?](#section1370982513317) - - [What should I do when no command output is displayed?](#section183421944953) - - [What should I do when Windows-based PC failed to be connected to the board?](#section1215410450215) - ## Mini and Small Systems diff --git a/en/device-dev/faqs/compilation-and-building-subsystem.md b/en/device-dev/faqs/compilation-and-building-subsystem.md index 5bc568ead1f3a8fd282c354632bb781de04de325..26b0cab34e7681171e5f04149a7c76b6bda7b93a 100644 --- a/en/device-dev/faqs/compilation-and-building-subsystem.md +++ b/en/device-dev/faqs/compilation-and-building-subsystem.md @@ -1,17 +1,5 @@ # Compilation and Building Subsystem -- [Mini and Small Systems](#section78686441462) - - [Invalid -- w Option](#section67961431372) - - [Library ncurses Not Found](#section199631617371) - - [mcopy not Found](#section937435175) - - [No riscv File or Directory](#section1115535018713) - - [No Crypto](#section17982573813) - - [Unexpected Operator](#section53663205819) - - [What should I do when the message Could not find a version that satisfies the requirement six\>=1.9.0 is displayed during compilation and building?](#section1917790845) - - [What should I do when the message cannot find -lgcc is displayed during compilation and building?](#section141771701647) - - [What should I do when the message indicating Python cannot be found is displayed during compilation and building?](#section51781202415) - - [What should I do when the message indicating Python 3 cannot be found is displayed during compilation and building?](#section1917950148) - ## Mini and Small Systems diff --git a/en/device-dev/faqs/environment-setup.md b/en/device-dev/faqs/environment-setup.md index 2213897bdda18bb783464d0287102c2fc6c19533..53e738880da3a93b2467a857c85784538ef83c03 100644 --- a/en/device-dev/faqs/environment-setup.md +++ b/en/device-dev/faqs/environment-setup.md @@ -1,17 +1,5 @@ # Environment Setup -- [Mini and Small Systems](#section1742119306399) - - [What should I do if garbled characters and segmentation faults occur during hb installation?](#section36351051193919) - - [What should I do if the message "cannot import 'sysconfig' from 'distutils'" is displayed during hb installation?](#section48221013144011) - - [What should I do if the message "module 'platform' has no attribute 'linux\_distribution'" is displayed during hb installation?](#section10307193044111) - - [What should I do if the message "Could not find a version that satisfies the requirement ohos-build" is displayed during hb installation?](#section8692735427) - - [What should I do when the message configure: error: no acceptable C compiler found in $PATH is displayed during Python 3 installation?](#section870082884217) - - [What should I do when the message -bash: make: command not found is displayed during Python 3 installation?](#section198707170455) - - [What should I do when the message zlib not available is displayed during Python 3 installation?](#section85401445204518) - - [What should I do when the message No module named '\_ctypes' is displayed during Python 3 installation?](#section12202694460) - - [What should I do when an error with lsb\_release occurs during kconfiglib installation?](#section5803174135115) - - [What should I do if the message "ImportError: No module named apt\_pkg" is displayed during the execution of an unidentifiable command?](#section510820516515) - ## Mini and Small Systems diff --git a/en/device-dev/faqs/kernel.md b/en/device-dev/faqs/kernel.md index 3a117be17d4ee2bf71358d2ba7339dba149e8cd7..a25e097ccf90f01df92b34a47265dc1efd86a344 100644 --- a/en/device-dev/faqs/kernel.md +++ b/en/device-dev/faqs/kernel.md @@ -1,27 +1,5 @@ # Kernel -- [Basic Kernel](#section263912372168) - - [What are the differences between APIs provided by LiteOS-A and LiteOS-M?](#section447571122918) - - [How do I analyze thread stack overflow?](#section8623141711293) - -- [File System](#section098519592162) - - [What should I do when the Hi3516 board fails to open the same file in write mode \(LiteOS-A\)?](#section517972255311) - - [What hardware platforms are supported by the LiteOS kernel?](#section868413518533) - - [What chip architectures are supported by the LiteOS kernel?](#section1131661465417) - -- [Third-party Components](#section971818231178) - - [What third-party components are supported by OpenHarmony?](#section74138185411) - - [What should I do if the key length verification fails when OpenSSL is used on OpenHarmony?](#section10564614135516) - - [Does setsockopt support SO\_RCVBUF and SO\_SNDBUF?](#section2093373215556) - -- [Compilation and Linking](#section10955302179) - - [How do I run an application developed by ARM Linux on LiteOS-A?](#section1164175713557) - - [What system is used for OpenHarmony compilation? What compiler is used?](#section132287223567) - - [For a third-party component that is independently compiled into a static library and used on LiteOS-M, what should I do when the component's global variable value is incorrect or the system is suspended after the component's function is called?](#section15189154225619) - - [What should I do if the message "use VFP register arguments, xxx.o does not" is displayed when LiteOS-A generates a target executable file?](#section193571012578) - - [What should I do when calling clock\_gettime obtains an incorrect time?](#section8973152015717) - - ## Basic Kernel ### What are the differences between APIs provided by LiteOS-A and LiteOS-M? diff --git a/en/device-dev/faqs/overview-of-faqs.md b/en/device-dev/faqs/overview-of-faqs.md index b196c7ffe80e5337abf463a338bd15620bb1c673..6d82025232efc2e33f1602c5dd292b3a20f8eec7 100644 --- a/en/device-dev/faqs/overview-of-faqs.md +++ b/en/device-dev/faqs/overview-of-faqs.md @@ -1,29 +1,5 @@ # Overview of FAQs -- [Environment Setup](#section93289248249) - - [Mini and Small Systems](#section197234983111) - -- [Compilation and Building](#section18826114693810) - - [Mini and Small Systems](#section693410399) - -- [Burning](#section6556741113712) - - [Mini and Small Systems](#section1029933713812) - -- [Kernel](#section13741125564211) - - [Basic Kernel](#section1723365191114) - - [File System](#section14523145918136) - - [Chip Adaptation](#section141541939159) - - [Third-party Components](#section4988163321816) - - [Compilation and Linking](#section080219574225) - -- [Porting](#section129331824154313) -- [Startup and Recovery](#section83501764443) -- [System Services](#section19567132114455) - - [Utils](#section3214181711465) - - [Visual Applications](#section295651815466) - - [HDC](#section178081876506) - - FAQs are used to help developers solve problems frequently encountered during development. They cover a wide range of topics. ## Environment Setup diff --git a/en/device-dev/faqs/porting.md b/en/device-dev/faqs/porting.md index d3cc2944c4484b600ab72e10db7593b8f3a5f969..d7432b77f994d3043e16569bd719a3b3741109ff 100644 --- a/en/device-dev/faqs/porting.md +++ b/en/device-dev/faqs/porting.md @@ -1,7 +1,5 @@ # Porting -- [How Do I Mount the Heap Memory to the Kernel?](#section21471536184914) - ## How Do I Mount the Heap Memory to the Kernel? - The following table describes the macros for configuring the kernel heap memory. You can configure them as required in the **target\_config.h** file. diff --git a/en/device-dev/faqs/startup-and-recovery.md b/en/device-dev/faqs/startup-and-recovery.md index 5bd7afc74519b3f039a4eba46101c43e186df8f9..dec59820e73795b8be9428966db9a05bc46aca71 100644 --- a/en/device-dev/faqs/startup-and-recovery.md +++ b/en/device-dev/faqs/startup-and-recovery.md @@ -1,9 +1,5 @@ # Startup and Recovery -- [System startup interrupted due to "parse failed!" error](#section835662214302) -- [System automatically restarted again and again](#section3857921143117) -- [Failed to call the SetParameter or GetParameter API with correct parameter values](#section548818116328) - ## System startup interrupted due to "parse failed!" error **Problem** diff --git a/en/device-dev/faqs/system-applications.md b/en/device-dev/faqs/system-applications.md index 7bf65b072da8d9e09673adb02808ccf9b4319607..8be8a965d7090a42f3f475d9d7dfdac838343c87 100644 --- a/en/device-dev/faqs/system-applications.md +++ b/en/device-dev/faqs/system-applications.md @@ -1,31 +1,5 @@ # System Applications -- [Utils](#section639433461512) - - [1. Failure in running the KV store on the LiteOS-A kernel \(Hi3516 or Hi3518\) due to incorrect path setting for the KV store](#section16520347131511) - -- [Visual Applications](#section787718474161) - - [Is there a global variable that can be accessed by all pages?](#section187297991718) - - [How do I obtain DOM elements?](#section1833493719175) - - [How do I pass values between pages?](#section184283812183) - - [How do I scroll a list to an item?](#section11897734131811) - - [Does the component support multiple lines?](#section5872656121814) - - [Why is a component not displayed?](#section7397125317107) - - [How do I implement scrolling on a page?](#section338794422010) - - [Why do not the left and top attributes take effect?](#section2597193611217) - - [Why does not dynamic binding take effect?](#section6939050172115) - - [How do I implement relative and absolute positioning?](#section5547311192215) - - [How do I display or hide a component?](#section16107113352213) - - [What are the precautions for using the margin attribute?](#section1524910142314) - - [What are the precautions for event subscription?](#section1537132012231) - - [What are the precautions for using dynamic binding?](#section96561452236) - - [How does the loop attribute take effect for ?](#section690166112414) - - [What are the precautions for using an array?](#section1554552822414) - -- [HDC](#section412357182518) - - [hdc\_std Fails to Connect to a Device](#section1965012223257) - - [hdc\_std Fails to Run](#section1157575212515) - - ## Utils ### 1. Failure in running the KV store on the LiteOS-A kernel \(Hi3516 or Hi3518\) due to incorrect path setting for the KV store diff --git a/en/device-dev/get-code/gettools-acquire.md b/en/device-dev/get-code/gettools-acquire.md index e3ae77ea8fbd29fb22bdf330c6e22dd724c2ac0e..4b00335c966bbedd4be221e0aaab63d4212653d5 100644 --- a/en/device-dev/get-code/gettools-acquire.md +++ b/en/device-dev/get-code/gettools-acquire.md @@ -1,18 +1,5 @@ # Docker Environment -- [Introduction](#section107932281315) -- [Preparations](#section7337134183512) -- [Standalone Docker Environment](#section2858536103611) - - [Setting Up the Docker Environment for Mini-System Devices \(reference memory ≥ 128 KB\) and Small-System Devices \(reference memory ≥ 1 MB\)](#section319412277287) - - [Building for Mini-System Devices \(reference memory ≥ 128 KB\) and Small-System Devices \(reference memory ≥ 1 MB\)](#section631485163615) - - [Setting Up the Docker Environment for Standard-System Devices \(reference memory ≥ 128 MB\)](#section13585262391) - - [Building for Standard-System Devices \(reference memory ≥ 128 MB\)](#section193711513406) - -- [HPM-based Docker Environment](#section485713518337) - - [Setting Up the Docker Environment](#section3295842510) - - [Obtaining and Building Source Code](#section69141039143518) - - ## Introduction OpenHarmony provides the following two types of Docker environments for you to quickly get the development environment ready: diff --git a/en/device-dev/get-code/gettools-ide.md b/en/device-dev/get-code/gettools-ide.md index 138891d11b6023f24eb912bdb8d2b52c5b78bb7f..fe65c0b2faf9b9191d4c76a20f3edaa22c2bde54 100644 --- a/en/device-dev/get-code/gettools-ide.md +++ b/en/device-dev/get-code/gettools-ide.md @@ -1,8 +1,5 @@ # IDE -- [Acquiring the Device Development Tool \(HUAWEI DevEco Device Tool\)](#section2452141120244) -- [Acquiring the Application Development Tool \(HUAWEI DevEco Studio\)](#section0904101019258) - ## Acquiring the Device Development Tool \(HUAWEI DevEco Device Tool\) HUAWEI DevEco Device Tool is a one-stop integrated development environment \(IDE\) provided to develop applications for OpenHarmony devices. It allows on-demand customization of OpenHarmony components, code editing, building, burning, and debugging, and supports C and C++ languages. This tool is installed in Visual Studio Code as a plug-in. For details, see [HUAWEI DevEco Device Tool](https://device.harmonyos.com/en/ide) and [HUAWEI DevEco Device Tool User Guide](https://device.harmonyos.com/en/docs/ide/user-guides/service_introduction-0000001050166905). diff --git a/en/device-dev/get-code/sourcecode-acquire.md b/en/device-dev/get-code/sourcecode-acquire.md index 7b283e10cd64fdab6052fa9a723424f52a3591af..205d59463d81f2ed33a64f46f3b652836821e4ca 100644 --- a/en/device-dev/get-code/sourcecode-acquire.md +++ b/en/device-dev/get-code/sourcecode-acquire.md @@ -1,21 +1,5 @@ # Obtaining Source Code -- [About OpenHarmony](#section6370143622110) -- [Overview of Source Code Acquisition](#section12763342204) -- [Method 1: Acquiring Source Code from the Gitee Code Repository](#section537312010229) - - [When to Use](#section10881513459) - - [Prerequisites](#section102871547153314) - - [How to Use](#section429012478331) - -- [Method 2: Acquiring Source Code from DevEco Marketplace](#section463013147412) - - [When to Use](#section26661067443) - - [Prerequisites](#section17544943123315) - - [How to Use](#section954619433333) - -- [Method 3: Acquiring Source Code from a Mirror Site](#section1186691118430) -- [Method 4: Acquiring Source Code from the GitHub Image Repository \(at 23:00 UTC Every Day\)](#section23448418360) -- [Source Code Directories](#section1072115612811) - ## About OpenHarmony OpenHarmony is an open-source project launched by the OpenAtom Foundation. The purpose of this project is to build an open, distributed operating system \(OS\) framework for smart IoT devices in the full-scenario, full-connectivity, and full-intelligence era. diff --git a/en/device-dev/glossary/glossary.md b/en/device-dev/glossary/glossary.md index 662188c5f97aaf9adba99b61d8d3a8cc28f85281..a405ee58159b03570a352e4a2e931541befef933 100644 --- a/en/device-dev/glossary/glossary.md +++ b/en/device-dev/glossary/glossary.md @@ -1,14 +1,5 @@ # Glossary -- [A](#en-us_topic_0000001050749051_section1679023922312) -- [B](#en-us_topic_0000001050749051_section62182102017) -- [D](#en-us_topic_0000001050749051_section1670294920236) -- [F](#en-us_topic_0000001050749051_section5406185415236) -- [H](#en-us_topic_0000001050749051_section891816813243) -- [I](#en-us_topic_0000001050749051_section10124052142516) -- [P](#en-us_topic_0000001050749051_section779354121411) -- [S](#en-us_topic_0000001050749051_section25661636182615) - ## A - **Ability** diff --git a/en/device-dev/guide/device-camera-control-demo-photoguide.md b/en/device-dev/guide/device-camera-control-demo-photoguide.md index f355014896857760bfb5ff252b69b0608f1a1c67..e0046ccac0e5ce11729608e499db15ee02759bbc 100644 --- a/en/device-dev/guide/device-camera-control-demo-photoguide.md +++ b/en/device-dev/guide/device-camera-control-demo-photoguide.md @@ -1,10 +1,5 @@ # Photographing -- [When to Use](#en-us_topic_0000001052170554_section1963312376119) -- [Available APIs](#en-us_topic_0000001052170554_section56549532016) -- [Limitations and Constraints](#en-us_topic_0000001052170554_section1165911177314) -- [How to Develop](#en-us_topic_0000001052170554_section138543918214) - ## When to Use Use the camera module APIs to capture frames \(photographing\). diff --git a/en/device-dev/guide/device-camera-control-demo-previewguide.md b/en/device-dev/guide/device-camera-control-demo-previewguide.md index 3667fc0f81d94083580fd852fbc6200a90c3bea1..a5bc9225375dddd74f9eeed5e0329021d20c0033 100644 --- a/en/device-dev/guide/device-camera-control-demo-previewguide.md +++ b/en/device-dev/guide/device-camera-control-demo-previewguide.md @@ -1,10 +1,5 @@ # Previewing -- [When to Use](#en-us_topic_0000001051930577_section186634310418) -- [Available APIs](#en-us_topic_0000001051930577_section125479541744) -- [Limitations and Constraints](#en-us_topic_0000001051930577_section1165911177314) -- [How to Develop](#en-us_topic_0000001051930577_section34171333656) - ## When to Use Use the camera module APIs to generate and play video streams. diff --git a/en/device-dev/guide/device-camera-control-demo-videoguide.md b/en/device-dev/guide/device-camera-control-demo-videoguide.md index dcd587b6dc8d585ad949088e1c71bfc9d604d158..7bf4ba1076b5d90d8e254a788d6baee572f2e005 100644 --- a/en/device-dev/guide/device-camera-control-demo-videoguide.md +++ b/en/device-dev/guide/device-camera-control-demo-videoguide.md @@ -1,10 +1,5 @@ # Video Recording -- [When to Use](#en-us_topic_0000001051451869_section186634310418) -- [Available APIs](#en-us_topic_0000001051451869_section125479541744) -- [Limitations and Constraints](#en-us_topic_0000001051451869_section1165911177314) -- [How to Develop](#en-us_topic_0000001051451869_section1196016315516) - ## When to Use Use the camera module APIs to capture video streams. diff --git a/en/device-dev/guide/device-camera-visual-addpage.md b/en/device-dev/guide/device-camera-visual-addpage.md index 42eae0107fbdff36aff7879586df0fedebc792b2..b50eda2d1b11bbf22e7445bd005b033eb9598021 100644 --- a/en/device-dev/guide/device-camera-visual-addpage.md +++ b/en/device-dev/guide/device-camera-visual-addpage.md @@ -1,8 +1,5 @@ # Adding Pages -- [Creating the Home Page](#section16935511143715) -- [Creating the Details Page](#section122131729173819) - ## Creating the Home Page Upon creation of the project, the **index** page is automatically generated, which is the home page of AirQuality. [Figure 1](#fig16545205773718) shows the project directory. diff --git a/en/device-dev/guide/device-camera-visual-details.md b/en/device-dev/guide/device-camera-visual-details.md index 60bd585e6dd6d90cbfe47c6e68cc7a7b5dc85dee..daca0e574e257565ed25061c78287154375e81e3 100644 --- a/en/device-dev/guide/device-camera-visual-details.md +++ b/en/device-dev/guide/device-camera-visual-details.md @@ -1,8 +1,5 @@ # Building the Details Page -- [detail.hml](#section275215487291) -- [detail.css](#section2589154215301) -- [detail.js](#section163410883117) The **detail** page displays the air quality data of a week in a chart. There are two parts on the page: title bar and chart bar. Considering the display effect of the chart bar, use multiple **** components instead of one **** component. diff --git a/en/device-dev/guide/device-camera-visual-faqs.md b/en/device-dev/guide/device-camera-visual-faqs.md index 4e57b6551777c7e00d7b5dfcb1dea60f8e5c94a0..9a2ef74d0e5450f3ce5ce519f536c2550ae192f1 100644 --- a/en/device-dev/guide/device-camera-visual-faqs.md +++ b/en/device-dev/guide/device-camera-visual-faqs.md @@ -1,24 +1,5 @@ # FAQs -- [Visual Application FAQs](#section147421736145813) - - [Is there a global variable that can be accessed by all pages?](#section294382614018) - - [How do I obtain DOM elements?](#section1423713435019) - - [How do I pass values between pages?](#section119822143117) - - [How do I scroll a list to an item?](#section188663819111) - - [Does the component support multiple lines?](#section205741157418) - - [Why is a component not displayed?](#section1345810151025) - - [How do I implement scrolling on a page?](#section1724052813218) - - [Why do not the left and top attributes take effect?](#section34659571520) - - [Why does not dynamic binding take effect?](#section1758881511313) - - [How do I implement relative and absolute positioning?](#section1378730235) - - [How do I display or hide a component?](#section1243424718312) - - [What are the precautions for using the margin attribute?](#section7923357414) - - [What are the precautions for event subscription?](#section91641925548) - - [What are the precautions for using dynamic binding?](#section1292412431744) - - [How does the loop attribute take effect for ?](#section1136434952) - - [What are the precautions for using an array?](#section1979819133510) - - ## Visual Application FAQs ### Is there a global variable that can be accessed by all pages? diff --git a/en/device-dev/guide/device-camera-visual-overview.md b/en/device-dev/guide/device-camera-visual-overview.md index 3164d864b9d888d69c518f8e62be57801d0b69d3..d35bb17c1514f147b10d3a561c3eaf6994749b57 100644 --- a/en/device-dev/guide/device-camera-visual-overview.md +++ b/en/device-dev/guide/device-camera-visual-overview.md @@ -1,7 +1,5 @@ # Overview -- [Display Effects](#section3997224182313) - This document describes how to quickly set up an application development environment \(using the Hi3516D V300 development board\) for event data recorders running on OpenHarmony. An air quality monitoring application, AirQuality, is used as an example to describe how to create, develop, and debug your application. ## Display Effects diff --git a/en/device-dev/guide/device-camera-visual-prepare.md b/en/device-dev/guide/device-camera-visual-prepare.md index b66b6e9ceec8f93eb1e0b072549c9c8369751d3e..8814d28e5f876916017579e2dcdcfc1e51ec747e 100644 --- a/en/device-dev/guide/device-camera-visual-prepare.md +++ b/en/device-dev/guide/device-camera-visual-prepare.md @@ -1,8 +1,5 @@ # Preparations -- [Setting Up the Development Environment](#section1912530122716) -- [Creating a Project](#section1456035192720) - ## Setting Up the Development Environment Download and install DevEco Studio. For details, see the [HUAWEI DevEco Studio User Guide](https://developer.harmonyos.com/en/docs/documentation/doc-guides/software_install-0000001053582415). diff --git a/en/device-dev/guide/device-clock-guide.md b/en/device-dev/guide/device-clock-guide.md index 44f9935927813af5aa67be0082694a91d2a54d36..91454ad50c606446bea689e747d42c8a81879880 100644 --- a/en/device-dev/guide/device-clock-guide.md +++ b/en/device-dev/guide/device-clock-guide.md @@ -1,15 +1,5 @@ # Development Guidelines on Clock Apps -- [Overview](#section11522349121115) -- [Preparations](#section6592121861218) -- [How to Develop](#section19901741111312) -- [Signing and Packaging](#section10601181101516) -- [Running on the Real Device](#section092721731511) -- [FAQs](#section1122413460153) - - [hdc\_std Fails to Connect to a Device](#section1922725151614) - - [hdc\_std Fails to Run](#section15657547131615) - - ## Overview This document describes how to quickly set up a development environment \(using the Hi3516D V300 development board\) and develop a clock app running on OpenHarmony. You can click [here](https://gitee.com/openharmony/app_samples/tree/master/common/Clock) to obtain the sample code. diff --git a/en/device-dev/guide/device-driver-demo.md b/en/device-dev/guide/device-driver-demo.md index 7ae5f854cf295fd41092b61bc3851137af7a1935..ceed4c96f66bb1387814c350dd7e75873d58f61c 100644 --- a/en/device-dev/guide/device-driver-demo.md +++ b/en/device-dev/guide/device-driver-demo.md @@ -1,15 +1,5 @@ # Development Example for Platform Drivers -- [Overview](#section194201316174215) -- [Preparations](#section6926133918422) -- [Development](#section65801539470) - - [File Description](#section0708184454414) - - [Instantiating the Driver Entry](#section85325864412) - - [Setting Related Parameters](#section8155172019453) - - [Adding a Controller](#section1335374114452) - -- [Building Source Code and Burning Images](#section164824754712) - ## Overview This document uses the I2C driver as an example to describe how to develop platform drivers based on the hardware driver foundation \(HDF\). diff --git a/en/device-dev/guide/device-iotcamera-control-demo-photodevguide.md b/en/device-dev/guide/device-iotcamera-control-demo-photodevguide.md index adf90ccd674dc68969756ded3773c3bbab9111af..c54609ed2c8cd8ec6b21b749f0951f23c962de76 100644 --- a/en/device-dev/guide/device-iotcamera-control-demo-photodevguide.md +++ b/en/device-dev/guide/device-iotcamera-control-demo-photodevguide.md @@ -1,10 +1,5 @@ # Photographing -- [When to Use](#en-us_topic_0000001052170554_section1963312376119) -- [Available APIs](#en-us_topic_0000001052170554_section56549532016) -- [Limitations and Constraints](#en-us_topic_0000001052170554_section1165911177314) -- [How to Develop](#en-us_topic_0000001052170554_section138543918214) - ## When to Use Use the camera module APIs to capture frames \(photographing\). diff --git a/en/device-dev/guide/device-iotcamera-control-demo-videodevguide.md b/en/device-dev/guide/device-iotcamera-control-demo-videodevguide.md index 604aadacb1223e243a2bc885d0c7f49eb4fc074d..96afe8a9d7a728e705e56b803619f02e95c4be9b 100644 --- a/en/device-dev/guide/device-iotcamera-control-demo-videodevguide.md +++ b/en/device-dev/guide/device-iotcamera-control-demo-videodevguide.md @@ -1,10 +1,5 @@ # Video Recording -- [When to Use](#en-us_topic_0000001051451869_section186634310418) -- [Available APIs](#en-us_topic_0000001051451869_section125479541744) -- [Limitations and Constraints](#en-us_topic_0000001051451869_section1165911177314) -- [How to Develop](#en-us_topic_0000001051451869_section1196016315516) - ## When to Use Use the camera module APIs to capture video streams. diff --git a/en/device-dev/guide/device-outerdriver-demo.md b/en/device-dev/guide/device-outerdriver-demo.md index 41fbb14b961b1f1cf7f4ee3f3f74e464cb91f500..b2238b6af22a247927421bec914b118dcbfe18e9 100644 --- a/en/device-dev/guide/device-outerdriver-demo.md +++ b/en/device-dev/guide/device-outerdriver-demo.md @@ -1,25 +1,5 @@ # Development Example for Peripheral Drivers -- [Overview](#section86753818426) - - [Hardware Resources](#section123071189431) - - [Input Driver Model](#section53684425430) - -- [Setting Up the Environment](#section661075474418) -- [Developing a Touchscreen Driver](#section15233162984520) - - [Configuring Device Driver Descriptions](#section16761205604515) - - [Configuring the Touchscreen](#section156331030144617) - - [Adapting to the Private Drivers of the Touchscreen](#section17127331595) - -- [Building Source Code and Burning Images](#section16465031164711) -- [Debugging and Verification](#section62577313482) -- [Input Driver Model Workflow Analysis](#section1578569154917) - - [Parsing Private Configuration Data](#section1310113815495) - - [Initializing the Input Device Manager and Registering the Driver with the HDF](#section614512119500) - - [Initializing the Input Common Driver and Registering the Driver with the HDF](#section16194201755019) - - [Initializing the Input Chip Driver and Registering the Driver with the HDF](#section1090743312505) - - [Function Invocation Logic](#section81801147529) - - ## Overview This document describes how to develop a touchscreen driver on the Hi3516D V300 development board using the HDF input driver model, helping you quickly get started with OpenHarmony peripheral driver development. diff --git a/en/device-dev/guide/device-wlan-led-outcontrol.md b/en/device-dev/guide/device-wlan-led-outcontrol.md index ec884688cc8a7443943317a83f8203a71bd807ee..597b58c83925d78eabd602454f6509d0f221f2f9 100644 --- a/en/device-dev/guide/device-wlan-led-outcontrol.md +++ b/en/device-dev/guide/device-wlan-led-outcontrol.md @@ -1,9 +1,5 @@ # LED Peripheral Control -- [Overview](#section14639174516337) -- [Development](#section13857170163412) -- [Verification](#section1949121910344) - ## Overview Based on the Hi3861 platform, the OpenHarmony WLAN module provides abundant peripheral operation capabilities, including the I2C, I2S, ADC, UART, SPI, SDIO, GPIO, PWM, and flash memory. This document describes how to control GPIO pins by calling the OpenHarmony native development kit \(NDK\) interface to implement LED blinking. For details about how to control other IoT peripherals, see the API guide. diff --git a/en/device-dev/guide/device-wlan-sdk.md b/en/device-dev/guide/device-wlan-sdk.md index c33274024590c39d111925ee0962c7a9a8d5079a..3c8f536c04b79f7776aa121d8b09f12970d04d8f 100644 --- a/en/device-dev/guide/device-wlan-sdk.md +++ b/en/device-dev/guide/device-wlan-sdk.md @@ -1,14 +1,5 @@ # Third-Party SDK Integration -- [Planning a Directory Structure](#section1736472718351) -- [Building the Service libs](#section442815485351) -- [Compiling Adaptation Code](#section3984721113613) -- [Compiling Code](#section830417531286) -- [Compiling a Script](#section13500201173710) -- [Compiling Service Code](#section8754114803918) -- [Runtime](#section7737749184012) -- [End](#section153301392411) - To build a more open and complete Internet of Things \(IoT\) ecosystem, OpenHarmony has opened up a group of directories to integrate SDKs provided by different vendors. This guide describes how to integrate SDKs into OpenHarmony based on the Hi3861 board. ## Planning a Directory Structure diff --git a/en/device-dev/kernel/kernel-mini-appx-code.md b/en/device-dev/kernel/kernel-mini-appx-code.md index b1d1ebad2784d4c658ed303618923d77eff2577c..bea0dbabe8addb20094979bcdccd01a10ac51d05 100644 --- a/en/device-dev/kernel/kernel-mini-appx-code.md +++ b/en/device-dev/kernel/kernel-mini-appx-code.md @@ -1,17 +1,5 @@ # Kernel Coding Specification -- [Principle](#section9512812145915) -- [Directory Structure](#section1355317267017) -- [Naming](#section1375364815017) -- [Comments](#section1692516179119) -- [Format](#section10888536113) -- [Macros](#section12276501124) -- [Header Files](#section158507231319) -- [Data Types](#section91351731446) -- [Variables](#section575493915417) -- [Assertions](#section13864440410) -- [Functions](#section671919481745) - This kernel coding specification is developed based on the general programming specifications in the industry. It defines the programming styles for kernel developers to follow. ## Principle diff --git a/en/device-dev/kernel/kernel-mini-appx-data-list.md b/en/device-dev/kernel/kernel-mini-appx-data-list.md index c99d45cbe43c3aa7ef73a00cfd834a84d5455707..814913de30068fee43df2992cc4aa43ccaf4020f 100644 --- a/en/device-dev/kernel/kernel-mini-appx-data-list.md +++ b/en/device-dev/kernel/kernel-mini-appx-data-list.md @@ -1,14 +1,5 @@ # Doubly Linked List -- [Basic Concepts](#section1990715203418) -- [Available APIs](#section848334511411) -- [How to Develop](#section01781261552) -- [Development Example](#section67569495514) - - [Example Description](#section48761994551) - - [Sample Code](#section1280202685519) - - [Verification](#section5811249105512) - - ## Basic Concepts A doubly linked list is a linked data structure that consists of a set of sequentially linked records called nodes. Each node contains a pointer to the previous node and a pointer to the next node in the sequence of nodes. The pointer head is unique. diff --git a/en/device-dev/kernel/kernel-mini-appx-lib-cmsis.md b/en/device-dev/kernel/kernel-mini-appx-lib-cmsis.md index a30a1367739582eb1c8a2313ec189f7750d7877f..46081c4d32837708cda1d8ed0d8a7d8205d0c4c6 100644 --- a/en/device-dev/kernel/kernel-mini-appx-lib-cmsis.md +++ b/en/device-dev/kernel/kernel-mini-appx-lib-cmsis.md @@ -1,12 +1,5 @@ # CMSIS Support -- [Basic Concepts](#section131091144111615) -- [Development Guidelines](#section57653573161) - - [Available APIs](#section1795910417173) - - [How to Develop](#section48301225131720) - - [Development Example](#section524434761713) - - ## Basic Concepts The Cortex Microcontroller Software Interface Standard \([CMSIS](https://developer.arm.com/tools-and-software/embedded/cmsis)\) is a vendor-independent hardware abstraction layer for microcontrollers based on Arm Cortex processors. Of the CMSIS components, the Real Time Operating System \(RTOS\) defines a set of universal and standardized APIs to reduce the dependency of application developers on specific RTOS and facilitate software porting and reuse. The CMSIS provides CMSIS-RTOS v1 and CMSIS-RTOS v2. The OpenHarmony LiteOS-M supports only the implementation of CMSIS-RTOS v2. diff --git a/en/device-dev/kernel/kernel-mini-appx-lib-posix.md b/en/device-dev/kernel/kernel-mini-appx-lib-posix.md index e5cc7ba886d7cd3f8bf895521bff5ec8bdf689c7..6290211b98ce95cea07078f3a2513cd2d3e16dbe 100644 --- a/en/device-dev/kernel/kernel-mini-appx-lib-posix.md +++ b/en/device-dev/kernel/kernel-mini-appx-lib-posix.md @@ -1,12 +1,5 @@ # POSIX Support -- [Basic Concepts](#section1757915134139) -- [Development Guidelines](#section1573664211318) - - [Available APIs](#section10429150121317) - - [Important Notes](#section109174418147) - - [Development Example](#section206149278155) - - ## Basic Concepts The OpenHarmony kernel uses the **musl libc** library and self-developed APIs and supports the Portable Operating System Interface \(POSIX\). You can develop components and applications working on the kernel based on the POSIX. diff --git a/en/device-dev/kernel/kernel-mini-basic-interrupt-guide.md b/en/device-dev/kernel/kernel-mini-basic-interrupt-guide.md index 53c70db20a6b420c55a7fe28eaf0d19eb3843480..e92a43816c40628946f84f66634942f739bf732b 100644 --- a/en/device-dev/kernel/kernel-mini-basic-interrupt-guide.md +++ b/en/device-dev/kernel/kernel-mini-basic-interrupt-guide.md @@ -1,11 +1,5 @@ # Development Guidelines -- [Available APIs](#section158501652121514) -- [How to Develop](#section11841123033618) -- [Development Example](#section460018317164) - - [Verification](#section1048572415182) - - When an interrupt request is generated by a peripheral, the CPU suspends the current task and responds to the interrupt request. You need to register the interrupt handler and specify the operation to be performed by the CPU. ## Available APIs diff --git a/en/device-dev/kernel/kernel-mini-basic-ipc-event-basic.md b/en/device-dev/kernel/kernel-mini-basic-ipc-event-basic.md index 3ac227417f069d380e96193b178d8ed33328e98e..435d4ce5c35d73a2c0582644bcafc1e36abe9f78 100644 --- a/en/device-dev/kernel/kernel-mini-basic-ipc-event-basic.md +++ b/en/device-dev/kernel/kernel-mini-basic-ipc-event-basic.md @@ -1,10 +1,5 @@ # Basic Concepts -- [Working Principles](#section1735611583011) - - [Event Control Block](#section1161415384467) - - [Working Principles](#section187761153144617) - - An event is a mechanism for communication between tasks. It can be used to synchronize tasks. The events have the following features: - Events can be synchronized in one-to-many or many-to-many mode. In one-to-many mode, a task can wait for multiple events. In many-to-many mode, multiple tasks can wait for multiple events. However, a write event wakes up only one task from the block. diff --git a/en/device-dev/kernel/kernel-mini-basic-ipc-event-guide.md b/en/device-dev/kernel/kernel-mini-basic-ipc-event-guide.md index 6a6fe2e2cf8b10ca670d291180a38f7392a0e721..8b0b3913c10a0d37cdabae292466949c7e2fb0eb 100644 --- a/en/device-dev/kernel/kernel-mini-basic-ipc-event-guide.md +++ b/en/device-dev/kernel/kernel-mini-basic-ipc-event-guide.md @@ -1,13 +1,5 @@ # Development Guidelines -- [Available APIs](#section158501652121514) -- [How to Develop](#section783435801510) -- [Development Example](#section460018317164) - - [Example Description](#section896412438910) - - [Sample Code](#section149077554912) - - [Verification](#section4461439172017) - - ## Available APIs diff --git a/en/device-dev/kernel/kernel-mini-basic-ipc-mutex-basic.md b/en/device-dev/kernel/kernel-mini-basic-ipc-mutex-basic.md index 827323f9101f1eef40a20883adc561238a8e53b7..e638e55d44357806389ffacb5850ed11ca470ec3 100644 --- a/en/device-dev/kernel/kernel-mini-basic-ipc-mutex-basic.md +++ b/en/device-dev/kernel/kernel-mini-basic-ipc-mutex-basic.md @@ -1,7 +1,5 @@ # Basic Concepts -- [Working Principles](#section115161649726) - A mutual exclusion \(mutex\) is a special binary semaphore used for exclusive access to shared resources. A mutex can be unlocked or locked. When a mutex is held by a task, the mutex is locked and the task obtains the ownership of the mutex. When the task releases the mutex, the mutex is unlocked and the task will lose the ownership of the mutex. When a task holds a mutex, other tasks cannot unlock or hold the mutex. diff --git a/en/device-dev/kernel/kernel-mini-basic-ipc-mutex-guide.md b/en/device-dev/kernel/kernel-mini-basic-ipc-mutex-guide.md index 664e6e9214b7012d87442a1f417b1e60ce4764d7..4d3ed8e8ece08e54842777296c84a0aef2ec3635 100644 --- a/en/device-dev/kernel/kernel-mini-basic-ipc-mutex-guide.md +++ b/en/device-dev/kernel/kernel-mini-basic-ipc-mutex-guide.md @@ -1,13 +1,5 @@ # Development Guidelines -- [Available APIs](#section158501652121514) -- [How to Develop](#section783435801510) -- [Development Example](#section1426719434114) - - [Example Description](#section896412438910) - - [Sample Code](#section149077554912) - - [Verification](#section2059413981311) - - ## Available APIs **Table 1** APIs of the mutex module diff --git a/en/device-dev/kernel/kernel-mini-basic-ipc-queue-basic.md b/en/device-dev/kernel/kernel-mini-basic-ipc-queue-basic.md index 509a08916b0d0ccf382d47bb104d344811322815..7bd2e29fa01e9de9619702e77fb314d94432cfb3 100644 --- a/en/device-dev/kernel/kernel-mini-basic-ipc-queue-basic.md +++ b/en/device-dev/kernel/kernel-mini-basic-ipc-queue-basic.md @@ -1,10 +1,5 @@ # Basic Concepts -- [Working Principles](#section1582619446311) - - [Queue Control Block](#section1648304614720) - - [Working Principles](#section15384012164811) - - A queue, also called a message queue, is a data structure used for communication between tasks. The queue receives messages of unfixed length from tasks or interrupts, and determines whether to store the transferred messages in the queue based on different APIs. Tasks can read messages from a queue. When the queue has no messages, the tasks are suspended. When the queue has a new message, the suspended tasks are woken up and process the new message. Tasks can also write messages to the queue. When the queue is full, the write task is suspended. When there is an available message node in the queue, the suspended write task is woken up and writes a message. diff --git a/en/device-dev/kernel/kernel-mini-basic-ipc-queue-guide.md b/en/device-dev/kernel/kernel-mini-basic-ipc-queue-guide.md index b498a39d84dc62a49d70e3637e43fdfba5eb9eaa..32984c25fc371b464e0810e0013841d6e5ee1d0f 100644 --- a/en/device-dev/kernel/kernel-mini-basic-ipc-queue-guide.md +++ b/en/device-dev/kernel/kernel-mini-basic-ipc-queue-guide.md @@ -1,13 +1,5 @@ # Development Guidelines -- [Available APIs](#section158501652121514) -- [How to Develop](#section783435801510) -- [Development Example](#section460018317164) - - [Example Description](#section2148236125814) - - [Sample Code](#section121451047155716) - - [Verification](#section2742182082117) - - ## Available APIs diff --git a/en/device-dev/kernel/kernel-mini-basic-ipc-sem-basic.md b/en/device-dev/kernel/kernel-mini-basic-ipc-sem-basic.md index 3c3d3a19ac5c62552e8fee72021f784e1d8b0d53..9a99c27ef2641569d2dcd348105359af51091629 100644 --- a/en/device-dev/kernel/kernel-mini-basic-ipc-sem-basic.md +++ b/en/device-dev/kernel/kernel-mini-basic-ipc-sem-basic.md @@ -1,10 +1,5 @@ # Basic Concepts -- [Working Principles](#section1794010261861) - - [Semaphore control block](#section11372149164815) - - [Working Principles](#section139726510491) - - Semaphore is a mechanism for implementing inter-task communication. It implements synchronization between tasks or exclusive access to shared resources. In the data structure of a semaphore, there is a value indicating the number of shared resources available. The value can be: diff --git a/en/device-dev/kernel/kernel-mini-basic-ipc-sem-guide.md b/en/device-dev/kernel/kernel-mini-basic-ipc-sem-guide.md index a9c14c93dd84828a8f3915972bb0f8fcbc058898..54556674c8ef931641d05c2bb9983f951aa84352 100644 --- a/en/device-dev/kernel/kernel-mini-basic-ipc-sem-guide.md +++ b/en/device-dev/kernel/kernel-mini-basic-ipc-sem-guide.md @@ -1,13 +1,5 @@ # Development Guidelines -- [Available APIs](#section158501652121514) -- [How to Develop](#section783435801510) -- [Development Example](#section460018317164) - - [Example Description](#section22061718111412) - - [Sample Code](#section1775922321416) - - [Verification](#section160404016213) - - ## Available APIs diff --git a/en/device-dev/kernel/kernel-mini-basic-memory-dynamic.md b/en/device-dev/kernel/kernel-mini-basic-memory-dynamic.md index dc4a0c590e744897b8f8e5f4b3e19b20aacc3672..be8191b3c78aa322394a98a74f3fa52b6211e1cf 100644 --- a/en/device-dev/kernel/kernel-mini-basic-memory-dynamic.md +++ b/en/device-dev/kernel/kernel-mini-basic-memory-dynamic.md @@ -1,14 +1,5 @@ # Dynamic Memory -- [Working Principles](#section328282013571) -- [Development Guidelines](#section7921151015814) - - [When to Use](#section326917198583) - - [Available APIs](#section1032331584) - - [How to Develop](#section07271773592) - - [Development Example](#section84931234145913) - - [Verification](#section165233233917) - - ## Working Principles Dynamic memory management allows memory blocks of any size to be allocated from a large contiguous memory \(memory pool or heap memory\) configured in the system based on user demands when memory resources are sufficient. The memory block can be released for further use when not required. Compared with static memory management, dynamic memory management allows memory allocation on demand but causes fragmentation of memory. diff --git a/en/device-dev/kernel/kernel-mini-basic-memory-static.md b/en/device-dev/kernel/kernel-mini-basic-memory-static.md index 1d35df912f478c2c8eab8e38fe50a9c679219ae9..d3f1f131ddaa57ad1a18bf0343b9fcebed56d9a4 100644 --- a/en/device-dev/kernel/kernel-mini-basic-memory-static.md +++ b/en/device-dev/kernel/kernel-mini-basic-memory-static.md @@ -1,14 +1,5 @@ # Static Memory -- [Working Principles](#section165473517522) -- [Development Guidelines](#section57511620165218) - - [When to Use](#section215474911529) - - [Available APIs](#section79231214539) - - [How to Develop](#section1388511316548) - - [Development Example](#section17801515105519) - - [Verification](#section11818154112319) - - ## Working Principles The static memory is a static array. The block size in the static memory pool is set during initialization and cannot be changed after initialization. diff --git a/en/device-dev/kernel/kernel-mini-basic-soft-basic.md b/en/device-dev/kernel/kernel-mini-basic-soft-basic.md index e799f434a366a8c2b9037d29fcf770a8b917a8cc..f624e67f4ccc4df4a75b7c901276d60a4fcc8a2d 100644 --- a/en/device-dev/kernel/kernel-mini-basic-soft-basic.md +++ b/en/device-dev/kernel/kernel-mini-basic-soft-basic.md @@ -1,10 +1,5 @@ # Basic Concepts -- [Working Principles](#section070665816719) - - [Timer States](#section115453813506) - - [Timer Modes](#section137521353175010) - - The software timer is a software-simulated timer based on system tick interrupts. When the preset tick counter value has elapsed, the user-defined callback will be invoked. The timing precision is related to the cycle of the system tick clock. Due to the limitation in hardware, the number of hardware timers cannot meet users' requirements. Therefore, the OpenHarmony LiteOS-M kernel provides the software timer function. The software timer allows more timing services to be created, increasing the number of timers. diff --git a/en/device-dev/kernel/kernel-mini-basic-soft-guide.md b/en/device-dev/kernel/kernel-mini-basic-soft-guide.md index 983075c8f432a14fc7ea89d574a15cb8fe0ef271..914242f7152018271f2c8184796f1093134a0e34 100644 --- a/en/device-dev/kernel/kernel-mini-basic-soft-guide.md +++ b/en/device-dev/kernel/kernel-mini-basic-soft-guide.md @@ -1,13 +1,5 @@ # Development Guidelines -- [Available APIs](#section158501652121514) -- [How to Develop](#section783435801510) -- [Development Example](#section460018317164) - - [Example Description](#section3741753191918) - - [Sample Code](#section20760101182016) - - [Verification](#section11244112818172) - - ## Available APIs The following table describes APIs available for the OpenHarmony LiteOS-M software timer module. For more details about the APIs, see the API reference. diff --git a/en/device-dev/kernel/kernel-mini-basic-task-basic.md b/en/device-dev/kernel/kernel-mini-basic-task-basic.md index fa4e6853cce145a79aad98515dd8d288d25b6bfa..fcf257f7b06ec44a7a40a3f1a14dc6b360c84de8 100644 --- a/en/device-dev/kernel/kernel-mini-basic-task-basic.md +++ b/en/device-dev/kernel/kernel-mini-basic-task-basic.md @@ -1,8 +1,5 @@ # Basic Concepts -- [Task-related Concepts](#section673132352511) -- [Task Running Mechanism](#section176294469251) - From the perspective of the operating system, tasks are the minimum running units that compete for system resources. They can use or wait for CPUs, use system resources such as memory, and run independently. The task module of the OpenHarmony LiteOS-M provides multiple tasks and supports switching between tasks, helping users manage business process procedures. The task module has the following features: diff --git a/en/device-dev/kernel/kernel-mini-basic-task-guide.md b/en/device-dev/kernel/kernel-mini-basic-task-guide.md index 3b810a99972bd43d5824fe0afc4d147f7983973f..8b7cee6487029be2e1eef3b7a570dc83b85bc7f5 100644 --- a/en/device-dev/kernel/kernel-mini-basic-task-guide.md +++ b/en/device-dev/kernel/kernel-mini-basic-task-guide.md @@ -1,11 +1,5 @@ # Development Guidelines -- [Available APIs](#section158501652121514) -- [How to Develop](#section783435801510) -- [Development Example](#section460018317164) - - [Verification](#section189023104457) - - When a task is created, the OpenHarmony LiteOS-M kernel can perform operations, such as locking or unlocking task scheduling, suspending, restoring, and delaying the task, and setting or obtaining the task priority. ## Available APIs diff --git a/en/device-dev/kernel/kernel-mini-basic-time-basic.md b/en/device-dev/kernel/kernel-mini-basic-time-basic.md index b8a2b749f8dd2ea955f15427cf02549640e2841a..5952854109364361502fd0a320fbf6317c8dec0d 100644 --- a/en/device-dev/kernel/kernel-mini-basic-time-basic.md +++ b/en/device-dev/kernel/kernel-mini-basic-time-basic.md @@ -1,7 +1,5 @@ # Basic Concepts -- [Time Unit](#section97172532397) - Time management provides all time-related services for applications based on the system clock. The system clock is generated by the interrupts triggered by the output pulse of a timer or counter. The system clock is generally defined as an integer or a long integer. The period of an output pulse is a "clock tick". The system clock is also called time scale or tick. diff --git a/en/device-dev/kernel/kernel-mini-basic-time-guide.md b/en/device-dev/kernel/kernel-mini-basic-time-guide.md index 336ce25a55d51ccc26b886e37ba14a7ab671bcb1..3041a875764957ef126abd2791bf6c7ee8fc8f55 100644 --- a/en/device-dev/kernel/kernel-mini-basic-time-guide.md +++ b/en/device-dev/kernel/kernel-mini-basic-time-guide.md @@ -1,13 +1,5 @@ # Development Guidelines -- [Available APIs](#section158501652121514) -- [How to Develop](#section783435801510) -- [Development Example](#section460018317164) - - [Example Description](#section127752801718) - - [Sample Code](#section321653551711) - - [Verification](#section4366193318167) - - The time management module provides APIs to implement conversion between the system running time, ticks, and seconds/milliseconds. ## Available APIs diff --git a/en/device-dev/kernel/kernel-mini-extend-cpup-basic.md b/en/device-dev/kernel/kernel-mini-extend-cpup-basic.md index cef5f25565506eb4dceb43dfd455a18a9999e7ae..46c5ddf8e4a5febf9d26deb7f901ade87292316f 100644 --- a/en/device-dev/kernel/kernel-mini-extend-cpup-basic.md +++ b/en/device-dev/kernel/kernel-mini-extend-cpup-basic.md @@ -1,7 +1,5 @@ # Basic Concepts -- [Working Principles](#section96644177124) - The central processing unit percent \(CPUP\) includes the system CPUP and task CPUP. The system CPUP is the CPU usage of the system within a period of time. It reflects the CPU load and the system running status \(idle or busy\) in the given period of time. The valid range of the system CPUP is 0 to 100 in percentage. The precision can be adjusted through configuration. The value **100** indicates that the system runs with full load. diff --git a/en/device-dev/kernel/kernel-mini-extend-cpup-guide.md b/en/device-dev/kernel/kernel-mini-extend-cpup-guide.md index bbbf020701a359becc749bb1c3f92a0f839ababd..031156bb216b008e6510734a6774d22e83c5d40b 100644 --- a/en/device-dev/kernel/kernel-mini-extend-cpup-guide.md +++ b/en/device-dev/kernel/kernel-mini-extend-cpup-guide.md @@ -1,13 +1,5 @@ # Development Guidelines -- [Available APIs](#section158501652121514) -- [How to Develop](#section783435801510) -- [Development Example](#section460018317164) - - [Example Description](#section51413507517) - - [Sample Code](#section17617965523) - - [Verification](#section1968771515188) - - ## Available APIs **Table 1** Functions diff --git a/en/device-dev/kernel/kernel-mini-extend-dynamic-loading-basic.md b/en/device-dev/kernel/kernel-mini-extend-dynamic-loading-basic.md index 60e7a0c9b8b0ee0d1469eda4dd9e926396c642db..92f841ff8bbc020868dad4e6e3812ef722728e78 100644 --- a/en/device-dev/kernel/kernel-mini-extend-dynamic-loading-basic.md +++ b/en/device-dev/kernel/kernel-mini-extend-dynamic-loading-basic.md @@ -1,15 +1,5 @@ # Basic Concepts -- [Working Principles](#section139861939219) - - [Exporting the Symbol Table](#section15414650102716) - - [Loading an ELF File](#section5221181562810) - - [ELF File Link](#section68441639182817) - -- [ELF Specifications](#section187315541916) - - [ELF Type](#section1701552268) - - [Options for Linking](#section17292133274) - - In small devices with limited hardware resources, dynamic algorithm deployment capability is required to solve the problem that multiple algorithms cannot be deployed at the same time. The LiteOS-M kernel uses the Executable and Linkable Format \(ELF\) because it is easy to use and compatible with a wide variety of platforms. The LiteOS-M provides APIs similar to **dlopen** and **dlsym**. Apps can load and unload required algorithm libraries by using the APIs provided by the dynamic loading module. As shown in the following figure, the app obtains the corresponding information output through the API required by the third-party algorithm library. The third-party algorithm library depends on the basic APIs provided by the kernel, such as **malloc**. After the app loads the API and relocates undefined symbols, it can call the API to complete the function. The dynamic loading component supports only the Arm architecture. In addition, the signature and source of the shared library to be loaded must be verified to ensure the system security. **Figure 1** LiteOS-M kernel dynamic loading architecture diff --git a/en/device-dev/kernel/kernel-mini-extend-dynamic-loading-guide.md b/en/device-dev/kernel/kernel-mini-extend-dynamic-loading-guide.md index 959cb55dbf7813658c252936586794fb11cc71c7..7e786076273e30faef8da95dc3e60656923ab380 100644 --- a/en/device-dev/kernel/kernel-mini-extend-dynamic-loading-guide.md +++ b/en/device-dev/kernel/kernel-mini-extend-dynamic-loading-guide.md @@ -1,9 +1,5 @@ # Development Guidelines -- [Available APIs](#section158501652121514) -- [How to Develop](#section5241132917523) -- [Development Example](#section8708112313531) - ## Available APIs **Table 1** Functions diff --git a/en/device-dev/kernel/kernel-mini-extend-file-fat.md b/en/device-dev/kernel/kernel-mini-extend-file-fat.md index 2c9e3be0ccd27694c063ba4dc663b30bfec019d2..4c836ad9742841af13bcdf974502c4ba6b37f68a 100644 --- a/en/device-dev/kernel/kernel-mini-extend-file-fat.md +++ b/en/device-dev/kernel/kernel-mini-extend-file-fat.md @@ -1,16 +1,5 @@ # FAT -- [Basic Concepts](#section1772629121418) -- [Development Guidelines](#section1149072811148) - - [Adaptation of Drivers](#section19174939191414) - - [How to Develop](#section131211626151513) - -- [Development Example](#section1133718619459) - - [Example Description](#section45337345313) - - [Sample Code](#section119813171539) - - [Verification](#section7987101232311) - - ## Basic Concepts File Allocation Table \(FAT\) is a file system developed for personal computers. It consists of the DOS Boot Record \(DBR\) region, FAT region, and Data region. Each entry in the FAT region records information about the corresponding cluster in the storage device. The cluster information includes whether the cluster is used, number of the next cluster of the file, whether the file ends with the cluster. The FAT file system supports multiple formats, such as FAT12, FAT16, and FAT32. The numbers 12, 16, and 32 indicate the number of bytes per cluster within the FAT, respectively. The FAT file system supports multiple media, especially removable storage media \(such as USB flash drives, SD cards, and removable hard drives\). The FAT file system ensures good compatibility between embedded devices and desktop systems \(such as Windows and Linux\) and facilitates file management. diff --git a/en/device-dev/kernel/kernel-mini-extend-file-littlefs-guide.md b/en/device-dev/kernel/kernel-mini-extend-file-littlefs-guide.md index ab97aff7d89897b05d10c19a8fad5c959a7442d0..29fcd7d933a82929efaba1f8f06a4b4d1c0a943a 100644 --- a/en/device-dev/kernel/kernel-mini-extend-file-littlefs-guide.md +++ b/en/device-dev/kernel/kernel-mini-extend-file-littlefs-guide.md @@ -1,7 +1,5 @@ # Development Guidelines -- [Sample Code](#section1034515054620) - Before porting LittleFS to a new hardware device, declare **lfs\_config**: ``` diff --git a/en/device-dev/kernel/kernel-mini-extend-support.md b/en/device-dev/kernel/kernel-mini-extend-support.md index fd650f391fb89fc7522bb30dc83888459ac581c8..653adb507f5f571e937e7f94e2cf77daa657e1cb 100644 --- a/en/device-dev/kernel/kernel-mini-extend-support.md +++ b/en/device-dev/kernel/kernel-mini-extend-support.md @@ -1,13 +1,5 @@ # C++ Support -- [Basic Concepts](#section11374125415814) -- [Working Principles](#section189351319134418) -- [Development Guidelines](#section166302407911) - - [Available APIs](#section1881825119919) - - [How to Develop](#section76371145108) - - [Development Example](#section994427141111) - - ## Basic Concepts As one of the most widely used programming languages, C++ supports features, such as classes, encapsulation, and overloading. It is an object-oriented programming language developed based on the C language. diff --git a/en/device-dev/kernel/kernel-mini-imemory-debug-det.md b/en/device-dev/kernel/kernel-mini-imemory-debug-det.md index 404ab37e196190d44dd169d27325feaec003ff2f..0ea70a2387a5b15c5ff423fdc29c9eb556803a38 100644 --- a/en/device-dev/kernel/kernel-mini-imemory-debug-det.md +++ b/en/device-dev/kernel/kernel-mini-imemory-debug-det.md @@ -1,14 +1,5 @@ # Memory Leak Check -- [Basic Concepts](#section1026719436293) -- [Function Configuration](#section13991354162914) -- [Development Guidelines](#section95828159308) - - [How to Develop](#section369844416304) - - [Development Example](#section460801313313) - - [Sample Code](#section96539275311) - - [Verification](#section20527343183119) - - ## Basic Concepts As an optional function of the kernel, memory leak check is used to locate dynamic memory leak problems. After this function is enabled, the dynamic memory automatically records the link registers \(LRs\) used when memory is allocated. If a memory leak occurs, the recorded information helps locate the memory allocated for further analysis. diff --git a/en/device-dev/kernel/kernel-mini-memory-debug-cet.md b/en/device-dev/kernel/kernel-mini-memory-debug-cet.md index 04948fdabf3570a69968794e037da3753a13d312..e770a78d21309ba22e50817575ab4633d5881673 100644 --- a/en/device-dev/kernel/kernel-mini-memory-debug-cet.md +++ b/en/device-dev/kernel/kernel-mini-memory-debug-cet.md @@ -1,14 +1,5 @@ # Memory Corruption Check -- [Basic Concepts](#section17368154517335) -- [Function Configuration](#section4696190123420) -- [Development Guidelines](#section672362973417) - - [How to Develop](#section026014863416) - - [Development Example](#section186311302356) - - [Sample Code](#section12709533354) - - [Verification](#section81214126369) - - ## Basic Concepts As an optional function of the kernel, memory corruption check is used to check the integrity of a dynamic memory pool. This mechanism can detect memory corruption errors in the memory pool in a timely manner and provide alerts. It helps reduce problem locating costs and increase troubleshooting efficiency. diff --git a/en/device-dev/kernel/kernel-mini-memory-debug-mes.md b/en/device-dev/kernel/kernel-mini-memory-debug-mes.md index 9ada391f6a65ff8d6e8007a7368fe114b8eeb9e2..02d6310be3cc446fd90a55c3d09cd4e75cd98ade 100644 --- a/en/device-dev/kernel/kernel-mini-memory-debug-mes.md +++ b/en/device-dev/kernel/kernel-mini-memory-debug-mes.md @@ -1,14 +1,5 @@ # Memory Information Statistics -- [Basic Concepts](#section52691565235) -- [Function Configuration](#section470611682411) -- [Development Guidelines](#section9368374243) - - [How to Develop](#section679912407257) - - [Development Example](#section1025453412611) - - [Sample Code](#section165277971315) - - [Verification](#section3460102414271) - - ## Basic Concepts Memory information includes the memory pool size, memory usage, remaining memory size, maximum free memory, memory waterline, number of memory nodes, and fragmentation rate. diff --git a/en/device-dev/kernel/kernel-mini-memory-exception.md b/en/device-dev/kernel/kernel-mini-memory-exception.md index a78a58604d57d4f40058eaeb00f2489302d1c36d..bf9b4b029c426bb763eeda6ddade32ba40fc894c 100644 --- a/en/device-dev/kernel/kernel-mini-memory-exception.md +++ b/en/device-dev/kernel/kernel-mini-memory-exception.md @@ -1,13 +1,5 @@ # Exception Debugging -- [Basic Concepts](#section2741911123412) -- [Working Principles](#section16618124317346) -- [Available APIs](#section16111931351) -- [Usage Guidelines](#section16317163520350) - - [How to Develop](#section13457839133618) - - [How to Locate Exceptions](#section197332323815) - - ## Basic Concepts The OpenHarmony LiteOS-M provides exception handling and debugging measures to help locate and analyze problems. Exception handling involves a series of actions taken by the OS to respond to exceptions occurred during the OS running, for example, printing the exception type, system status, call stack information of the current function, CPU information, and call stack information of tasks. diff --git a/en/device-dev/kernel/kernel-mini-memory-trace.md b/en/device-dev/kernel/kernel-mini-memory-trace.md index d73c715802e01e9fb9a4a4aeb4ce7dea686af35d..e39a993963c28a011118603cfb0c5b289bc3987a 100644 --- a/en/device-dev/kernel/kernel-mini-memory-trace.md +++ b/en/device-dev/kernel/kernel-mini-memory-trace.md @@ -1,15 +1,5 @@ # Trace Debugging -- [Basic Concepts](#section44851752123712) -- [Working Principles](#section5282148123813) -- [Available APIs](#section16304193215387) -- [Development Guidelines](#section498695853819) - - [How to Develop](#section1875652316393) - - [Development Example](#section0403134913395) - - [Sample Code](#section1492711418400) - - [Verification](#section869613984012) - - ## Basic Concepts Trace debugging helps you learn about the kernel running process and the execution sequence of modules and tasks. With the information, you can better understand the code running process of the kernel and locate time sequence problems. diff --git a/en/device-dev/kernel/kernel-mini-overview.md b/en/device-dev/kernel/kernel-mini-overview.md index 0e58d09e7380c078cd61950b671427b5a7ab4399..e058b9a1aab61afba227f0aa5fd0fd696e60bad3 100644 --- a/en/device-dev/kernel/kernel-mini-overview.md +++ b/en/device-dev/kernel/kernel-mini-overview.md @@ -1,10 +1,5 @@ # Kernel Overview -- [Overview](#section1429342661510) - - [CPU Architecture Support](#section48891456112819) - - [Working Principles](#section4599142312817) - - ## Overview The OpenHarmony LiteOS-M kernel is a lightweight operating system \(OS\) kernel designed for the IoT field. It features small size, low power consumption, and high performance. The LiteOS-M kernel has simple code structure, including the minimum function set, kernel abstraction layer, optional components, and project directory. diff --git a/en/device-dev/kernel/kernel-small-apx-bitwise.md b/en/device-dev/kernel/kernel-small-apx-bitwise.md index 38076b683907915c8417ad08d6ce4647c4ff6fae..d7393cba5b71010422a89ce8d437ddd870decff8 100644 --- a/en/device-dev/kernel/kernel-small-apx-bitwise.md +++ b/en/device-dev/kernel/kernel-small-apx-bitwise.md @@ -1,12 +1,5 @@ # Bitwise Operation -- [Basic Concepts](#section1990715203418) -- [Available APIs](#section848334511411) -- [Development Example](#section67569495514) - - [Example Description](#section33551554391) - - [Verification](#section8931859194) - - ## Basic Concepts A bitwise operation operates on a binary number at the level of its individual bits. For example, a variable can be set as a program PSW \(PSW\), and each bit \(flag bit\) in the PSW can have a self-defined meaning. diff --git a/en/device-dev/kernel/kernel-small-apx-dll.md b/en/device-dev/kernel/kernel-small-apx-dll.md index 1e4489eb828c67adcbb64d59e7479e968f62d7af..c22f755c10b1650101831af034fe7f2e7a93c03e 100644 --- a/en/device-dev/kernel/kernel-small-apx-dll.md +++ b/en/device-dev/kernel/kernel-small-apx-dll.md @@ -1,11 +1,5 @@ # Doubly Linked List -- [Basic Concepts](#section1990715203418) -- [Available APIs](#section848334511411) -- [How to Develop](#section01781261552) - - [Development Example](#section8354175218128) - - ## Basic Concepts A doubly linked list is a linked data structure that consists of a set of sequentially linked records called nodes. Each node contains a pointer to the previous node and a pointer to the next node in the sequence of nodes. The pointer head is unique. A doubly linked list allows access from a list node to its next node and also the previous node on the list. This data structure facilitates data search, especially traversal of a large amount of data. The symmetry of the doubly linked list also makes operations, such as insertion and deletion, easy. However, pay attention to the pointer direction when performing operations. diff --git a/en/device-dev/kernel/kernel-small-apx-library.md b/en/device-dev/kernel/kernel-small-apx-library.md index 8bd0b23fd5db447e137f61f30fd06a53dd79349f..88ccd1b987eb9c2d2af40231d1954ea18f901c70 100644 --- a/en/device-dev/kernel/kernel-small-apx-library.md +++ b/en/device-dev/kernel/kernel-small-apx-library.md @@ -1,15 +1,5 @@ # Standard Library -- [Standard Library API Framework](#section149319478561) -- [Development Example](#section20874620185915) -- [Differences from the Linux Standard Library](#section6555642165713) - - [Process](#section11299104511409) - - [Memory](#section175754484116) - - [File System](#section118191113134220) - - [Signal](#section195939264421) - - [Time](#section20825124304213) - - The OpenHarmony kernel uses the musl libc library that supports the Portable Operating System Interface \(POSIX\). You can develop components and applications working on the kernel based on the POSIX. ## Standard Library API Framework diff --git a/en/device-dev/kernel/kernel-small-basic-atomic.md b/en/device-dev/kernel/kernel-small-basic-atomic.md index 2f480a1d08da4bfaa974cd668602e1bb860d5ad8..84335a213329750df7be1ec2a95e67bd57769c9f 100644 --- a/en/device-dev/kernel/kernel-small-basic-atomic.md +++ b/en/device-dev/kernel/kernel-small-basic-atomic.md @@ -1,13 +1,5 @@ # Atomic Operation -- [Basic Concepts](#section1792118384594) -- [Working Principles](#section1786635117596) -- [Development Guidelines](#section2911115308) - - [Available APIs](#section335914201010) - - [How to Develop](#section12207371304) - - [Development Example](#section8538651511) - - ## Basic Concepts In an OS that supports multiple tasks, modifying data in a memory area requires three steps: read data, modify data, and write data. However, data in a same memory area may be simultaneously accessed by multiple tasks. If the data modification is interrupted by another task, the execution result of the operation is unpredictable. diff --git a/en/device-dev/kernel/kernel-small-basic-inner-reflect.md b/en/device-dev/kernel/kernel-small-basic-inner-reflect.md index 667ccf35e2be300f8469bceac352656fc37d65c2..4d3e9b6f0c150f487257de1f1adfbef4de53026a 100644 --- a/en/device-dev/kernel/kernel-small-basic-inner-reflect.md +++ b/en/device-dev/kernel/kernel-small-basic-inner-reflect.md @@ -1,12 +1,5 @@ # Virtual-to-Physical Mapping -- [Basic Concepts](#section9108144913615) -- [Working Principles](#section12392621871) -- [Development Guidelines](#section10264102013713) - - [Available APIs](#section195320251578) - - [How to Develop](#section152774210712) - - ## Basic Concepts The Memory Management Unit \(MMU\) is used to map the virtual addresses in the process space and the actual physical addresses and specify corresponding access permissions and cache attributes. When a program is executed, the CPU accesses the virtual memory, locates the corresponding physical memory based on the MMU page table entry, and executes the code or performs data read/write operations. The page tables of the MMU store the mappings between virtual and physical addresses and the access permission. A page table is created when each process is created. The page table contains page table entries \(PTEs\), and each PTE describes a mapping between a virtual address region and a physical address region. The MMU has a Translation Lookaside Buffer \(TLB\) to perform address translation. During address translation, the MMU first searches the TLB for the corresponding PTE. If a match is found, the address can be returned directly. The following figure illustrates how the CPU accesses the memory or peripherals. diff --git a/en/device-dev/kernel/kernel-small-basic-interrupt.md b/en/device-dev/kernel/kernel-small-basic-interrupt.md index cde3913599b25f0c5934d348ed55539561e6358c..17bffb46fc6f681adc2a2793cf2e3621e876fa3f 100644 --- a/en/device-dev/kernel/kernel-small-basic-interrupt.md +++ b/en/device-dev/kernel/kernel-small-basic-interrupt.md @@ -1,13 +1,5 @@ # Interrupt and Exception Handling -- [Basic Concepts](#section439816296117) -- [Working Principles](#section2792838318) -- [Development Guidelines](#section15415165510110) - - [Available APIs](#section57441612024) - - [How to Develop](#section64332181221) - - [Development Example](#section204698276478) - - [Verification](#section1466144215476) - ## Basic Concepts diff --git a/en/device-dev/kernel/kernel-small-basic-memory-heap.md b/en/device-dev/kernel/kernel-small-basic-memory-heap.md index e6960d8dfc0c8fea6418ad8bcb11b0da2b29b529..3ef8088c85bcde0fccd81ace2158972421432095 100644 --- a/en/device-dev/kernel/kernel-small-basic-memory-heap.md +++ b/en/device-dev/kernel/kernel-small-basic-memory-heap.md @@ -1,15 +1,5 @@ # Heap Memory Management -- [Basic Concepts](#section449414395916) -- [Working Principles](#section465085575911) -- [Development Guidelines](#section577019272015) - - [When to Use](#section326917198583) - - [Available APIs](#section1032331584) - - [How to Develop](#section07271773592) - - [Development Example](#section84931234145913) - - [Verification](#section165233233917) - - ## Basic Concepts Memory management module, one of the core modules of the OS, manages the memory resources of the system. Memory management involves memory initialization, allocation, and release. The heap memory management of the OpenHarmony LiteOS-A provides functions such as memory initialization, allocation, and release. While the OS is running, the heap memory management module manages the memory usage of users and the OS by allocating and releasing memory. This helps achieve the optimal memory usage and usage efficiency and minimize memory fragments. diff --git a/en/device-dev/kernel/kernel-small-basic-memory-physical.md b/en/device-dev/kernel/kernel-small-basic-memory-physical.md index f5a33d885b3e4a36aa178b007f75a55b20f2ba70..ca11ce794c98122c4767945d2f8b9eb62ab76826 100644 --- a/en/device-dev/kernel/kernel-small-basic-memory-physical.md +++ b/en/device-dev/kernel/kernel-small-basic-memory-physical.md @@ -1,14 +1,5 @@ # Physical Memory Management -- [Basic Concepts](#section210891719217) -- [Working Principles](#section111355315213) -- [Development Guidelines](#section393116496217) - - [Available APIs](#section13210155619214) - - [How to Develop](#section178441091231) - - [Development Example](#section1258174015319) - - [Verification](#section515091342819) - - ## Basic Concepts Physical memory is one of the most important resources on a computer. It is the memory space that is provided by the physical memory devices and can be directly addressed through the CPU bus. The physical memory provides temporary storage space for the OS and programs. The LiteOS-A kernel manages the physical memory by memory paging. Except the memory occupied by the kernel heap, other available memory is divided into page frames in the unit of 4 KiB. Memory is allocated and reclaimed by page frame. The kernel uses the buddy algorithm to manage free pages to reduce the fragmentation rate and improve the memory allocation and release efficiency. However, a small block may block the merge of a large block, causing a failure in allocating a large memory block. diff --git a/en/device-dev/kernel/kernel-small-basic-memory-virtual.md b/en/device-dev/kernel/kernel-small-basic-memory-virtual.md index 8f6e6389e4f444153881c4383177b9ac7e8d46cf..ec3672be5bd6f69269508620f96c26a94b35e6ce 100644 --- a/en/device-dev/kernel/kernel-small-basic-memory-virtual.md +++ b/en/device-dev/kernel/kernel-small-basic-memory-virtual.md @@ -1,12 +1,5 @@ # Virtual Memory Management -- [Basic Concepts](#section650193717411) -- [Working Principles](#section072885512412) -- [Development Guidelines](#section20956116050) - - [Available APIs](#section166137221657) - - [How to Develop](#section8752103914513) - - ## Basic Concepts Virtual memory management is a technology used by computer systems to manage memory. Each process has a continuous virtual address space. The size of the virtual address space is determined by the number of CPU bits. The maximum addressing space for a 32-bit hardware platform ranges from 0 GiB to 4 GiB. The 4 GiB space is divided into two parts: 3 GiB higher-address space for the LiteOS-A kernel and 1 GiB lower-address space for processes. The virtual address space of each process space is independent, and the code and data do not affect each other. diff --git a/en/device-dev/kernel/kernel-small-basic-process-process.md b/en/device-dev/kernel/kernel-small-basic-process-process.md index 1486a3e1e86931efa9c7fe2cec1e665f5b337e47..3a413924defd9b708cd1e6fb0f518e19c344f197 100644 --- a/en/device-dev/kernel/kernel-small-basic-process-process.md +++ b/en/device-dev/kernel/kernel-small-basic-process-process.md @@ -1,12 +1,5 @@ # Process -- [Basic Concepts](#section89346055119) -- [Working Principles](#section174514474512) -- [Development Guidelines](#section159637182521) - - [Available APIs](#section1153124135212) - - [How to Develop](#section1533674618526) - - ## Basic Concepts A process is the minimum unit for system resource management. The process module provided by the OpenHarmony LiteOS-A kernel is used to isolate user-space processes. The kernel space is considered as a process space and does not have other processes except KIdle, which is an idle process provided by the system and shares the same process space with KProcess. diff --git a/en/device-dev/kernel/kernel-small-basic-process-scheduler.md b/en/device-dev/kernel/kernel-small-basic-process-scheduler.md index d1110b4033948296524efcfcdafb0a4894df219c..72c5b2dcb81af0d97c9456d31f0391dcf172f24c 100644 --- a/en/device-dev/kernel/kernel-small-basic-process-scheduler.md +++ b/en/device-dev/kernel/kernel-small-basic-process-scheduler.md @@ -1,12 +1,5 @@ # Scheduler -- [Basic Concepts](#section123882355719) -- [Working Principles](#section143015396572) -- [Development Guidelines](#section10604192145816) - - [Available APIs](#section207985910582) - - [How to Develop](#section1015110331584) - - ## Basic Concepts The OpenHarmony LiteOS-A kernel uses the preemptive scheduling mechanism for tasks. The task with a higher priority is scheduled over the task with a lower priority. Time slice round-robin is used to schedule tasks with the same priority. The system runs based on the real-time timeline from the startup, which ensures good real-time performance of the scheduling algorithm. diff --git a/en/device-dev/kernel/kernel-small-basic-process-thread.md b/en/device-dev/kernel/kernel-small-basic-process-thread.md index 0abb01044877f893074498f53e918fb067c61d18..6f8776607dcc9e5d880a2efb2cfb3457cc4b5c4a 100644 --- a/en/device-dev/kernel/kernel-small-basic-process-thread.md +++ b/en/device-dev/kernel/kernel-small-basic-process-thread.md @@ -1,13 +1,5 @@ # Task -- [Basic Concepts](#section138411646175417) -- [Working Principles](#section1381918945512) -- [Development Guidelines](#section10649727135519) - - [Available APIs](#section78333315555) - - [How to Develop](#section16229657115514) - - [Development Example](#section2809723165612) - - ## Basic Concepts Tasks are the minimum running units that compete for system resources. They can use or wait to use CPUs and use system resources such as memory. They run independently from one another. diff --git a/en/device-dev/kernel/kernel-small-basic-softtimer.md b/en/device-dev/kernel/kernel-small-basic-softtimer.md index 84a1fe8ccf23a8353054907ec1e36d41710e5c44..e07578d741dd4663d5a874991dca163ddd9d9ca4 100644 --- a/en/device-dev/kernel/kernel-small-basic-softtimer.md +++ b/en/device-dev/kernel/kernel-small-basic-softtimer.md @@ -1,13 +1,5 @@ # Software Timer -- [Basic Concepts](#section4118241563) -- [Working Principles](#section31079397569) -- [Development Guidelines](#section18576131520577) - - [Available APIs](#section3138019145719) - - [How to Develop](#section1344817403575) - - [Development Example](#section114416313585) - - ## Basic Concepts The software timer is a software-simulated timer based on system tick interrupts. When the preset tick counter value has elapsed, the user-defined callback will be invoked. The timing precision is related to the cycle of the system tick clock. Due to the limitation in hardware, the number of hardware timers cannot meet users' requirements. Therefore, the Huawei LiteOS provides the software timer function. The software timer allows more timing services to be created, increasing the number of timers. diff --git a/en/device-dev/kernel/kernel-small-basic-time.md b/en/device-dev/kernel/kernel-small-basic-time.md index d83df28cd43720327df312cd0b0a2f4a1c574187..9ad0294a85ad265a63f1351187f478e670a8622f 100644 --- a/en/device-dev/kernel/kernel-small-basic-time.md +++ b/en/device-dev/kernel/kernel-small-basic-time.md @@ -1,12 +1,5 @@ # Time Management -- [Basic Concepts](#section12903185785119) -- [Development Guidelines](#section430981720522) - - [Available APIs](#section1040142705214) - - [How to Develop](#section1381224710522) - - [Development Example](#section1344610245416) - - ## Basic Concepts Time management provides all time-related services for applications based on the system clock. The system clock is generated by the interrupts triggered by the output pulse of a timer or counter. The system clock is generally defined as an integer or a long integer. The period of an output pulse is a "clock tick". The system clock is also called time scale or tick. The duration of a tick can be configured statically. People use second or millisecond as the time unit, while the operating system uses tick. When operations such as suspending a task or delaying a task are performed, the time management module converts time between ticks and seconds or milliseconds. diff --git a/en/device-dev/kernel/kernel-small-basic-trans-event.md b/en/device-dev/kernel/kernel-small-basic-trans-event.md index 0978b1fed621576cae3427d37ce79138faccc280..6515858ca608daa2c2a9bebce9d6f707048ff3b4 100644 --- a/en/device-dev/kernel/kernel-small-basic-trans-event.md +++ b/en/device-dev/kernel/kernel-small-basic-trans-event.md @@ -1,19 +1,5 @@ # Event -- [Basic Concepts](#section122115620816) -- [Working Principles](#section94611116593) - - [Event Control Block](#section1161415384467) - - [Working Principles](#section187761153144617) - -- [Development Guidelines](#section44744471891) - - [Available APIs](#section172373513919) - - [How to Develop](#section1118215161013) - - [Development Example](#section19986143311020) - - [Example Description](#section128221510145718) - - [Sample Code](#section71507479577) - - [Verification](#section16570171645813) - - ## Basic Concepts An event is a mechanism for communication between tasks. It can be used to synchronize tasks. diff --git a/en/device-dev/kernel/kernel-small-basic-trans-mutex.md b/en/device-dev/kernel/kernel-small-basic-trans-mutex.md index 202ee9ee9d58893a85aa88663a58881818c084c0..fb52d778c7cc7c8ae22966f2359c3e3f4cdb7833 100644 --- a/en/device-dev/kernel/kernel-small-basic-trans-mutex.md +++ b/en/device-dev/kernel/kernel-small-basic-trans-mutex.md @@ -1,13 +1,5 @@ # Mutex -- [Basic Concepts](#section85865329185) -- [Working Principles](#section8547454201819) -- [Development Guidelines](#section2038861117194) - - [Available APIs](#section11168318131917) - - [How to Develop](#section4201191122116) - - [Development Example](#section10679328202117) - - ## Basic Concepts A mutual exclusion \(mutex\) is a special binary semaphore used for exclusive access to shared resources. When a task holds the mutex, the task obtains the ownership of the mutex. When the task releases the mutex, the task will lose the ownership of the mutex. When a task holds a mutex, other tasks cannot hold the mutex. In an environment where multiple tasks compete for shared resources, the mutex can protect the shared resources via exclusive access. diff --git a/en/device-dev/kernel/kernel-small-basic-trans-queue.md b/en/device-dev/kernel/kernel-small-basic-trans-queue.md index 96ad5f86e8b64f5856a7e534dce1d37260b7dfee..d7366c33aa1c0aa176cdcef7b6d755362469fb86 100644 --- a/en/device-dev/kernel/kernel-small-basic-trans-queue.md +++ b/en/device-dev/kernel/kernel-small-basic-trans-queue.md @@ -1,20 +1,5 @@ # Queue -- [Basic Concepts](#section81171363232) -- [Working Principles](#section1074515132316) - - [Queue Control Block](#section194431851201315) - - [Working Principles](#section89875741418) - -- [Development Guidelines](#section827981242419) - - [Available APIs](#section19327151642413) - - [How to Develop](#section1390154210243) - -- [Development Example](#section27132341285) - - [Example Description](#section197311443141017) - - [Sample Code](#section972214490107) - - [Verification](#section19287165416106) - - ## Basic Concepts A queue, also called a message queue, is a data structure used for communication between tasks. The queue receives messages of unfixed length from tasks or interrupts, and determines whether to store the transferred messages in the queue based on different APIs. diff --git a/en/device-dev/kernel/kernel-small-basic-trans-rwlock.md b/en/device-dev/kernel/kernel-small-basic-trans-rwlock.md index c6e7edc003dc93a5becbc34d62523dc2f3844d78..c2d17c8e1a0e08f17c522ea57784440397d5eca1 100644 --- a/en/device-dev/kernel/kernel-small-basic-trans-rwlock.md +++ b/en/device-dev/kernel/kernel-small-basic-trans-rwlock.md @@ -1,12 +1,5 @@ # RW Lock -- [Basic Concepts](#section4692105214260) -- [Working Principles](#section1239111562720) -- [Development Guidelines](#section11643194275) - - [Available APIs](#section15335332122717) - - [How to Develop](#section14774114882714) - - ## Basic Concepts Similar to a mutex, a read-write lock \(RW lock\) can be used to synchronize tasks in the same process. Different from a mutex, an RW lock allows concurrent access for read operations, while write operations require exclusive access. diff --git a/en/device-dev/kernel/kernel-small-basic-trans-semaphore.md b/en/device-dev/kernel/kernel-small-basic-trans-semaphore.md index 2a3c04fb26454ea3ba54005f33ed78bd50565ef5..ee057e79c09bbe1ba91236b84d8e96a18f399698 100644 --- a/en/device-dev/kernel/kernel-small-basic-trans-semaphore.md +++ b/en/device-dev/kernel/kernel-small-basic-trans-semaphore.md @@ -1,16 +1,5 @@ # Semaphore -- [Basic Concepts](#section1577111168131) -- [Working Principles](#section118423019134) -- [Development Guidelines](#section01419503131) - - [Available APIs](#section1232345431312) - - [How to Develop](#section154261711141419) - - [Development Example](#section658135571417) - - [Example Description](#section125244411653) - - [Sample Code](#section1742105514512) - - [Verification](#section11297301617) - - ## Basic Concepts Semaphore is a mechanism for implementing inter-task communication. It implements synchronization between tasks or exclusive access to shared resources. diff --git a/en/device-dev/kernel/kernel-small-basic-trans-user-mutex.md b/en/device-dev/kernel/kernel-small-basic-trans-user-mutex.md index acf3c95a4b8a4cf9854ff2fb3f4fb6992c324a63..268b48749db67bc4f88197720efa43b2430f5f68 100644 --- a/en/device-dev/kernel/kernel-small-basic-trans-user-mutex.md +++ b/en/device-dev/kernel/kernel-small-basic-trans-user-mutex.md @@ -1,8 +1,5 @@ # Futex -- [Basic Concepts](#section643519912920) -- [Working Principles](#section16834132502910) - ## Basic Concepts Fast userspace mutex \(futex\) is a system call capability provided by the kernel. It is a user-space lock that combines basic components and user-space lock logic. It is a lock used by both user space and kernel space, for example, userspace mutex, barrier and cond synchronization lock, and RW lock. The user-space part implements lock logic, and the kernel-space part implements lock scheduling. diff --git a/en/device-dev/kernel/kernel-small-basic-trans-user-signal.md b/en/device-dev/kernel/kernel-small-basic-trans-user-signal.md index ddfb38afa0aeb13b9bd99688202b3915ab122ce8..7af7fa7eb664d272cf84580ad03abb72e3184cea 100644 --- a/en/device-dev/kernel/kernel-small-basic-trans-user-signal.md +++ b/en/device-dev/kernel/kernel-small-basic-trans-user-signal.md @@ -1,8 +1,5 @@ # Signal -- [Basic Concepts](#section172788254307) -- [Working Principles](#section1249693812301) - ## Basic Concepts Signal is a common inter-process asynchronous communication mechanism. It uses software-simulated interrupt signals. When a process needs to communicate with another process, it sends a signal to the kernel. The kernel then transfers the signal to the destination process. The destination process does not need to wait for the signal. diff --git a/en/device-dev/kernel/kernel-small-bundles-fs-new.md b/en/device-dev/kernel/kernel-small-bundles-fs-new.md index 2211a971a05c06a11837146b78bfc56d6d20656e..2f805224119fe988ef3c65aea9dbe91c23938112 100644 --- a/en/device-dev/kernel/kernel-small-bundles-fs-new.md +++ b/en/device-dev/kernel/kernel-small-bundles-fs-new.md @@ -1,10 +1,5 @@ # File System Adaptation -- [Basic Concepts](#section19480121811422) -- [Adapting the Mount API](#section147051940104212) -- [Adapting the Lookup API](#section11930181394317) -- [Summary and Precautions](#section5617183014319) - ## Basic Concepts The purpose of interconnecting with the VFS layer is to implement API functions defined by the VFS layer. You can adapt some APIs based on the file system features and service requirements. Basically, file read and write must be supported. The minimum file system adaptation is as follows: diff --git a/en/device-dev/kernel/kernel-small-bundles-fs-support-fat.md b/en/device-dev/kernel/kernel-small-bundles-fs-support-fat.md index a6c26ea8b3ff6ac15da9eb3a70bf33eca9a003c3..42076a621fa64ba6c5faf72e3cffbe12a99c8e04 100644 --- a/en/device-dev/kernel/kernel-small-bundles-fs-support-fat.md +++ b/en/device-dev/kernel/kernel-small-bundles-fs-support-fat.md @@ -1,11 +1,5 @@ # FAT -- [Basic Concepts](#section621393911385) -- [Working Principles](#section10796155213381) -- [Development Guidelines](#section144094483919) - - [How to Develop](#section139086116394) - - ## Basic Concepts File Allocation Table \(FAT\) is a file system developed for personal computers. It consists of the Dos Boot Record \(DBR\) region, FAT region, and Data region. Each entry in the FAT region records information about the corresponding cluster in the storage device. The cluster information includes whether the cluster is used, number of the next cluster of the file, whether the file ends. The FAT file system supports multiple formats, such as FAT12, FAT16, and FAT32. The numbers 12, 16, and 32 indicate the number of bytes of the FAT table entries, respectively, and also restrict the maximum file size in the system. The FAT file system supports multiple media, especially removable storage media \(such as USB flash drives, SD cards, and removable hard drives\). The FAT file system ensures good compatibility between embedded devices and desktop systems \(such as Windows and Linux\) and facilitates file management. diff --git a/en/device-dev/kernel/kernel-small-bundles-fs-support-jffs2.md b/en/device-dev/kernel/kernel-small-bundles-fs-support-jffs2.md index cee59071e89c006a35dec492a49b375b357c82de..8d4dc1fbf4f1b893878b4137c626921adb089ee5 100644 --- a/en/device-dev/kernel/kernel-small-bundles-fs-support-jffs2.md +++ b/en/device-dev/kernel/kernel-small-bundles-fs-support-jffs2.md @@ -1,9 +1,5 @@ # JFFS2 -- [Basic Concepts](#section11411110155919) -- [Working Principles](#section23911025195913) -- [Development Guidelines](#section179711119014) - ## Basic Concepts Journalling Flash File System Version 2 \(JFFS2\) is a log-structured file system designed for Memory Technology Devices \(MTDs\). diff --git a/en/device-dev/kernel/kernel-small-bundles-fs-support-nfs.md b/en/device-dev/kernel/kernel-small-bundles-fs-support-nfs.md index fc24e1bcb1771e43fd73efaf266ba2f2667fc5ad..5a08916a7c1f3a3c4f1f5f1d47253121319828e0 100644 --- a/en/device-dev/kernel/kernel-small-bundles-fs-support-nfs.md +++ b/en/device-dev/kernel/kernel-small-bundles-fs-support-nfs.md @@ -1,9 +1,5 @@ # NFS -- [Basic Concepts](#section195414101464) -- [Working Principles](#section165621321194618) -- [Development Guidelines](#section7454935184611) - ## Basic Concepts NFS allows you to share files across hosts and OSs over a network. You can treat NFS as a file system service, which is equivalent to folder sharing in the Windows OS to some extent. diff --git a/en/device-dev/kernel/kernel-small-bundles-fs-support-procfs.md b/en/device-dev/kernel/kernel-small-bundles-fs-support-procfs.md index 3b0451434d0782baf0d9ce0192ea102d17b3b22c..63d58d6db4bcdd7cafb51ba34cc69606f59a5d24 100644 --- a/en/device-dev/kernel/kernel-small-bundles-fs-support-procfs.md +++ b/en/device-dev/kernel/kernel-small-bundles-fs-support-procfs.md @@ -1,11 +1,5 @@ # procfs -- [Basic Concepts](#section146801917174017) -- [Working Principles](#section479762916408) -- [Development Guidelines](#section1221174524014) - - [Development Example](#section52016575401) - - ## Basic Concepts The proc filesystem \(procfs\) is a virtual file system that displays process or other system information in a file-like structure. It is more convenient to obtain system information in file operation mode compared with API calling mode. diff --git a/en/device-dev/kernel/kernel-small-bundles-fs-support-ramfs.md b/en/device-dev/kernel/kernel-small-bundles-fs-support-ramfs.md index 20a4931031adc8cb191c798850138e31a42a53a3..d6b263a30374de3593b841928a4e9a9c682dee6a 100644 --- a/en/device-dev/kernel/kernel-small-bundles-fs-support-ramfs.md +++ b/en/device-dev/kernel/kernel-small-bundles-fs-support-ramfs.md @@ -1,9 +1,5 @@ # Ramfs -- [Basic Concepts](#section9507151014420) -- [Working Principles](#section1859711263447) -- [Development Guidelines](#section163554380448) - ## Basic Concepts Ramfs is a RAM-based file system whose size can be dynamically adjusted. Ramfs does not have a backing store. Directory entries and page caches are allocated when files are written into ramfs. However, data is not written back to any other storage medium, and data is lost after a power outage. diff --git a/en/device-dev/kernel/kernel-small-bundles-fs-virtual.md b/en/device-dev/kernel/kernel-small-bundles-fs-virtual.md index f8fc8e5e1c7cbcb9848c00dfd8d68b50febdb3cd..126599e33870da970dbb3a2aac25f3798d4edb5b 100644 --- a/en/device-dev/kernel/kernel-small-bundles-fs-virtual.md +++ b/en/device-dev/kernel/kernel-small-bundles-fs-virtual.md @@ -1,13 +1,5 @@ # Virtual File System -- [Basic Concepts](#section1253851143520) -- [Working Principles](#section14915913123510) -- [Development Guidelines](#section1759563620358) - - [Available APIs](#section17865142133511) - - [How to Develop](#section64113023616) - - [Development Example](#section236041883618) - - ## Basic Concepts The Virtual File System \(VFS\) is not a real file system. It is an abstract layer on top of a heterogeneous file system and provides you with a unified Unix-like file operation interface. Different types of file systems provide different interfaces. If there are multiple types of file systems in the system, different and non-standard interfaces are required for accessing these file systems. The VFS can be introduced as an abstract layer in the system to harmonize the differences between these heterogeneous file systems. In this way, the system does not need to care about the storage medium and file system type at the bottom layer when accessing a file system. diff --git a/en/device-dev/kernel/kernel-small-bundles-ipc.md b/en/device-dev/kernel/kernel-small-bundles-ipc.md index d4d7107842735adcdbde825908e87a48e0f720fb..1a3c66aa9d4b5141329bbc17867fd1a99e06a743 100644 --- a/en/device-dev/kernel/kernel-small-bundles-ipc.md +++ b/en/device-dev/kernel/kernel-small-bundles-ipc.md @@ -1,11 +1,5 @@ # LiteIPC -- [Basic Concepts](#section1980994712918) -- [Working Principles](#section849811592918) -- [Development Guidelines](#section17571315171017) - - [Available APIs](#section725022011103) - - ## Basic Concepts LiteIPC is a new inter-process communication \(IPC\) mechanism provided by the OpenHarmony LiteOS-A kernel. Different from the traditional System V IPC, LiteIPC is designed for Remote Procedure Call \(RPC\). In addition, it provides APIs for the upper layer through device files, not through traditional API functions. diff --git a/en/device-dev/kernel/kernel-small-bundles-linking.md b/en/device-dev/kernel/kernel-small-bundles-linking.md index dcca834b580975c5e7ef1abf9be342f9c9578e13..6e8c8df34ffb04d01cfdaa87e61ff50775044a45 100644 --- a/en/device-dev/kernel/kernel-small-bundles-linking.md +++ b/en/device-dev/kernel/kernel-small-bundles-linking.md @@ -1,12 +1,5 @@ # Dynamic Loading and Linking -- [Basic Concepts](#section208951139453) -- [Working Principles](#section14140155320511) -- [Development Guidelines](#section133501496612) - - [Available APIs](#section874113201669) - - [How to Develop](#section196712561563) - - ## Basic Concepts The OpenHarmony dynamic loading and linking mechanism includes a kernel loader and a dynamic linker. The kernel loader loads application programs and the dynamic linker. The dynamic linker loads the shared library on which the application programs depend, and performs symbol relocation for the application programs and shared libraries. Compared with static linking, dynamic linking is a mechanism for delaying the linking of applications and dynamic libraries to run time. diff --git a/en/device-dev/kernel/kernel-small-bundles-share.md b/en/device-dev/kernel/kernel-small-bundles-share.md index fc519c07e156e371cc723a4b7e7ec82f6d92ed17..4a9a4865c27d5d34cfe97c9caa8ba6aeebd4f718 100644 --- a/en/device-dev/kernel/kernel-small-bundles-share.md +++ b/en/device-dev/kernel/kernel-small-bundles-share.md @@ -1,8 +1,5 @@ # Virtual Dynamic Shared Object -- [Basic Concepts](#section174577181688) -- [Working Principles](#section546363114810) - ## Basic Concepts Different from a common dynamic shared library, which stores its so files in the file system, the virtual dynamic shared object \(VDSO\) has its so files stored in the system image. The kernel determines the so files and provides them to the application program. That is why the VDSO is called a virtual dynamic shared library. diff --git a/en/device-dev/kernel/kernel-small-bundles-system.md b/en/device-dev/kernel/kernel-small-bundles-system.md index 12d304f4f634325627f4ccf143feb8623458fda7..8093033233363359edec22aa0fb1b1124492fbd1 100644 --- a/en/device-dev/kernel/kernel-small-bundles-system.md +++ b/en/device-dev/kernel/kernel-small-bundles-system.md @@ -1,12 +1,5 @@ # System Call -- [Basic Concepts](#section889710401734) -- [Working Principles](#section195177541314) -- [Development Guidelines](#section193492047135419) - - [How to Develop](#section7165741122210) - - [Development Example](#section107131418224) - - ## Basic Concepts The OpenHarmony LiteOS-A isolates the user space and kernel space. User-space programs cannot directly access kernel resources. System calls provide a channel for user-space programs to access kernel resources and interact with the kernel. diff --git a/en/device-dev/kernel/kernel-small-debug-memory-corrupt.md b/en/device-dev/kernel/kernel-small-debug-memory-corrupt.md index 1196dd3ce2208996324f41e4dc9c3355007b8946..ca9c332a51ee0810a93764fa816a009b4b00d8d0 100644 --- a/en/device-dev/kernel/kernel-small-debug-memory-corrupt.md +++ b/en/device-dev/kernel/kernel-small-debug-memory-corrupt.md @@ -1,12 +1,5 @@ # Memory Corruption Check -- [Basic Concepts](#section17368154517335) -- [Function Configuration](#section4696190123420) -- [Development Guidelines](#section672362973417) - - [How to Develop](#section026014863416) - - [Development Example](#section186311302356) - - ## Basic Concepts As an optional function of the kernel, memory corruption check is used to check the integrity of a dynamic memory pool. This mechanism can detect memory corruption errors in the memory pool in a timely manner and provide alerts. It helps reduce problem locating costs and increase troubleshooting efficiency. diff --git a/en/device-dev/kernel/kernel-small-debug-memory-info.md b/en/device-dev/kernel/kernel-small-debug-memory-info.md index d87652c782de7f205d4cd5d9eda743b396656daf..42b50c6b7caa073b6aaa6bad7892331188bb4ba6 100644 --- a/en/device-dev/kernel/kernel-small-debug-memory-info.md +++ b/en/device-dev/kernel/kernel-small-debug-memory-info.md @@ -1,12 +1,5 @@ # Memory Information Statistics -- [Basic Concepts](#section52691565235) -- [Function Configuration](#section470611682411) -- [Development Guidelines](#section9368374243) - - [How to Develop](#section679912407257) - - [Development Example](#section1025453412611) - - ## Basic Concepts Memory information includes the memory pool size, memory usage, remaining memory size, maximum free memory, memory waterline, number of memory nodes, and fragmentation rate. diff --git a/en/device-dev/kernel/kernel-small-debug-memory-leak.md b/en/device-dev/kernel/kernel-small-debug-memory-leak.md index 9034ad920ac1c840881440367f3cf1cb14e08999..91daa09ebc0298ec4826b58a9ebf9353c32fd31b 100644 --- a/en/device-dev/kernel/kernel-small-debug-memory-leak.md +++ b/en/device-dev/kernel/kernel-small-debug-memory-leak.md @@ -1,12 +1,5 @@ # Memory Leak Check -- [Basic Concepts](#section1026719436293) -- [Function Configuration](#section13991354162914) -- [Development Guidelines](#section95828159308) - - [How to Develop](#section369844416304) - - [Development Example](#section460801313313) - - ## Basic Concepts As an optional function of the kernel, memory leak check is used to locate dynamic memory leak problems. After this function is enabled, the dynamic memory automatically records the link registers \(LRs\) used when memory is allocated. If a memory leak occurs, the recorded information helps locate the memory allocated for further analysis. diff --git a/en/device-dev/kernel/kernel-small-debug-process-cpu.md b/en/device-dev/kernel/kernel-small-debug-process-cpu.md index 2a5249e7fb14ed65ee130836d5e8c701db753006..9409a744deefdf64db552ca7a9f1f69712ec4513 100644 --- a/en/device-dev/kernel/kernel-small-debug-process-cpu.md +++ b/en/device-dev/kernel/kernel-small-debug-process-cpu.md @@ -1,13 +1,5 @@ # CPUP -- [Basic Concepts](#section17683419227) -- [Working Principles](#section593718536227) -- [Development Guidelines](#section11284210152311) - - [Available APIs](#section3745151592312) - - [How to Develop](#section122901429182316) - - [Development Example](#section1765785212310) - - ## Basic Concepts The central processing unit percent \(CPUP\) includes the system CPUP, process CPUP, task CPUP, and interrupt CPUP. With the system CPUP, you can determine whether the current system load exceeds the designed specifications. With the CPUP of each task/process/interrupt, you can determine whether the CPU usage of each task/process/interrupt meets expectations of the design. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-build.md b/en/device-dev/kernel/kernel-small-debug-shell-build.md index b8aabd6dbba9906697e51852bb64b21469fbd360..2fc4049ea41956f8e55734527dbe2f3d51ebb38e 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-build.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-build.md @@ -1,11 +1,5 @@ # Shell Command Programming Example -- [Example Description](#section87143612316) -- [Static Registration](#section1660495712314) -- [Static Registration Programming Example](#section1233411684113) -- [Dynamic Registration](#section6804126192412) -- [Dynamic Registration Programming Example](#section2335121613418) - ## Example Description This section describes how to add a shell command **test** using static registration and dynamic registration, respectively. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-cmd-cpup.md b/en/device-dev/kernel/kernel-small-debug-shell-cmd-cpup.md index 5dc651761a7b351f259ea20c0d23d3caffc8c3c5..d225ad7dcd2f4a30dee63d9edd4a76abb6f2320c 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-cmd-cpup.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-cmd-cpup.md @@ -1,12 +1,5 @@ # cpup -- [Command Function](#section1842161614217) -- [Syntax](#section5629527427) -- [Parameters](#section133651361023) -- [Usage](#section156611948521) -- [Example](#section68501605319) -- [Output](#section19871522144219) - ## Command Function This command is used to query the CPU usage \(CPU percent\) of the system. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-cmd-date.md b/en/device-dev/kernel/kernel-small-debug-shell-cmd-date.md index 81699efec836fad5f089c6fa0769fff5768f3fe1..e39a88797da97d65335e0ca51682b697cc613929 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-cmd-date.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-cmd-date.md @@ -1,12 +1,5 @@ # date -- [Command Function](#section56472016338) -- [Syntax](#section16635112512316) -- [Parameters](#section15896030039) -- [Usage](#section116361036636) -- [Example](#section021711411237) -- [Output](#section17950184414312) - ## Command Function This command is used to query and set the system date and time. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-cmd-dmesg.md b/en/device-dev/kernel/kernel-small-debug-shell-cmd-dmesg.md index 73a0f21a668d97bed53e764c1c7157f68e698901..ea6c7385a2ce3dee34d9d5afeb2964d735ffa747 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-cmd-dmesg.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-cmd-dmesg.md @@ -1,12 +1,5 @@ # dmesg -- [Command Function](#section4643204919313) -- [Syntax](#section6553153635) -- [Parameters](#section208971157532) -- [Usage](#section213115219413) -- [Example](#section13736564418) -- [Output](#section194005101413) - ## Command Function This command is used to control the dmesg buffer of the kernel. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-cmd-exec.md b/en/device-dev/kernel/kernel-small-debug-shell-cmd-exec.md index c9a7a4b03df1d3b2b43592cb5e82bd750ac906dc..302490df4958b7b3c607fb8de2e286eeb5015633 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-cmd-exec.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-cmd-exec.md @@ -1,12 +1,5 @@ # exec -- [Command Function](#section4643204919313) -- [Syntax](#section6553153635) -- [Parameters](#section208971157532) -- [Usage](#section213115219413) -- [Example](#section13736564418) -- [Output](#section194005101413) - ## Command Function This command is a built-in shell command used to execute user-space programs. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-cmd-free.md b/en/device-dev/kernel/kernel-small-debug-shell-cmd-free.md index 72ccebde071b2728179f055c4bf3d31c9e63af96..5dd95c0de6b5caed5aa753924724716210e16a01 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-cmd-free.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-cmd-free.md @@ -1,12 +1,5 @@ # free -- [Command Function](#section175151514841) -- [Syntax](#section8488721749) -- [Parameters](#section27272181949) -- [Usage](#section148661259410) -- [Example](#section68081530242) -- [Output](#section171235517543) - ## Command Function This command is used to display the system memory usage and the sizes of the **text**, **data**, **rodata**, and **bss** segments. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-cmd-help.md b/en/device-dev/kernel/kernel-small-debug-shell-cmd-help.md index 3dfed6fdfdbb505a656873d44fd0c21ac6f48984..691461db4777d9089754ac1dc1e6c658d00a935e 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-cmd-help.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-cmd-help.md @@ -1,12 +1,5 @@ # help -- [Command Function](#section991211345413) -- [Syntax](#section19103204016410) -- [Parameters](#section1533416233432) -- [Usage](#section4156445417) -- [Example](#section12776124712417) -- [Output](#section092662412544) - ## Command Function This command is used to display all commands in the OS. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-cmd-hwi.md b/en/device-dev/kernel/kernel-small-debug-shell-cmd-hwi.md index 5617700d4a9cca3ffb82744624e2723fa6c54593..1fff611d19733456c80b1415e342142fc671e18e 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-cmd-hwi.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-cmd-hwi.md @@ -1,12 +1,5 @@ # hwi -- [Command Function](#section445335110416) -- [Syntax](#section1795712553416) -- [Parameters](#section92544592410) -- [Usage](#section104151141252) -- [Example](#section11545171957) -- [Output](#section075617368542) - ## Command Function This command is used to query information about the interrupts. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-cmd-kill.md b/en/device-dev/kernel/kernel-small-debug-shell-cmd-kill.md index e1f20cf890b2eee2a34332880ea1782d9852f612..8ca3ab7cb45761f2dfa8250477a955ab4cd361b7 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-cmd-kill.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-cmd-kill.md @@ -1,12 +1,5 @@ # kill -- [Command Function](#section366714216619) -- [Syntax](#section8833164614615) -- [Parameters](#section12809111019453) -- [Usage](#section15935131220717) -- [Example](#section79281818476) -- [Output](#section12742311179) - ## Command Function This command is used to send a specific signal to a specified process. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-cmd-log.md b/en/device-dev/kernel/kernel-small-debug-shell-cmd-log.md index 509983f1971bc27d01623ef93cb9434fae49ea43..175315bf64b314ef398647f0f8f542ee1eb6c7a7 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-cmd-log.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-cmd-log.md @@ -1,12 +1,5 @@ # log -- [Command Function](#section128219131856) -- [Syntax](#section3894181710519) -- [Parameters](#section7693122310515) -- [Usage](#section1982111281512) -- [Example](#section176301333259) -- [Output](#section14354765415) - ## Command Function This command is used to modify and query log configurations. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-cmd-memcheck.md b/en/device-dev/kernel/kernel-small-debug-shell-cmd-memcheck.md index c635c4b16fabdc80730f00f65d507146cab28ddd..19e400eb677a87fe1f5dbed18cf893e326813170 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-cmd-memcheck.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-cmd-memcheck.md @@ -1,12 +1,5 @@ # memcheck -- [Command Function](#section191633812516) -- [Syntax](#section428816435510) -- [Parameters](#section1939943304411) -- [Usage](#section228914491951) -- [Example](#section17373205314515) -- [Output](#section13406205385413) - ## Command Function This command is used to check whether the dynamically requested memory block is complete and whether nodes in the memory pool are damaged due to out-of-bounds memory access. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-cmd-oom.md b/en/device-dev/kernel/kernel-small-debug-shell-cmd-oom.md index 026dbd948c5c5b13d476ef21dfbd2367108d61f7..34bfe3ca1c321142164767b4b6fb82087f398640 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-cmd-oom.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-cmd-oom.md @@ -1,11 +1,5 @@ # oom -- [Command Function](#section366714216619) -- [Syntax](#section8833164614615) -- [Parameters](#section12809111019453) -- [Usage](#section15935131220717) -- [Output](#section12742311179) - ## Command Function This command is used to query and set the low memory threshold and the page cache reclaim threshold. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-cmd-pmm.md b/en/device-dev/kernel/kernel-small-debug-shell-cmd-pmm.md index 73afe9605395da1c0bb3b85f7dda489e4009dbdf..5cea14e507b6ffff4fd185036757c8c4f47c9adb 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-cmd-pmm.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-cmd-pmm.md @@ -1,12 +1,5 @@ # pmm -- [Command Function](#section445335110416) -- [Syntax](#section1795712553416) -- [Parameters](#section92544592410) -- [Usage](#section104151141252) -- [Example](#section11545171957) -- [Output](#section075617368542) - ## Command Function This command is used to check the usage of the physical pages and page cache of the system memory. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-cmd-reset.md b/en/device-dev/kernel/kernel-small-debug-shell-cmd-reset.md index dc99159f9c86d35c2e9cef4005b1406db83f9b70..b4df72c4adfb85fb76fd71945d6728d232c71279 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-cmd-reset.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-cmd-reset.md @@ -1,12 +1,5 @@ # reset -- [Command Function](#section366714216619) -- [Syntax](#section8833164614615) -- [Parameters](#section12809111019453) -- [Usage](#section15935131220717) -- [Example](#section79281818476) -- [Output](#section12742311179) - ## Command Function This command is used to restart a device. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-cmd-sem.md b/en/device-dev/kernel/kernel-small-debug-shell-cmd-sem.md index 1c45bf5e7d5a8fb8a50ce6b00aeaa5293682567e..fe4a6baa3799b9d7563f1723b42e864b14eb55ef 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-cmd-sem.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-cmd-sem.md @@ -1,12 +1,5 @@ # sem -- [Command Function](#section366714216619) -- [Syntax](#section8833164614615) -- [Parameters](#section12809111019453) -- [Usage](#section15935131220717) -- [Example](#section79281818476) -- [Output](#section1975118519456) - ## Command Function This command is used to query information about kernel semaphores. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-cmd-stack.md b/en/device-dev/kernel/kernel-small-debug-shell-cmd-stack.md index 9a85dcfd07b9a5e6e99ade02a11978d85c9c9bb5..3cb06ac71b1204e60ccd5aaa0946ee13fca293d2 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-cmd-stack.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-cmd-stack.md @@ -1,12 +1,5 @@ # stack -- [Command Function](#section445335110416) -- [Syntax](#section1795712553416) -- [Parameters](#section92544592410) -- [Usage](#section104151141252) -- [Example](#section11545171957) -- [Output](#section075617368542) - ## Command Function This command is used to check the usage of each stack in the system. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-cmd-su.md b/en/device-dev/kernel/kernel-small-debug-shell-cmd-su.md index 7886594c61103fb9e42f6d4223661d53535ef063..49f296dbf72517c84476c3d96d0b5b4544c157f9 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-cmd-su.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-cmd-su.md @@ -1,12 +1,5 @@ # su -- [Command Function](#section297810431676) -- [Syntax](#section157131147876) -- [Parameters](#section04145521671) -- [Usage](#section14615155610719) -- [Example](#section13338150985) -- [Output](#section125021924194613) - ## Command Function This command is used to switch the user. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-cmd-swtmr.md b/en/device-dev/kernel/kernel-small-debug-shell-cmd-swtmr.md index 8c0579172f79f8a82da84d3b751db9685bc5ffb1..b5aea0c05c78e552f6af58ea1c67ceaadd5d5cda 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-cmd-swtmr.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-cmd-swtmr.md @@ -1,12 +1,5 @@ # swtmr -- [Command Function](#section166171064814) -- [Syntax](#section424011111682) -- [Parameters](#section1268410459465) -- [Usage](#section169806213815) -- [Example](#section16676026389) -- [Output](#section1541991614710) - ## Command Function This command is used to query information about system software timers. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-cmd-sysinfo.md b/en/device-dev/kernel/kernel-small-debug-shell-cmd-sysinfo.md index d5f65ba9ee6cc2be9f0af434423766954f8e78a5..f1ef069637786f55656d6e26d5dd42e99f4c31ff 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-cmd-sysinfo.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-cmd-sysinfo.md @@ -1,12 +1,5 @@ # systeminfo -- [Command Function](#section863016434820) -- [Syntax](#section139791817795) -- [Parameters](#section19472339164813) -- [Usage](#section285522592) -- [Example](#section9471171015105) -- [Output](#section1657011114915) - ## Command Function This command is used to display the resource usage of the current OS, including tasks, semaphores, mutexes, queues, and timers. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-cmd-task.md b/en/device-dev/kernel/kernel-small-debug-shell-cmd-task.md index c5ed3e1dbe1eb20a3b9dfcc134884f2cb1928526..4e6a7ce549ec68c20824971bfe6366f84fd2094d 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-cmd-task.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-cmd-task.md @@ -1,12 +1,5 @@ # task -- [Command Function](#section0533181714106) -- [Syntax](#section1014412308101) -- [Parameters](#section116057158506) -- [Usage](#section2053502951112) -- [Example](#section12629113381116) -- [Output](#section19299103465015) - ## Command Function This command is used to query information about processes and threads. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-cmd-uname.md b/en/device-dev/kernel/kernel-small-debug-shell-cmd-uname.md index 615b8d46bdca25e5940c4691a5c8372c055bc894..243b928c1616f138730b1ae374d7928907ab3049 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-cmd-uname.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-cmd-uname.md @@ -1,11 +1,5 @@ # uname -- [Command Function](#section107697383115) -- [Syntax](#section162824341116) -- [Usage](#section2652124861114) -- [Example](#section0107995132) -- [Output](#section1215113245511) - ## Command Function This command is used to display the name, version creation time, system name, and version information of the current OS. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-cmd-vmm.md b/en/device-dev/kernel/kernel-small-debug-shell-cmd-vmm.md index 621cefee4f4640b8ffe78a1e5fd3aedc786f67d8..2a3437608cf6729f33bd53fbbc092037168899cf 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-cmd-vmm.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-cmd-vmm.md @@ -1,12 +1,5 @@ # vmm -- [Command Function](#section445335110416) -- [Syntax](#section1795712553416) -- [Parameters](#section92544592410) -- [Usage](#section104151141252) -- [Example](#section11545171957) -- [Output](#section075617368542) - ## Command Function This command is used to query the virtual memory usage of a process. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-cmd-watch.md b/en/device-dev/kernel/kernel-small-debug-shell-cmd-watch.md index 48ac0ba4138057b0258485136a1ee58fdc14df78..94cc69f072cfc9b307e0905dc2deefbdf59d125c 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-cmd-watch.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-cmd-watch.md @@ -1,12 +1,5 @@ # watch -- [Command Function](#section20643141481314) -- [Syntax](#section1075441721316) -- [Parameters](#section1472810220135) -- [Usage](#section186772414131) -- [Example](#section4764192791314) -- [Output Description](#section5791253155517) - ## Command Function This command is used to periodically monitor the execution result of a command. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-file-cat.md b/en/device-dev/kernel/kernel-small-debug-shell-file-cat.md index cf3cd02b30510a4ce088a9537267e59b104f26a6..ba509bf07b14ba0c189af689657fac1d954cfeeb 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-file-cat.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-file-cat.md @@ -1,12 +1,5 @@ # cat -- [Command Function](#section16710153391315) -- [Syntax](#section1699392313158) -- [Parameters](#section1677217374136) -- [Usage](#section186772414131) -- [Example](#section12158131814561) -- [Output](#section183926225561) - ## Command Function This command is used to display the content of a text file. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-file-cd.md b/en/device-dev/kernel/kernel-small-debug-shell-file-cd.md index a976797aef18aa45939afdb6f9b97ebf5ca3ef14..83730053a57dfa891be73c0b19b655c1e3c74d46 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-file-cd.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-file-cd.md @@ -1,12 +1,5 @@ # cd -- [Command Function](#section11690184921316) -- [Syntax](#section75695409569) -- [Parameters](#section71961353181311) -- [Usage](#section3629759111317) -- [Example](#section211620301412) -- [Output](#section1968117214577) - ## Command Function This command is used to change the current working directory. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-file-chgrp.md b/en/device-dev/kernel/kernel-small-debug-shell-file-chgrp.md index ab9601350d0a7a0c65be452a056369957d6d96bf..6f8f01ec96bcabae3360a0f0a4a765002a230434 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-file-chgrp.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-file-chgrp.md @@ -1,12 +1,5 @@ # chgrp -- [Command Function](#section6103119161418) -- [Syntax](#section186958132141) -- [Parameter Description](#section81796174141) -- [Usage](#section14330152417140) -- [Example](#section951823119149) -- [Output](#section14271133125715) - ## Command Function This command is used to change a file group. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-file-chmod.md b/en/device-dev/kernel/kernel-small-debug-shell-file-chmod.md index b8c6d7e2a5db2ebab3160f22f5e770cb8adefd1d..656b85c0738178e18634ca7e9fd51811cdc3e209 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-file-chmod.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-file-chmod.md @@ -1,12 +1,5 @@ # chmod -- [Command Function](#section13992936121418) -- [Syntax](#section63342439147) -- [Parameter Description](#section894414671411) -- [Usage](#section182415221419) -- [Example](#section8518195718147) -- [Output](#section127391818158) - ## Command Function This command is used to change the file operation permission. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-file-chown.md b/en/device-dev/kernel/kernel-small-debug-shell-file-chown.md index a4832359c403bf144325cd2b0f88d9f49a444394..f8a13edb7a69d5dfb16c6cc7ced7ca6f95781dd9 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-file-chown.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-file-chown.md @@ -1,12 +1,5 @@ # chown -- [Command Function](#section247414691513) -- [Syntax](#section14773151018159) -- [Parameters](#section598731391517) -- [Usage](#section16524152071510) -- [Example](#section17901152561510) -- [Output](#section15513163115816) - ## Command Function This command is used to change the owner and group of a specified file. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-file-cp.md b/en/device-dev/kernel/kernel-small-debug-shell-file-cp.md index f3409fe9760cd9966a8efb169e5b77987d21ca11..69e530cf254bcc68de6af359d8d5a6db3413c620 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-file-cp.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-file-cp.md @@ -1,12 +1,5 @@ # cp -- [Command Function](#section6841203041513) -- [Syntax](#section24286359150) -- [Parameters](#section558617385152) -- [Usage](#section16128156162) -- [Example](#section19354171211618) -- [Output](#section16754183195914) - ## Command Function This command is used to create a copy for a file. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-file-format.md b/en/device-dev/kernel/kernel-small-debug-shell-file-format.md index 19ea6af44cbff0489acdf586a24b339b5e19dcf1..5fff38b11ee7d53a59c77ca7ae7388b2914478f2 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-file-format.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-file-format.md @@ -1,12 +1,5 @@ # format -- [Command Function](#section1922331919169) -- [Syntax](#section249226169) -- [Parameters](#section985173416177) -- [Usage](#section1510162714162) -- [Example](#section25691431161611) -- [Output](#section17368112365920) - ## Command Function This command is used to format a disk. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-file-ls.md b/en/device-dev/kernel/kernel-small-debug-shell-file-ls.md index 868a7c887d1b8fa8172fad127f11e5527075d37b..becd75f2446a55d3c9a08ae72f02d7d0dfe7e4e3 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-file-ls.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-file-ls.md @@ -1,12 +1,5 @@ # ls -- [Command Function](#section6538163771614) -- [Syntax](#section45881743111616) -- [Parameters](#section17528148171617) -- [Usage](#section041212533166) -- [Example](#section986105716167) -- [Output](#section2036124918592) - ## Command Function This command is used to display the content of a specified directory. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-file-lsfd.md b/en/device-dev/kernel/kernel-small-debug-shell-file-lsfd.md index 0c9219d47055ae69f6bc62cb0992ef25a9209004..ffc723559e63540cd08fec3b5ed31a6b57cf0ed8 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-file-lsfd.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-file-lsfd.md @@ -1,11 +1,5 @@ # lsfd -- [Command Function](#section2053406181716) -- [Syntax](#section523771017172) -- [Usage](#section27241213201719) -- [Example](#section442617197173) -- [Output](#section42491639151813) - ## Command Function This command is used to display the file descriptors and names of the files that are open. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-file-mkdir.md b/en/device-dev/kernel/kernel-small-debug-shell-file-mkdir.md index 7273ce06945d88ce084947735025e3420a7a08f8..27e29b3f1d9473aa26c5c2770b6f1e5bd319df12 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-file-mkdir.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-file-mkdir.md @@ -1,12 +1,5 @@ # mkdir -- [Command Function](#section1083613274175) -- [Syntax](#section820913118178) -- [Parameters](#section1256834121718) -- [Usage](#section1294234115172) -- [Example](#section1113345211713) -- [Output](#section10142201012) - ## Command Function This command is used to create a directory. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-file-mount.md b/en/device-dev/kernel/kernel-small-debug-shell-file-mount.md index ac758b7aaa5ca144644b6558c1796839bcb2a3ec..a67bd4799b7c3728d4e715031aa5da1523a105da 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-file-mount.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-file-mount.md @@ -1,12 +1,5 @@ # mount -- [Command Function](#section11631837182) -- [Syntax](#section1697638111820) -- [Parameters](#section1650151221819) -- [Usage](#section124541520171912) -- [Example](#section7424625171917) -- [Output](#section14757018116) - ## Command Function This command is used to mount a device to a specified directory. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-file-partinfo.md b/en/device-dev/kernel/kernel-small-debug-shell-file-partinfo.md index fc78146d8fd81f26128c90f59e6eabda446af7fb..b1c8f51d04b5a83bb0ffe4a339989453cdc72bea 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-file-partinfo.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-file-partinfo.md @@ -1,12 +1,5 @@ # partinfo -- [Command Function](#section1777503617199) -- [Syntax](#section185501447132114) -- [Parameters](#section1304151212252) -- [Usage](#section4566131982520) -- [Example](#section4351134942514) -- [Output](#section66689331412) - ## Command Function This command is used to query information about the partitions of a hard disk or SD card identified by the system. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-file-partition.md b/en/device-dev/kernel/kernel-small-debug-shell-file-partition.md index 92e07a867ffb3d0f89d7eb0e3670d73ea7154da7..eae2263e1a4191e7f6a58bc8fc81502aa7597c90 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-file-partition.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-file-partition.md @@ -1,12 +1,5 @@ # partition -- [Command Function](#section255095212257) -- [Syntax](#section10258056122515) -- [Parameters](#section177200581256) -- [Usage](#section17866411262) -- [Example](#section1927174202610) -- [Output](#section11321011223) - ## Command Function This command is used to query flash partition information. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-file-pwd.md b/en/device-dev/kernel/kernel-small-debug-shell-file-pwd.md index 53c5c94080b19c2089cc1456491ef3ddd8db5d02..45105c3d9e09893c75a57613b65a88b315d824c0 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-file-pwd.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-file-pwd.md @@ -1,12 +1,5 @@ # pwd -- [Command Function](#section197737712267) -- [Syntax](#section1544061016267) -- [Parameters](#section599112120262) -- [Usage](#section66901116152615) -- [Example](#section7427181922612) -- [Output](#section116313389418) - ## Command Function This command is used to display the current path. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-file-rm.md b/en/device-dev/kernel/kernel-small-debug-shell-file-rm.md index 90b52286a7c5dffb9f2793275675cfbbe9afda8c..8163d8398e3d6daa1a76eb0b2b9466d4489bcc5b 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-file-rm.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-file-rm.md @@ -1,12 +1,5 @@ # rm -- [Command Function](#section181141523142613) -- [Syntax](#section8800926132619) -- [Parameters](#section15476229152617) -- [Usage](#section10578163215262) -- [Example](#section18548133511263) -- [Output](#section1565323814265) - ## Command Function This command is used to delete a file or folder. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-file-rmdir.md b/en/device-dev/kernel/kernel-small-debug-shell-file-rmdir.md index bdc4ecf057a3e63fc450ad09a10cc3df139121e7..d100ced24c1da1362d4914fcb77770aad4b06ee8 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-file-rmdir.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-file-rmdir.md @@ -1,12 +1,5 @@ # rmdir -- [Command Function](#section1839611420266) -- [Syntax](#section329574512266) -- [Parameters](#section15865747102620) -- [Usage](#section107857508261) -- [Example](#section11196165315262) -- [Output](#section1073811415613) - ## Command Function This command is used to delete a directory. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-file-statfs.md b/en/device-dev/kernel/kernel-small-debug-shell-file-statfs.md index 59a073c1c6e62c9f34f082134aceb016bb63d5b3..075b20bd9103a87c3f16eae72b2100172996b68e 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-file-statfs.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-file-statfs.md @@ -1,11 +1,5 @@ # statfs -- [Command Function](#section153921657152613) -- [Syntax](#section135391102717) -- [Parameters](#section074312314279) -- [Usage](#section133816772712) -- [Example](#section526149182717) - ## Command Function This command is used to print information about a file system, such as the type, total size, and available size. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-file-sync.md b/en/device-dev/kernel/kernel-small-debug-shell-file-sync.md index 6e8c72e2860cedbf488af181519fdaebe5f653b6..d702ed80a74ae6c6d5c9b51e4c12353483fb3f6c 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-file-sync.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-file-sync.md @@ -1,12 +1,5 @@ # sync -- [Command Function](#section1285017122274) -- [Syntax](#section4731516162712) -- [Parameters](#section9352418122714) -- [Usage](#section10725192142717) -- [Example](#section414434814354) -- [Output](#section19618121710317) - ## Command Function This command is used to synchronize cached data \(data in the file system\) to an SD card. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-file-touch.md b/en/device-dev/kernel/kernel-small-debug-shell-file-touch.md index 444be360786cae74e8d285b802aaf340d056cdcc..c8254e36355681084b4945b90a8ddca4590b25d5 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-file-touch.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-file-touch.md @@ -1,12 +1,5 @@ # touch -- [Command Function](#section17541924112716) -- [Syntax](#section866182711274) -- [Parameters](#section268912296270) -- [Usage](#section412093332714) -- [Example](#section414434814354) -- [Output](#section1028419515711) - ## Command Function - This command is used to create an empty file in a specified directory. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-file-umount.md b/en/device-dev/kernel/kernel-small-debug-shell-file-umount.md index d0dfb1adf251c76c1da4a82d5bddadb5c1238f64..c7c2bbf19324c2d3dda4b1626a2569ee1eb21bef 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-file-umount.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-file-umount.md @@ -1,12 +1,5 @@ # umount -- [Command Function](#section365125133520) -- [Syntax](#section9615254123512) -- [Parameters](#section63446577355) -- [Usage](#section92931509368) -- [Example](#section144311323616) -- [Output](#section360525113611) - ## Command Function This command is used to unmount a specified file system. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-file-write.md b/en/device-dev/kernel/kernel-small-debug-shell-file-write.md index 4a9dd52448c1131f4fb028f70240cb530c11b37f..bb16d5bbe12159ceeb8a018f3f13c9943fd82713 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-file-write.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-file-write.md @@ -1,12 +1,5 @@ # writeproc -- [Command Function](#section366714216619) -- [Syntax](#section8833164614615) -- [Parameters](#section12809111019453) -- [Usage](#section15935131220717) -- [Example](#section79281818476) -- [Output](#section12742311179) - ## Command Function This command is used to write data to a specified proc file system. The proc file system supports the input of string parameters. Each file needs to implement its own method. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-guide.md b/en/device-dev/kernel/kernel-small-debug-shell-guide.md index 588af244e9bdf0bf2a306b9cde20ad577c4bdb1d..7a921ef64ebeba5cd6a9438771655f05b5c6e12c 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-guide.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-guide.md @@ -1,7 +1,5 @@ # Shell Command Development Guidelines -- [Development Guidelines](#section13408945163812) - ## Development Guidelines You can perform the following operations to add shell commands: diff --git a/en/device-dev/kernel/kernel-small-debug-shell-magickey.md b/en/device-dev/kernel/kernel-small-debug-shell-magickey.md index efe0e7d795c8d3ffda3c0050238050cf200cfc45..f3c32b24b23cafb82d46427feab722166f4849ea 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-magickey.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-magickey.md @@ -1,8 +1,5 @@ # Magic Key -- [When to Use](#section2350114718546) -- [How to Use](#section3305151511559) - ## When to Use When the system does not respond, you can use the magic key to check whether the system is locked and interrupted \(the magic key also does not respond\) or view the system task running status. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-net-arp.md b/en/device-dev/kernel/kernel-small-debug-shell-net-arp.md index f9fdd97cf1529bf514a88b99ef00a1f6350190c9..9650aaf3282d70efa7bcea9a312e5c25c3669f3e 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-net-arp.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-net-arp.md @@ -1,11 +1,5 @@ # arp -- [Command Function](#section201149459368) -- [Syntax](#section579813484364) -- [Parameters](#section168065311366) -- [Usage](#section19190125723612) -- [Example](#section10383416372) - ## Command Function On an Ethernet, hosts communicate with each other using MAC addresses \(non-IP addresses\). Therefore, IP addresses must be converted into MAC addresses so that hosts can communicate with each other on a LAN \(Ethernet\). To resolve this issue, the host stores a table containing the mapping between IP addresses and MAC addresses, that is, the ARP cache table. When the host needs to send an IP packet to the destination IP address on a LAN, the host can query the destination MAC address from the ARP cache table. The ARP cache table is maintained by the TCP/IP protocol stack. You can run the **arp** command to view and modify the ARP cache table. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-net-dhclient.md b/en/device-dev/kernel/kernel-small-debug-shell-net-dhclient.md index 11b8dc8ebd7df08eef4b25848803b5a7884c0cc1..69684621faf6d99489d00ee5e831d252a46520e5 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-net-dhclient.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-net-dhclient.md @@ -1,12 +1,5 @@ # dhclient -- [Command Function](#section366714216619) -- [Syntax](#section8833164614615) -- [Parameters](#section12809111019453) -- [Usage](#section15935131220717) -- [Example](#section79281818476) -- [Output](#section12742311179) - ## Command Function This command is used to set and view **dhclient** parameters. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-net-dns.md b/en/device-dev/kernel/kernel-small-debug-shell-net-dns.md index cceeb610f5064be74286875e37c2a55a11ea06f7..ae9820873079b3a208b8faa6a04ce484b8806075 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-net-dns.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-net-dns.md @@ -1,12 +1,5 @@ # dns -- [Command Function](#section997513673713) -- [Syntax](#section146015943711) -- [Parameters](#section5732111163716) -- [Usage](#section15642141417371) -- [Example](#section1995841617370) -- [Output](#section1114210258917) - ## Command Function This command is used to query and set the IP address of a DNS server on a board. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-net-ifconfig.md b/en/device-dev/kernel/kernel-small-debug-shell-net-ifconfig.md index bcbc940468be426ba8363301472adcb31b650f19..6eb720c01ebcbfc7bfd09e0fd445201f5233e875 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-net-ifconfig.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-net-ifconfig.md @@ -1,12 +1,5 @@ # ifconfig -- [Command Function](#section174940284379) -- [Syntax](#section136073203715) -- [Parameters](#section6493235203710) -- [Usage](#section05763403371) -- [Example](#section168802042123717) -- [Output](#section124638211109) - ## Command Function This command can be used to: diff --git a/en/device-dev/kernel/kernel-small-debug-shell-net-ipdebug.md b/en/device-dev/kernel/kernel-small-debug-shell-net-ipdebug.md index 2c6a01fe5cef6cdc4ce38e16a53e4d07a5dd869b..73b61253146585424b969a41de50bdcbe16934c7 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-net-ipdebug.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-net-ipdebug.md @@ -1,10 +1,5 @@ # ipdebug -- [Command Function](#section10191115553720) -- [Syntax](#section124061758123713) -- [Usage](#section171837113810) -- [Output](#section561416467104) - ## Command Function **ipdebug** is a console command and is used for IPv6 information debugging. It can display IPv6 address prefixes, neighbor entries, destination cache entries, and default routing entries. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-net-netstat.md b/en/device-dev/kernel/kernel-small-debug-shell-net-netstat.md index 3f767f81c21cd85af3d9b91b026c64b3cbdb720b..4907fae1f14db2d755a9fc3bae90102295f43156 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-net-netstat.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-net-netstat.md @@ -1,12 +1,5 @@ # netstat -- [Command Function](#section13469162113816) -- [Syntax](#section795712373812) -- [Parameters](#section17629431193817) -- [Usage](#section5277153519380) -- [Example](#section108141437163820) -- [Output](#section1357015107117) - ## Command Function The **netstat** command is a console command and is used for monitoring the TCP/IP network. It can display the actual network connections and the status of each network interface device. It is used to display the statistics related to the TCP and UDP protocols and check the network connection to each port on the device \(board\). diff --git a/en/device-dev/kernel/kernel-small-debug-shell-net-ntpdate.md b/en/device-dev/kernel/kernel-small-debug-shell-net-ntpdate.md index b2ad34fa981fec5863e88f049cef48fdf6916e8c..0baa7a3cb0ec25dd7223a2fe6c503223e10a3112 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-net-ntpdate.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-net-ntpdate.md @@ -1,12 +1,5 @@ # ntpdate -- [Command Function](#section38494293815) -- [Syntax](#section5503114413387) -- [Parameters](#section136934472383) -- [Usage](#section121401651173816) -- [Example](#section3431554203811) -- [Output](#section18638194610115) - ## Command Function This command is used to synchronize system time from the server. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-net-ping.md b/en/device-dev/kernel/kernel-small-debug-shell-net-ping.md index 7f71d8e4bec03303186053fc9cb019e13a05f786..e41d79263100e9097cd9cfb08ec8d1374fa6eb92 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-net-ping.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-net-ping.md @@ -1,12 +1,5 @@ # ping -- [Command Function](#section119672573385) -- [Syntax](#section869419010390) -- [Parameters](#section9877183173918) -- [Usage](#section1097046193914) -- [Example](#section14564129113911) -- [Output](#section1621732891215) - ## Command Function This command is used to test an IPv4 network connection. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-net-ping6.md b/en/device-dev/kernel/kernel-small-debug-shell-net-ping6.md index 4c91d848aafb7606eec15903923744764d4b8b42..1ea71d89db350bf415557b763865a7eb593d6143 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-net-ping6.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-net-ping6.md @@ -1,12 +1,5 @@ # ping6 -- [Command Function](#section1057291313393) -- [Syntax](#section199901315123919) -- [Parameters](#section4679319113919) -- [Usage](#section1127917226399) -- [Example](#section7211192553917) -- [Output](#section4846145221215) - ## Command Function This command is used to test an IPv6 network connection. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-net-telnet.md b/en/device-dev/kernel/kernel-small-debug-shell-net-telnet.md index af27c72b2812feca8e3281fb12eeff521d831342..07ff48013d472059b8e9b11f12e6580b6656b721 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-net-telnet.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-net-telnet.md @@ -1,12 +1,5 @@ # telnet -- [Command Function](#section3551830123913) -- [Syntax](#section14897133233918) -- [Parameters](#section977718353392) -- [Usage](#section134991538183916) -- [Example](#section1097414426398) -- [Output](#section11846624191310) - ## Command Function This command is used to enable or disable the Telnet server service. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-net-tftp.md b/en/device-dev/kernel/kernel-small-debug-shell-net-tftp.md index 21983306a479c883a6da6914cb80bbd9007cf0cf..9bbf303d92e0a14497069c0c5ab32a43f8e89451 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-net-tftp.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-net-tftp.md @@ -1,12 +1,5 @@ # tftp -- [Command Function](#section15142134573911) -- [Syntax](#section20958174917394) -- [Parameters](#section576613532395) -- [Usage](#section149795134408) -- [Example](#section148921918114015) -- [Output](#section7872155631313) - ## Command Function Trivial File Transfer Protocol \(TFTP\) is a protocol in the TCP/IP protocol suite for transferring files between clients and servers. TFTP provides simple and low-overhead file transfer services. The port number is 69. diff --git a/en/device-dev/kernel/kernel-small-debug-shell-overview.md b/en/device-dev/kernel/kernel-small-debug-shell-overview.md index 5f10425f3a54aa66aeab753271424eb608f46d53..23af000c4dc281b1454224395aa9da63544e66a0 100644 --- a/en/device-dev/kernel/kernel-small-debug-shell-overview.md +++ b/en/device-dev/kernel/kernel-small-debug-shell-overview.md @@ -1,7 +1,5 @@ # Introduction to the Shell -- [Important Notes](#section12298165312328) - The shell provided by the OpenHarmony kernel supports commonly used debugging commands. You can also add and custom commands to the shell of the OpenHarmony kernel to address your service needs. The common debugging commands include the following: - System commands: commands used to query information, such as system tasks, semaphores, system software timers, CPU usage, and interrupts. diff --git a/en/device-dev/kernel/kernel-small-debug-trace-other-faqs.md b/en/device-dev/kernel/kernel-small-debug-trace-other-faqs.md index eeaa4efd5a926c469388fb26a9d1ac4da48342b6..3c264d713dce07fe74eaec153877db3f03478d11 100644 --- a/en/device-dev/kernel/kernel-small-debug-trace-other-faqs.md +++ b/en/device-dev/kernel/kernel-small-debug-trace-other-faqs.md @@ -1,9 +1,5 @@ # Common Fault Locating Methods -- [Locating the Fault based on Exception Information](#section695838161711) -- [Checking Memory Pool Integrity](#section362917569179) -- [Locating Memory Overwriting for a Global Variable](#section18971311121816) - ## Locating the Fault based on Exception Information When the system is suspended unexpectedly, information about key registers is displayed on the serial port, as shown in the following figure. The information can be used to locate the function where the exception occurs and the related call stack. diff --git a/en/device-dev/kernel/kernel-small-debug-trace-other-lastwords.md b/en/device-dev/kernel/kernel-small-debug-trace-other-lastwords.md index 632809b2a3627e961615a427613cfb0e17ef0567..2029dff707decbd81425ff18c9abea64c70da67e 100644 --- a/en/device-dev/kernel/kernel-small-debug-trace-other-lastwords.md +++ b/en/device-dev/kernel/kernel-small-debug-trace-other-lastwords.md @@ -1,10 +1,5 @@ # Dying Gasp -- [When to Use](#section158501652121514) -- [Available APIs](#section1186411122215) -- [Parameters](#section1083765723015) -- [How to Develop](#section783435801510) - ## When to Use For a device without a serial port, save the exception information to a non-volatile storage medium to facilitate fault location during system running. diff --git a/en/device-dev/kernel/kernel-small-debug-trace.md b/en/device-dev/kernel/kernel-small-debug-trace.md index 45045314597e00a52cafd133d61f0a8ac837ec47..09d86ed17d987ae9280a564fb56b65b704c944b2 100644 --- a/en/device-dev/kernel/kernel-small-debug-trace.md +++ b/en/device-dev/kernel/kernel-small-debug-trace.md @@ -1,9 +1,5 @@ # Trace -- [Basic Concepts](#section531482192018) -- [Working Principles](#section5125124532010) -- [Usage](#section1381714413216) - ## Basic Concepts Trace is a functional framework provided by the kernel for tracing key processes of modules. You can implement trace at key positions for modules based on mechanism requirements, and export the traced information as files or in other modes for further analysis. diff --git a/en/device-dev/kernel/kernel-small-debug-user-faqs.md b/en/device-dev/kernel/kernel-small-debug-user-faqs.md index ec114f13d974efbdd966f916e6e905c73af42648..63450c50a2f6f4d4e505377718bb64bb92ff56af 100644 --- a/en/device-dev/kernel/kernel-small-debug-user-faqs.md +++ b/en/device-dev/kernel/kernel-small-debug-user-faqs.md @@ -1,9 +1,5 @@ # Typical Memory Problems -- [Use After Free \(UAF\)](#section4427132815445) -- [Double Free](#section827194818458) -- [Heap Memory Node Corrupted](#section1763741216461) - ## Use After Free \(UAF\) - Requested memory block less than or equal to 0x1c000 bytes: diff --git a/en/device-dev/kernel/kernel-small-debug-user-function.md b/en/device-dev/kernel/kernel-small-debug-user-function.md index 4c0397279316be57dc4e092683852c2827a726b1..dfb985730715fd39f54247571380347ceb4914d3 100644 --- a/en/device-dev/kernel/kernel-small-debug-user-function.md +++ b/en/device-dev/kernel/kernel-small-debug-user-function.md @@ -1,9 +1,5 @@ # Working Principles -- [Memory Leak Check](#section142061581018) -- [Heap Memory Statistics](#section136902041337) -- [Memory Integrity Check](#section196491231761) - ## Memory Leak Check The memory debugging module maintains 128 \(that is the maximum number of threads supported in the system\) linked lists for each process. The index of each linked list is the thread ID. diff --git a/en/device-dev/kernel/kernel-small-debug-user-guide-use-api.md b/en/device-dev/kernel/kernel-small-debug-user-guide-use-api.md index 5ed88069026d5cb7f980f77409895b34b801815a..890dc3b9f23814c65e43825af8c257c292e05efb 100644 --- a/en/device-dev/kernel/kernel-small-debug-user-guide-use-api.md +++ b/en/device-dev/kernel/kernel-small-debug-user-guide-use-api.md @@ -1,10 +1,5 @@ # Calling APIs -- [Sample Code](#section5490173592518) -- [Compilation](#section534302242515) -- [Debugging Information](#section1017419992515) -- [Call Stack Parsing](#section1485163282417) - ## Sample Code The sample code explicitly calls the related APIs of the memory debugging module to check the memory. diff --git a/en/device-dev/kernel/kernel-small-debug-user-guide-use-cli.md b/en/device-dev/kernel/kernel-small-debug-user-guide-use-cli.md index 5d6a69f907560cb76c18ded46088ee78a6866544..37672c6b3d9d1156dbfc8ea659d92377eb961171 100644 --- a/en/device-dev/kernel/kernel-small-debug-user-guide-use-cli.md +++ b/en/device-dev/kernel/kernel-small-debug-user-guide-use-cli.md @@ -1,11 +1,5 @@ # Using the CLI -- [Sample Code](#section13793104782316) -- [Compilation](#section1676431122320) -- [Running the mwatch Command](#section1703415132311) -- [Call Stack Parsing](#section1880675510221) -- [Running the mrecord Command](#section071022822210) - In addition to calling APIs to check the memory used by user-mode processes, you can run CLI commands to collect memory statistics, check for memory leaks, and check memory integrity. ``` diff --git a/en/device-dev/kernel/kernel-small-overview.md b/en/device-dev/kernel/kernel-small-overview.md index 7afd67fb1596b3b11226adee89f61be744271a2f..c2d1a278e9ab71bf852dfb6b5c1011738adad177 100644 --- a/en/device-dev/kernel/kernel-small-overview.md +++ b/en/device-dev/kernel/kernel-small-overview.md @@ -1,8 +1,5 @@ # Kernel Overview -- [Overview](#section6614133913129) -- [Kernel Architecture](#section827143517385) - ## Overview The OpenHarmony lightweight kernel is a next-generation kernel developed based on the lightweight IoT operating system Huawei LiteOS. Two types of kernels are available: LiteOS-M and LiteOS-A. The LiteOS-M kernel is designed for lightweight systems, which support MCU memory of hundreds of KB and MPU isolation. FreeRTOS and ThreadX are counterparts in the industry. The LiteOS-A kernel is ideal for small systems, which support memory in MB and MMU isolation. Similar kernels include Zircon and Darwin. This development guide applies to the LiteOS-A kernel. diff --git a/en/device-dev/kernel/kernel-small-start-kernel.md b/en/device-dev/kernel/kernel-small-start-kernel.md index 65381837b98ef3be9b91d875dbb9f148f8c93c73..a581433d657a41bf6274d15d646362e086f9f0c5 100644 --- a/en/device-dev/kernel/kernel-small-start-kernel.md +++ b/en/device-dev/kernel/kernel-small-start-kernel.md @@ -1,10 +1,5 @@ # Startup in Kernel Space -- [Kernel Startup Process](#section9882154318299) -- [Programming Example](#section19145114703217) - - [Example Description](#section1045483642518) - - ## Kernel Startup Process The kernel startup process consists of the assembly startup and C language startup, as shown in the following figure. The assembly startup involves initializing CPU settings, disabling dCache/iCache, enabling the FPU and NEON, setting the MMU to establish the virtual-physical address mapping, setting the system stack, clearing the BSS segment, and calling the main function of the C language. The C language startup involves starting the OsMain function and starting scheduling. As shown in the following figure, the OsMain function is used for basic kernel initialization and architecture- and board-level initialization. The kernel startup framework leads the initialization process. The right part of the figure shows the phase in which external modules can register with the kernel startup framework and starts. The following table describes each phase. diff --git a/en/device-dev/kernel/kernel-small-start-user.md b/en/device-dev/kernel/kernel-small-start-user.md index 047df8a133d3e34e5957b9849617a98183dd9570..52876cae729e5337aedbfe363d9db3841cc813aa 100644 --- a/en/device-dev/kernel/kernel-small-start-user.md +++ b/en/device-dev/kernel/kernel-small-start-user.md @@ -1,11 +1,5 @@ # Startup in User Space -- [Startup of the Root Process in User Space](#section79911135647) - - [Startup Process of the Root Process](#section1184317581349) - - [Responsibilities of the Root Process](#section1590220321759) - -- [Running Programs in User Space](#section194576310611) - ## Startup of the Root Process in User Space The root process is the first user-space process in the system. The process ID is 1. The root process is the ancestor of all user-space processes. diff --git a/en/device-dev/kernel/kernel-standard-overview.md b/en/device-dev/kernel/kernel-standard-overview.md index b6046050d7a6047bee5bc899b59de6cf044ba07e..4af04f3a598885f823c020f99eeb48045bee7773 100644 --- a/en/device-dev/kernel/kernel-standard-overview.md +++ b/en/device-dev/kernel/kernel-standard-overview.md @@ -1,8 +1,5 @@ # Linux Kernel Overview -- [Linux Kernel Versions](#section152847516485) -- [OpenHarmony Kernel Version Selection](#section2716416191715) - OpenHarmony adopts the Linux kernel as the basic kernel for standard-system devices \(reference memory ≥ 128 MiB\) so that appropriate OS kernels can be selected for the devices subject to resource limitations and therefore provide basic capabilities for upper-layer apps. ## Linux Kernel Versions diff --git a/en/device-dev/porting/Readme-EN.md b/en/device-dev/porting/Readme-EN.md index 57b44217b5c89af5611218a2581abd4d8994e7d8..2c6b4ea35cbe2dcc575afbb5e16513a1ad6d6a31 100644 --- a/en/device-dev/porting/Readme-EN.md +++ b/en/device-dev/porting/Readme-EN.md @@ -1,4 +1,5 @@ # Introduction + OpenHarmony has organized a Special Interest Group (SIG) [SIG_DevBoard](https://gitee.com/openharmony/community/blob/master/sig/sig-devboard/sig_devboard.md) to provide support for third-party development boards. Before learning about how to port the code of a development board, take a look at the device classification on OpenHarmony. The porting methods vary according to the device type. diff --git a/en/device-dev/porting/oem_transplant_chip_prepare_knows.md b/en/device-dev/porting/oem_transplant_chip_prepare_knows.md index e47336d01c116d22077f6f66c31fe5f4c0a56d10..232021a6f31ee4869c9511bfd6161b3adf0bbcf9 100644 --- a/en/device-dev/porting/oem_transplant_chip_prepare_knows.md +++ b/en/device-dev/porting/oem_transplant_chip_prepare_knows.md @@ -1,9 +1,5 @@ # Before You Start -- [Porting Directory](#section284217487490) -- [Porting Process](#section639315306506) -- [Porting Specifications](#section187870185219) - This document provides basic guidance for OpenHarmony developers and system on a chip \(SoC\) or module vendors to port OpenHarmony to typical chip architectures, such as the cortex-M and RISC-V series. Currently, the Bluetooth service is not supported. Due to the complexity of the OpenHarmony project, this document is subject to update as the version and APIs change. This guide is intended for readers who have experience in developing embedded systems. Therefore, it mainly describes operations and key points during platform porting instead of basic introduction to the OS. diff --git a/en/device-dev/porting/porting-chip-board-component.md b/en/device-dev/porting/porting-chip-board-component.md index 7424993b9e400f6a6f2a862b36ed3b9394d3b8ff..a793dd8b8429160d7aba82d9cfcbb9ecb64e55a8 100644 --- a/en/device-dev/porting/porting-chip-board-component.md +++ b/en/device-dev/porting/porting-chip-board-component.md @@ -1,8 +1,5 @@ # System Modules -- [SAMGR](#section105874301910) -- [DFX](#section20064420420) - System modules, such as the system ability manager \(SAMGR\) and DFX subsystem, provide basic capabilities for upper-layer applications. During board-level system porting, you can directly select the system modules as required without any adaptation. ## SAMGR diff --git a/en/device-dev/porting/porting-chip-board-hal.md b/en/device-dev/porting/porting-chip-board-hal.md index c491dd5c4a47a43d5a12030308b18e8cc6f6aad8..f3bf12e1fee0c2deee2be149464ea3e8586a08f6 100644 --- a/en/device-dev/porting/porting-chip-board-hal.md +++ b/en/device-dev/porting/porting-chip-board-hal.md @@ -1,9 +1,5 @@ # Implementation of APIs at the HAL -- [Utils](#section1394788286) -- [IoT Peripheral Subsystem](#section958113200811) -- [WLAN](#section1331917210911) - The HAL mainly aims to decouple OpenHarmony from the SoC. The following modules describe the dependency of OpenHarmony on the SoC APIs. ## Utils diff --git a/en/device-dev/porting/porting-chip-board-overview.md b/en/device-dev/porting/porting-chip-board-overview.md index 254a59f15fd7943dfe984b6e47b424321daab24d..a56d64f243fa088d5c31b5d5445e18d07a65c615 100644 --- a/en/device-dev/porting/porting-chip-board-overview.md +++ b/en/device-dev/porting/porting-chip-board-overview.md @@ -1,8 +1,5 @@ # Overview -- [Porting Process](#section1283115812294) -- [Board-Level Directory Specifications](#section6204129143013) - ## Porting Process After the minimum system is ported, you can port the board-level system by: diff --git a/en/device-dev/porting/porting-chip-board-xts.md b/en/device-dev/porting/porting-chip-board-xts.md index 7f0ab27adb81cbccf51ed35488998955c55aa381..9b69d5d93cd15a707c843bda467050a80d75e542 100644 --- a/en/device-dev/porting/porting-chip-board-xts.md +++ b/en/device-dev/porting/porting-chip-board-xts.md @@ -1,10 +1,5 @@ # XTS -- [Introduction](#section6725155811454) - - [Adding the XTS Subsystem to the Building Component](#section46981118105417) - - [Executing ACTS Cases for the IoTLink Module](#section9489122319819) - - ## Introduction X Test Suite \(XTS\) is a set of OpenHarmony certification test suites. Currently, the application compatibility test suite \(ACTS\) is supported. The **test/xts** repository contains the **acts** directory and **tools** software package. diff --git a/en/device-dev/porting/porting-chip-faqs.md b/en/device-dev/porting/porting-chip-faqs.md index bca42fc5cb325ff6d58d6375b6598838d04d4979..878feb66498ac8a4042c0f02e9da78e0e35716a3 100644 --- a/en/device-dev/porting/porting-chip-faqs.md +++ b/en/device-dev/porting/porting-chip-faqs.md @@ -1,7 +1,5 @@ # FAQ -- [How Do I Mount the Heap Memory to the Kernel?](#section965418378552) - ## How Do I Mount the Heap Memory to the Kernel? - The following table describes the macros for configuring the kernel heap memory. You can configure them as required in the **target\_config.h** file. diff --git a/en/device-dev/porting/porting-chip-kernel-adjustment.md b/en/device-dev/porting/porting-chip-kernel-adjustment.md index 742d0abf4562871fba12e81554b48c6b3140b9cf..f1aca7b9503178b5a9d43a57528ed9ea76c8177c 100644 --- a/en/device-dev/porting/porting-chip-kernel-adjustment.md +++ b/en/device-dev/porting/porting-chip-kernel-adjustment.md @@ -1,8 +1,5 @@ # Basic Kernel Adaptation -- [Adaptation Process](#section14523241594) -- [Feature Configuration](#section112994366592) - The LiteOS Cortex-M kernel provides the system initialization process and customized configuration options required for system running. During kernel porting, you must pay attention to the functions related to hardware configuration in the initialization process and understand the kernel configuration options so that the minimum kernel that matches the board can be tailored. ## Adaptation Process diff --git a/en/device-dev/porting/porting-chip-kernel-overview.md b/en/device-dev/porting/porting-chip-kernel-overview.md index 9941b2bc5ce9d9faacf2b27f7bdc217971648551..7c8f1e457caabab74ff5a84e9efcc9d60c61dc13 100644 --- a/en/device-dev/porting/porting-chip-kernel-overview.md +++ b/en/device-dev/porting/porting-chip-kernel-overview.md @@ -1,9 +1,5 @@ # Overview -- [Porting Scenario](#section93781277367) -- [Directory Specifications](#section18127744153119) -- [Chip Architecture Adaptation](#section137431650339) - ## Porting Scenario The chip architecture adaptation process is optional. If the particular chip architecture is supported in the **liteos\_m/arch** directory, you can directly implement the board adaptation. Otherwise, chip architecture porting is required. diff --git a/en/device-dev/porting/porting-chip-prepare-process.md b/en/device-dev/porting/porting-chip-prepare-process.md index 9222ba736a22d7a3684ab6911802b2719c84259b..a28343b71be72a5471b6bc1c0ca6bcf05ddb06fa 100644 --- a/en/device-dev/porting/porting-chip-prepare-process.md +++ b/en/device-dev/porting/porting-chip-prepare-process.md @@ -1,7 +1,5 @@ # Building Adaptation Process -- [Building Adaptation Process](#section2159183845319) - For details about compilation and building, see [Compilation and Building](../subsystems/subsys-build-mini-lite.md). When adding third-party chips, perform the following steps to complete building adaptation: ## Building Adaptation Process diff --git a/en/device-dev/porting/porting-linux-kernel.md b/en/device-dev/porting/porting-linux-kernel.md index 0a83bbfe9dc956d27139653dc5f65ca8476798b2..0b620c08d39bfb9f3abf49962823455f451da87f 100644 --- a/en/device-dev/porting/porting-linux-kernel.md +++ b/en/device-dev/porting/porting-linux-kernel.md @@ -1,19 +1,5 @@ # A Method for Rapidly Porting the OpenHarmony Linux Kernel -- [Overview](#section28051350151118) -- [Overall Porting Approach](#section994883124) - - [Kernel Mode Layer and User Mode Layer](#section953481431217) - - [Composition of the Kernel Mode Layer](#section81437528121) - - [Overall Porting Process](#section86060191) - -- [Procedure](#section98871341171310) - - [Setting Up the Environment](#section16584650181314) - - [Porting Basic Kernel-Mode Code](#section95112081716) - - [Porting the HDF Feature](#section12971205681710) - - [Building the Image](#section1681965561911) - - [\(Optional\) Building and Running HDF Test Cases](#section460792312204) - - ## Overview This document describes how to quickly port OpenHarmony to a third-party chip platform by using the existing capabilities of the Linux kernel of the third-party chip platform. diff --git a/en/device-dev/porting/porting-smallchip-driver-oom.md b/en/device-dev/porting/porting-smallchip-driver-oom.md index e18619e7a0142af41f180e876682f56b43e6cef1..46ccf47b9d5eb1c4932aca068bf5344c3e5869b1 100644 --- a/en/device-dev/porting/porting-smallchip-driver-oom.md +++ b/en/device-dev/porting/porting-smallchip-driver-oom.md @@ -1,9 +1,5 @@ # Device Driver Porting -- [LCD Driver Porting](#section1574513454119) -- [Touchscreen Driver Porting](#section20284142116422) -- [WLAN Driver Porting](#section0969448164217) - This section describes how to port device drivers. ## LCD Driver Porting diff --git a/en/device-dev/porting/porting-smallchip-kernel-a.md b/en/device-dev/porting/porting-smallchip-kernel-a.md index 19894561a4ee6215b48599fa64610d55d56ec549..48204ad8b8e666bf327466f8f841c0a44dba3a32 100644 --- a/en/device-dev/porting/porting-smallchip-kernel-a.md +++ b/en/device-dev/porting/porting-smallchip-kernel-a.md @@ -1,14 +1,5 @@ # LiteOS Cortex-A -- [Overview](#section14876256185510) - - [Porting Scenario](#section1986014410569) - - [Directory Specifications](#section10916181716564) - -- [Adaptation Process](#section814974018565) - - [Programming Example](#section10854481825) - -- [Verification](#section646410453212) - ## Overview ### Porting Scenario diff --git a/en/device-dev/porting/porting-smallchip-kernel-linux.md b/en/device-dev/porting/porting-smallchip-kernel-linux.md index ac1acf1451438035f91c66184f72e76cd7bdc7cd..a3a9c1dab04e7bd8052b21a2576bfaaf71572842 100644 --- a/en/device-dev/porting/porting-smallchip-kernel-linux.md +++ b/en/device-dev/porting/porting-smallchip-kernel-linux.md @@ -1,12 +1,5 @@ # Linux Kernel -- [Overview](#section6282121355111) - - [Basic Information](#section19589322515) - - [Bootloader](#section19062510518) - -- [Adaptation, Building, Burning, and Startup](#section11112101695215) -- [Verification](#section17318153325311) - ## Overview Linux kernel porting involves basic kernel compilation, building, and verification after third-party chipset patches are installed based on the Linux kernel baseline. diff --git a/en/device-dev/porting/porting-smallchip-prepare-building.md b/en/device-dev/porting/porting-smallchip-prepare-building.md index d42ebf1d06f96c9f278b928306cd5db6547a10a1..05abd0a08cb1bea879e3e81e85d781cbae6a5bae 100644 --- a/en/device-dev/porting/porting-smallchip-prepare-building.md +++ b/en/device-dev/porting/porting-smallchip-prepare-building.md @@ -1,9 +1,5 @@ # Compilation and Building -- [Compilation Environment Setup](#section3336103410314) -- [Introduction to the Compilation and Building Subsystem](#section354343816319) -- [Adding a Chipset Solution](#section18612153175011) - ## Compilation Environment Setup Set up the basic environment by following instructions in [Ubuntu Build Environment](../quick-start/quickstart-lite-env-setup-linux.md). Both the user space and LiteOS Cortex-A kernel space are compiled using the LLVM compiler. If you choose to port the Linux kernel, run the following command to install the gcc-arm-linux-gnueabi cross compiler for compiling the Linux kernel-space image: diff --git a/en/device-dev/porting/porting-thirdparty-cmake.md b/en/device-dev/porting/porting-thirdparty-cmake.md index 14d113166cad79b81f354f700e859beb4f7e7a56..5c6ff8e7a0a1dc30174c9c50641beb3a77f9d19a 100755 --- a/en/device-dev/porting/porting-thirdparty-cmake.md +++ b/en/device-dev/porting/porting-thirdparty-cmake.md @@ -1,14 +1,5 @@ # Porting a Library Built Using CMake -- [Source Code Acquisition](#section1771132116245) -- [Porting Guidelines](#section9737174410328) -- [Cross-Compilation](#section38205577332) - - [Compilation Reference](#section1088111263418) - - [Cross-Compilation Settings](#section8168182883515) - -- [Library Test](#section6686144293611) -- [Adding the Compiled double-conversion Library to the OpenHarmony Project](#section1651053153715) - The following shows how to port the double-conversion library. ## Source Code Acquisition diff --git a/en/device-dev/porting/porting-thirdparty-makefile.md b/en/device-dev/porting/porting-thirdparty-makefile.md index 11e1b0780cbe489c67bdc6fdfa4f92cfcba18c72..68136beef3a57f2068e8340974d4ada331ccc6c7 100644 --- a/en/device-dev/porting/porting-thirdparty-makefile.md +++ b/en/device-dev/porting/porting-thirdparty-makefile.md @@ -1,10 +1,5 @@ # Porting a Library Built Using Makefile -- [Source Code Acquisition](#section114115321416) -- [Cross-Compilation Settings](#section81263255384) -- [Library Test](#section1830015913391) -- [Adding the Compiled yxml Library to the OpenHarmony Project](#section1898016213406) - The following shows how to port the yxml library. ## Source Code Acquisition diff --git a/en/device-dev/porting/standard-system-porting-guide.md b/en/device-dev/porting/standard-system-porting-guide.md index 44da08b0724c3dd8ea27158fc76982f2f13f8d23..7c1fd296c4ce5811686de27675b6fb03a5d81475 100644 --- a/en/device-dev/porting/standard-system-porting-guide.md +++ b/en/device-dev/porting/standard-system-porting-guide.md @@ -1,22 +1,5 @@ # Standard System Porting Guide -- [Defining a Development Board](#section132mcpsimp) - - [Defining an SoC](#section135mcpsimp) - - [Defining a Product](#section145mcpsimp) - - [Verifying the Porting](#section163mcpsimp) - -- [Porting the Kernel](#section171mcpsimp) - - [1. Adding a Kernel-built Subsystem to the SoC](#section174mcpsimp) - - [2. Building the Kernel](#section182mcpsimp) - - [3. Verifying the Porting](#section207mcpsimp) - -- [Porting the HDF Driver](#section210mcpsimp) - - [1. LCD](#section212mcpsimp) - - [2. Touchscreen](#section229mcpsimp) - - [3. WLAN](#section274mcpsimp) - - [4. Samples](#section11253153018415) - - This document describes the general process for porting a development board, rather than the porting process specific to a System on Chip \(SoC\). In the future, the community will provide more development board porting examples for your reference. ## Defining a Development Board diff --git a/en/device-dev/quick-start/quickstart-lite-env-setup-faqs.md b/en/device-dev/quick-start/quickstart-lite-env-setup-faqs.md index 43182ef6dac132d9d1b2622eb7b82ec800d28bdb..be5e42f8e68d01492dc887160e4643243d7562bd 100644 --- a/en/device-dev/quick-start/quickstart-lite-env-setup-faqs.md +++ b/en/device-dev/quick-start/quickstart-lite-env-setup-faqs.md @@ -1,11 +1,5 @@ # FAQs -- [What should I do if garbled characters and segmentation faults occur during hb installation?](#section411894616119) -- [What should I do if the message "cannot import 'sysconfig' from 'distutils'" is displayed during hb installation?](#section629417571626) -- [What should I do if the message "module 'platform' has no attribute 'linux\_distribution'" is displayed during hb installation?](#section10871523332) -- [What should I do if the message "Could not find a version that satisfies the requirement ohos-build" is displayed during hb installation?](#section47351657163213) -- [What should I do if the message "ImportError: No module named apt\_pkg" is displayed during the execution of an unidentifiable command?](#section159891252236) - ## What should I do if garbled characters and segmentation faults occur during hb installation? - **Symptom** diff --git a/en/device-dev/quick-start/quickstart-lite-env-setup-linux.md b/en/device-dev/quick-start/quickstart-lite-env-setup-linux.md index 0269526b75c0d8ea2fd76c036e3a83ecdf3fd542..826404d57653e3b269d24f22d888f4c4907c0dfc 100644 --- a/en/device-dev/quick-start/quickstart-lite-env-setup-linux.md +++ b/en/device-dev/quick-start/quickstart-lite-env-setup-linux.md @@ -1,16 +1,5 @@ # Setting Up Ubuntu Development Environment -- [Obtaining Source Code and Tools](#section1897711811517) -- [Obtaining Source Code](#section1545225464016) -- [Installing Necessary Libraries and Tools](#section108201740181219) -- [Installing Python3](#section1238412211211) -- [Installing LLVM \(Required only for OpenHarmony\_v1.x\)](#section12202192215415) -- [Installing hb](#section15794154618411) - - [Prerequisites](#section1083283711515) - - [Installation Procedure](#section11518484814) - - [Uninstalling hb](#section3512551574) - - Operating system: 64-bit version of Ubuntu 16.04 or later. Perform the following steps to set up the development environment: diff --git a/en/device-dev/quick-start/quickstart-lite-env-setup-windows.md b/en/device-dev/quick-start/quickstart-lite-env-setup-windows.md index cda9d122b4aebcd39d4b062831c8a46b22aef423..dc2276c10492f47d318ec9b65b95440f69f4bece 100644 --- a/en/device-dev/quick-start/quickstart-lite-env-setup-windows.md +++ b/en/device-dev/quick-start/quickstart-lite-env-setup-windows.md @@ -1,7 +1,5 @@ # Setting Up Windows Development Environment -- [Installing DevEco Device Tool](#en-us_topic_0000001058091994_section10761564496) - System requirements: - OS: 64-bit Windows 10 diff --git a/en/device-dev/quick-start/quickstart-lite-introduction-hi3516.md b/en/device-dev/quick-start/quickstart-lite-introduction-hi3516.md index 96a485efd9dc9bf3ff70d3db05b34b76530a8d0c..02efeb6e2d5d970a367e93388866d1025d360ac3 100644 --- a/en/device-dev/quick-start/quickstart-lite-introduction-hi3516.md +++ b/en/device-dev/quick-start/quickstart-lite-introduction-hi3516.md @@ -1,8 +1,5 @@ # Hi3516 Development Board -- [Introduction](#section26131214194212) -- [Development Board Specifications](#section15192203316533) - ## Introduction Hi3516D V300 is a next-generation system on chip \(SoC\) designed for the industry-dedicated smart HD IP camera. It introduces a next-generation image signal processor \(ISP\), the H.265 video compression encoder, and a high-performance NNIE engine, leading the industry in terms of low bit rate, high image quality, intelligent processing and analysis, and low power consumption. diff --git a/en/device-dev/quick-start/quickstart-lite-introduction-hi3518.md b/en/device-dev/quick-start/quickstart-lite-introduction-hi3518.md index 7731c1898448f7b6b3c6dfd149e3365ab68cc6cb..384aac6f3f65578a01355895faf7f20e3adb4c91 100644 --- a/en/device-dev/quick-start/quickstart-lite-introduction-hi3518.md +++ b/en/device-dev/quick-start/quickstart-lite-introduction-hi3518.md @@ -1,8 +1,5 @@ # Hi3518 Development Board -- [Introduction](#section14815247616) -- [Development Board Specifications](#section765112478446) - ## Introduction Hi3518E V300 is a next-generation system on chip \(SoC\) designed for the industry-dedicated smart HD IP camera. It introduces a next-generation image signal processor \(ISP\), the H.265 video compression encoder, and the advanced low-power process and architecture design, leading the industry in terms of low bit rate, high image quality, and low power consumption. diff --git a/en/device-dev/quick-start/quickstart-lite-introduction-hi3861.md b/en/device-dev/quick-start/quickstart-lite-introduction-hi3861.md index bc30d3567ca085777cd7fb6f92a54c73e9413771..7c584129dc590dcd0613a56bc74cc2391842e63b 100644 --- a/en/device-dev/quick-start/quickstart-lite-introduction-hi3861.md +++ b/en/device-dev/quick-start/quickstart-lite-introduction-hi3861.md @@ -1,10 +1,5 @@ # Hi3861 Development Board -- [Introduction](#section19352114194115) -- [Resources and Constraints](#section82610215014) -- [Development Board Specifications](#section169054431017) -- [Key Features](#section1317173016507) - ## Introduction The Hi3861 WLAN module is a development board with 2 x 5 cm form factor. It contains a 2.4 GHz WLAN SoC that highly integrates the IEEE 802.11b/g/n baseband and radio frequency \(RF\) circuit. This module provides open and easy-to-use development and debugging environments for running OpenHarmony. diff --git a/en/device-dev/quick-start/quickstart-lite-steps-hi3516-faqs.md b/en/device-dev/quick-start/quickstart-lite-steps-hi3516-faqs.md index 1617e45faa78e9c0a12f48c900e068c8cdf48769..98248bf57fd6da21b889d30fb35732c49c9499a1 100644 --- a/en/device-dev/quick-start/quickstart-lite-steps-hi3516-faqs.md +++ b/en/device-dev/quick-start/quickstart-lite-steps-hi3516-faqs.md @@ -1,11 +1,5 @@ # FAQs -- ["Error: Opening COMxx: Access denied" Is Displayed After a Serial Port Is Selected for Burning](#section627268185113) -- [What should I do when Windows-based PC failed to be connected to the board?](#section195391036568) -- [What should I do when the image failed to be burnt?](#section571164016565) -- [What should I do when the message indicating Python cannot be found is displayed during compilation and building?](#section1039835245619) -- [What should I do when no command output is displayed?](#section14871149155911) - ## "Error: Opening COMxx: Access denied" Is Displayed After a Serial Port Is Selected for Burning - **Symptom** diff --git a/en/device-dev/quick-start/quickstart-lite-steps-hi3516-program.md b/en/device-dev/quick-start/quickstart-lite-steps-hi3516-program.md index 2e4cfcb2adf66accdb3bb130fc9a78d609d0001c..f4d84ab80397fef3cfac9cd5247876782fd41a4a 100644 --- a/en/device-dev/quick-start/quickstart-lite-steps-hi3516-program.md +++ b/en/device-dev/quick-start/quickstart-lite-steps-hi3516-program.md @@ -1,10 +1,5 @@ # Developing a Driver -- [Introduction to Driver](#s8efc1952ebfe4d1ea717182e108c29bb) -- [Building Source Code and Burning Images](#section660016185110) -- [Running an Image](#section333215226219) -- [Follow-up Learning](#section9712145420182) - This section describes how to develop a driver on the board, including introduction, compilation, burning, and running of the driver. ## Introduction to Driver diff --git a/en/device-dev/quick-start/quickstart-lite-steps-hi3516-running.md b/en/device-dev/quick-start/quickstart-lite-steps-hi3516-running.md index 59508fb974d16f0362180bb6b8c887cd9f1fe187..75be0b182b2fcccf4c90bc17a46f041f5b437005 100644 --- a/en/device-dev/quick-start/quickstart-lite-steps-hi3516-running.md +++ b/en/device-dev/quick-start/quickstart-lite-steps-hi3516-running.md @@ -1,13 +1,5 @@ # Running a Hello OHOS Program -- [Creating a Program](#section204672145202) -- [Building](#section1077671315253) -- [Burning](#section1347011412201) - - [Burning Through the Network Port](#section1935410617363) - - [Running an Image](#section24721014162010) - -- [Running a Program](#section5276734182615) - This section describes how to create, compile, burn, and run the first program, and finally print **Hello OHOS!** on the develop board. ## Creating a Program diff --git a/en/device-dev/quick-start/quickstart-lite-steps-hi3516-setting.md b/en/device-dev/quick-start/quickstart-lite-steps-hi3516-setting.md index 8371c50e5c20bac4ee3b345ae63f43afd4147171..1569ed12128a4d642bc7c2717659cb61fc11419e 100644 --- a/en/device-dev/quick-start/quickstart-lite-steps-hi3516-setting.md +++ b/en/device-dev/quick-start/quickstart-lite-steps-hi3516-setting.md @@ -1,15 +1,5 @@ # Setting Up the Environment -- [Environment Requirements](#section179175261196) - - [Hardware](#section5840424125014) - - [Software](#section965634210501) - -- [Installing Linux Build Tools](#section182916865219) - - [Changing Linux Shell to Bash](#section1715027152617) - - [Installing Basic Software Used for Compilation and Building \(Required Only for Ubuntu 20+\)](#section45512412251) - - [Installing File Packing Tools and JVM](#section16199102083717) - - ## Environment Requirements ### Hardware diff --git a/en/device-dev/quick-start/quickstart-lite-steps-hi3518-faqs.md b/en/device-dev/quick-start/quickstart-lite-steps-hi3518-faqs.md index d1181a9b8cb6835452dd237dc6236970111a225e..0ffca08c5437185237e93fed259b4458e84dbd9c 100644 --- a/en/device-dev/quick-start/quickstart-lite-steps-hi3518-faqs.md +++ b/en/device-dev/quick-start/quickstart-lite-steps-hi3518-faqs.md @@ -1,11 +1,5 @@ # FAQs -- ["Error: Opening COMxx: Access denied" Is Displayed After a Serial Port Is Selected for Burning](#section1498892119619) -- [What should I do when Windows-based PC failed to be connected to the board?](#section8512971816) -- [What should I do when the image failed to be burnt?](#section1767804111198) -- [What should I do when the message indicating Python cannot be found is displayed during compilation and building?](#en-us_topic_0000001053466255_section1039835245619) -- [What should I do when no command output is displayed?](#en-us_topic_0000001053466255_section14871149155911) - ## "Error: Opening COMxx: Access denied" Is Displayed After a Serial Port Is Selected for Burning - **Symptom** diff --git a/en/device-dev/quick-start/quickstart-lite-steps-hi3518-running.md b/en/device-dev/quick-start/quickstart-lite-steps-hi3518-running.md index c1887587a3c2c2e87ed2c40d816f061ab0b471f6..6d16d33c4c096102a81da70cb86ea0b1e84e45b6 100644 --- a/en/device-dev/quick-start/quickstart-lite-steps-hi3518-running.md +++ b/en/device-dev/quick-start/quickstart-lite-steps-hi3518-running.md @@ -1,11 +1,5 @@ # Running a Hello OHOS Program -- [Creating a Program](#section1550972416485) -- [Building](#section234175193114) -- [Burning](#section7609155824819) -- [Running an Image](#section17612105814480) -- [Follow-up Learning](#section9712145420182) - This section describes how to create, compile, burn, and run the first program, and finally print **Hello OHOS!** on the develop board. ## Creating a Program diff --git a/en/device-dev/quick-start/quickstart-lite-steps-hi3518-setting.md b/en/device-dev/quick-start/quickstart-lite-steps-hi3518-setting.md index 86ea4fcf9292f50befdb11bc555bdbeb2cfe614c..f1b4e562e84bae067403d0d62d967d758781ecd0 100644 --- a/en/device-dev/quick-start/quickstart-lite-steps-hi3518-setting.md +++ b/en/device-dev/quick-start/quickstart-lite-steps-hi3518-setting.md @@ -1,15 +1,5 @@ # Setting Up the Environment -- [Environment Requirements](#section1724111409282) - - [Hardware](#section487353718276) - - [Software](#section17315193935817) - -- [Installing Linux Build Tools](#section8831868501) - - [Changing Linux Shell to Bash](#section434110241084) - - [Installing Basic Software Used for Compilation and Building \(Required Only for Ubuntu 20+\)](#section25911132141020) - - [Installing File Packing Tools](#section390214473129) - - ## Environment Requirements ### Hardware diff --git a/en/device-dev/quick-start/quickstart-lite-steps-hi3861-connection.md b/en/device-dev/quick-start/quickstart-lite-steps-hi3861-connection.md index 0344e5a38233563788876017df319e286ca10c4c..c1ef04f6545a6c7a98a37798118c4d1678a45dee 100644 --- a/en/device-dev/quick-start/quickstart-lite-steps-hi3861-connection.md +++ b/en/device-dev/quick-start/quickstart-lite-steps-hi3861-connection.md @@ -1,9 +1,5 @@ # Setting Up WLAN Connection -- [Building Source Code](#section191121332125319) -- [Burning Images](#section3288165814218) -- [Connecting WLAN Module to the Internet.](#section194671619167) - This example shows how to connect the WLAN module to the gateway using attention \(AT\) commands. ## Building Source Code diff --git a/en/device-dev/quick-start/quickstart-lite-steps-hi3861-faqs.md b/en/device-dev/quick-start/quickstart-lite-steps-hi3861-faqs.md index 7433aa081c2ec2b3a951b9e117490f06a864f22d..3d9f4c7890205090e788c746bcfa9b953961f028 100644 --- a/en/device-dev/quick-start/quickstart-lite-steps-hi3861-faqs.md +++ b/en/device-dev/quick-start/quickstart-lite-steps-hi3861-faqs.md @@ -1,17 +1,5 @@ # FAQs -- [What should I do when the message configure: error: no acceptable C compiler found in $PATH is displayed during Python 3 installation?](#section1221016541119) -- [What should I do when the message -bash: make: command not found is displayed during Python 3 installation?](#section1913477181213) -- [What should I do when the message zlib not available is displayed during Python 3 installation?](#section108211415131210) -- [What should I do when the message No module named '\_ctypes' is displayed during Python 3 installation?](#section2062268124) -- [What should I do when the message No module named 'Crypto' is displayed during compilation and building?](#section982315398121) -- [What should I do when the message No module named 'ecdsa' is displayed during compilation and building?](#section102035451216) -- [What should I do when the message Could not find a version that satisfies the requirement six\>=1.9.0 is displayed during compilation and building?](#section4498158162320) -- [What should I do when the message cannot find -lgcc is displayed during compilation and building?](#section11181036112615) -- [What should I do when the message indicating Python cannot be found is displayed during compilation and building?](#section1571810194619) -- [What should I do when the message indicating Python3 cannot be found is displayed during compilation and building?](#section108385316482) -- [What should I do when an error with lsb\_release occurs during kconfiglib installation?](#section691681635814) - ## What should I do when the message **configure: error: no acceptable C compiler found in $PATH** is displayed during Python 3 installation? - **Symptom** diff --git a/en/device-dev/quick-start/quickstart-lite-steps-hi3861-running.md b/en/device-dev/quick-start/quickstart-lite-steps-hi3861-running.md index e1c70aa53cf8b1cc8e3a120bdc3a16ca232e8bb3..ba2c045de307429e49dcf4ddef31b602eabaa8cf 100644 --- a/en/device-dev/quick-start/quickstart-lite-steps-hi3861-running.md +++ b/en/device-dev/quick-start/quickstart-lite-steps-hi3861-running.md @@ -1,13 +1,5 @@ # Running a Hello World Program -- [Modifying Source Code](#section79601457101015) -- [Debugging and Verification](#section1621064881419) - - [printf](#section5204547123316) - - [Locating Exceptions Using the ASM File](#section15919111423416) - -- [Viewing Execution Result](#section18115713118) -- [Follow-up Learning](#section9712145420182) - This example shows how to compile a simple service and print **Hello World** to help you preliminarily understand how to run OpenHarmony on Hi3861. ## Modifying Source Code diff --git a/en/device-dev/quick-start/quickstart-lite-steps-hi3861-setting.md b/en/device-dev/quick-start/quickstart-lite-steps-hi3861-setting.md index 3a70fb05f651284987ca09193c83a9232f196ca9..e1a6adeb73abd9b3c478696aabc6cef3632041f0 100644 --- a/en/device-dev/quick-start/quickstart-lite-steps-hi3861-setting.md +++ b/en/device-dev/quick-start/quickstart-lite-steps-hi3861-setting.md @@ -1,17 +1,5 @@ # Setting Up the Environment -- [Environment Requirements](#section466851916410) - - [Hardware](#section19202111020215) - - [Software](#section727451210318) - -- [Installing Linux Build Tools](#section497484245614) - - [Installing Basic Software Used for Compilation and Building \(Required Only for Ubuntu 20+\)](#section45512412251) - - [Installing Scons](#section7438245172514) - - [Installing Python Modules](#section88701892341) - - [Installing gcc\_riscv32 \(Compiler Toolchain for WLAN Module\)](#section34435451256) - -- [Installing the USB-to-Serial Driver](#section1027732411513) - ## Environment Requirements ### Hardware diff --git a/en/device-dev/quick-start/quickstart-standard-burn.md b/en/device-dev/quick-start/quickstart-standard-burn.md index 4a3c55797f5096e23b2be873b7c821776f617c87..8d06a9d39465543c2b02d21b72847750772b7bdd 100644 --- a/en/device-dev/quick-start/quickstart-standard-burn.md +++ b/en/device-dev/quick-start/quickstart-standard-burn.md @@ -1,8 +1,5 @@ # Burning Images -- [Prerequisites](#section18547185418328) -- [Programming Flash Memory Through the Network Port](#section1965361953312) - Burning of a regular system requires DevEco Device Tool v2.2 Beta1 or later. Hi3516D V300 supports burning of the standard system through the USB port, network port, or serial port, where: diff --git a/en/device-dev/quick-start/quickstart-standard-docker-environment.md b/en/device-dev/quick-start/quickstart-standard-docker-environment.md index 5101d177a23fc2724394313d8a9ba2c4cfd89dfe..34d557772b9d5a80846bf587cd38348f57084abd 100644 --- a/en/device-dev/quick-start/quickstart-standard-docker-environment.md +++ b/en/device-dev/quick-start/quickstart-standard-docker-environment.md @@ -1,13 +1,5 @@ # Setting Up a Ubuntu Development Environment in Docker Mode -- [Obtaining Standard-System Source Code](#section8761819202511) - - [Prerequisites](#section102871547153314) - - [Procedure](#section429012478331) - -- [Running prebuilts](#section0495320152619) -- [Obtaining the Docker Environment](#section181431248132513) -- [Building Source Code](#section92391739152318) - The standard OpenHarmony system provides a Docker environment which encapsulates build tools. >![](../public_sys-resources/icon-note.gif) **NOTE:** diff --git a/en/device-dev/quick-start/quickstart-standard-faqs.md b/en/device-dev/quick-start/quickstart-standard-faqs.md index 2d297fdc29a43b04fc89d0dda28bdb925394b9c4..49caf70c244c84eb4f5fd773a5db72ca84f26377 100644 --- a/en/device-dev/quick-start/quickstart-standard-faqs.md +++ b/en/device-dev/quick-start/quickstart-standard-faqs.md @@ -1,7 +1,5 @@ # FAQs -- [What Should I Do If "ImportError: No module named apt\_pkg" Is Displayed During Compilation and Building?](#section32195464215) - ## What Should I Do If "ImportError: No module named apt\_pkg" Is Displayed During Compilation and Building? - **Symptom** diff --git a/en/device-dev/quick-start/quickstart-standard-overview.md b/en/device-dev/quick-start/quickstart-standard-overview.md index 01e74b19743ebc83ed0f6d7fd8ca6ccd21b0e823..27796a8b9bba8a8aa1356533d7c24c57b153f664 100644 --- a/en/device-dev/quick-start/quickstart-standard-overview.md +++ b/en/device-dev/quick-start/quickstart-standard-overview.md @@ -1,9 +1,5 @@ # Introduction -- [Quick Start Process](#section7825218111517) -- [Introduction to the Development Board](#en-us_topic_0000001053666242_section047719215429) -- [Development Board Specifications](#en-us_topic_0000001053666242_section15192203316533) - This document helps you quickly understand how to set up a standard OpenHarmony system, and how to build, burn, and start the system. You can develop the standard system in Windows and build source code in Linux. This document uses the recommended Hi3516D V300 development board as an example. diff --git a/en/device-dev/quick-start/quickstart-standard-package-environment.md b/en/device-dev/quick-start/quickstart-standard-package-environment.md index 8bfe22b959e3ac18e79c0856577611b13e2b975b..21f07874275ca4c875383feec9ef61d068263394 100644 --- a/en/device-dev/quick-start/quickstart-standard-package-environment.md +++ b/en/device-dev/quick-start/quickstart-standard-package-environment.md @@ -1,13 +1,5 @@ # Setting Up a Ubuntu Development Environment Using the Installation Package -- [Installing Dependent Tools](#section18431165519244) -- [Obtaining Standard-System Source Code](#section113751052102517) - - [Prerequisites](#section102871547153314) - - [Procedure](#section429012478331) - -- [Running prebuilts](#section0495320152619) -- [Building Source Code](#section1664835963517) - ## Installing Dependent Tools The installation command is as follows: diff --git a/en/device-dev/quick-start/quickstart-standard-running.md b/en/device-dev/quick-start/quickstart-standard-running.md index 8375204a05f4c8b0cf46030ccb89996ba3a8f3bd..c806e674a835704a177404e55aae180209284c87 100644 --- a/en/device-dev/quick-start/quickstart-standard-running.md +++ b/en/device-dev/quick-start/quickstart-standard-running.md @@ -1,8 +1,5 @@ # Running an Image -- [Running an Image](#section153991115191314) -- [Next](#section5600113114323) - ## Running an Image After the image burning is complete, perform the following steps to run the system: diff --git a/en/device-dev/quick-start/quickstart-standard-windows-environment.md b/en/device-dev/quick-start/quickstart-standard-windows-environment.md index 2a91d675138760f1ee33ff0f34374a384144a061..a7b213cda58152c74063f9a2f94c029142dd3db6 100644 --- a/en/device-dev/quick-start/quickstart-standard-windows-environment.md +++ b/en/device-dev/quick-start/quickstart-standard-windows-environment.md @@ -1,7 +1,5 @@ # Setting Up a Windows Development Environment -- [Installing DevEco Device Tool](#en-us_topic_0000001058091994_section10761564496) - System requirements: - OS: 64-bit Windows 10 diff --git a/en/device-dev/security/security-guidelines-overall.md b/en/device-dev/security/security-guidelines-overall.md index bc0933021d484d046df7d54fa1de239b99deb195..45e1c2262d6c002e8d2bccfb24b317e5189c9796 100644 --- a/en/device-dev/security/security-guidelines-overall.md +++ b/en/device-dev/security/security-guidelines-overall.md @@ -1,24 +1,5 @@ # Security Guidelines -- [Overview](#section1521410017353) -- [Hardware Security](#section2558121318351) - - [Mechanism](#section1399511541896) - - [Recommended Practices](#section948519243104) - -- [System Security](#section87802111361) - - [Mechanism](#section149107611118) - - [Recommended Practices](#section1364122019112) - -- [Data Security](#section2468927364) - - [Mechanism](#section1378993720111) - - [Recommended Practices](#section1531735481112) - -- [Device Interconnection Security](#section26153183616) -- [Application Security](#section852593153614) - - [Mechanism](#section55012136125) - - [Recommended Practices](#section6341102610123) - - ## Overview OpenHarmony is an open OS that allows you to easily develop services and applications. It provides an execution environment to ensure security of application data and user data. diff --git a/en/device-dev/security/security-privacy-protection.md b/en/device-dev/security/security-privacy-protection.md index 13eaf6a552864bdb4839187a0c641567964d8042..0fbba604ba698eb2e2785aca2ead0577cd3f4f5f 100644 --- a/en/device-dev/security/security-privacy-protection.md +++ b/en/device-dev/security/security-privacy-protection.md @@ -1,10 +1,5 @@ # Privacy Protection -- [Overview](#section13200134331414) -- [Data Classification](#section2371104991511) -- [General Privacy Design Rules](#section10354102411162) -- [Privacy Protection Requirements for Special Categories](#section118861450201618) - ## Overview Personal data plays an increasingly important role in social economy and daily life along with the development of the Internet and informatization. Meanwhile, personal data leakage risks are increasing. As consumer product developers, you shall take more effective measures to protect users' personal data and improve their trust in your products. To protect consumers' privacy and improve their experience on privacy, you should set high-level privacy protection policies for your product. diff --git a/en/device-dev/subsystems/development-guidelines.md b/en/device-dev/subsystems/development-guidelines.md index fef40c47389a1b0aa9f802c23ac58693a3ba8482..64a6bede8653025e29dd2331529177307e69ee4d 100644 --- a/en/device-dev/subsystems/development-guidelines.md +++ b/en/device-dev/subsystems/development-guidelines.md @@ -1,29 +1,5 @@ # Development Guidelines -- [Initializing a Modem Vendor Library](#section211mcpsimp) - - [When to Use](#section213mcpsimp) - - [Available APIs](#section811343241215) - - [How to Develop](#section51031144122) - - [Debugging and Verification](#section5351151517132) - -- [Responding to Modem Service Requests](#section295mcpsimp) - - [When to Use](#section297mcpsimp) - - [Available APIs](#section9503155219134) - - [How to Develop](#section17190412101414) - - [Debugging and Verification](#section10207938171413) - -- [Reporting Modem Events](#section390mcpsimp) - - [When to Use](#section401mcpsimp) - - [Available APIs](#section191193791518) - - [How to Develop](#section16394112401512) - - [Debugging and Verification](#section16999174401516) - - [Development Examples](#section33444350167) - -- [Integrating Modem Vendor Libraries](#section590mcpsimp) - - [Configuring Compilation Information](#section592mcpsimp) - - [Debugging and Verification](#section620mcpsimp) - - ## Initializing a Modem Vendor Library ### When to Use diff --git "a/en/device-dev/subsystems/figure/\346\217\222\344\273\266\344\276\235\350\265\226-(2).jpg" b/en/device-dev/subsystems/figure/code-dependency-(2).jpg similarity index 100% rename from "en/device-dev/subsystems/figure/\346\217\222\344\273\266\344\276\235\350\265\226-(2).jpg" rename to en/device-dev/subsystems/figure/code-dependency-(2).jpg diff --git a/en/device-dev/subsystems/oem_subsys_toolchain_hdc_guide.md b/en/device-dev/subsystems/oem_subsys_toolchain_hdc_guide.md index 8cb18fe497bdb4d236cc15470edf1eec03457aee..3c72f79eac135f35b8e2a125cd3ede923fc3db05 100644 --- a/en/device-dev/subsystems/oem_subsys_toolchain_hdc_guide.md +++ b/en/device-dev/subsystems/oem_subsys_toolchain_hdc_guide.md @@ -1,42 +1,5 @@ # hdc\_std Usage Guidelines -- [Preparations](#section05992022154916) -- [Important Notes](#section19543134915210) -- [Option-related Commands](#section618522925119) - - [-h/help -v/version](#section51533527212) - - [-t key](#section1180555115159) - -- [Querying the Device List](#section174891132104218) - - [list targets\[-v\]](#section12911142313168) - -- [Service Process Commands](#section680531510497) - - [target mount](#section396717571168) - - [smode \[off\]](#section179951621713) - - [kill \[-r\]](#section419144621712) - - [start \[-r\]](#section184811812183) - -- [Network Commands](#section71176123212) - - [tconn host\[:port\]\[-remove\]](#section191911334206) - - [tmode usb](#section17840182562015) - - [tmode port port-number](#section101113462113) - -- [File Commands](#section173133523013) - - [file send local remote](#section126223231307) - - [file recv \[-a\] remote local](#section26966541304) - -- [App Commands](#section2072647133819) - - [install \[-r/-d/-g\] package](#section49615195111) - - [uninstall \[-k\] package](#section167618461814) - -- [Debugging Commands](#section112861250195015) - - [hilog](#section32171612221) - - [shell \[command\]](#section524235625) - -- [Troubleshooting](#section592920255582) - - [hdc\_std Fails to Connect to a Device](#section74019384588) - -- [hdc\_std Fails to Run](#section6825095917) - hdc\_std \(OpenHarmony Device Connector\) is a command line tool provided by OpenHarmony for debugging. With this tool, you can interact with real devices or simulators from a Windows or Linux OS. This section describes how to set up the hdc\_std environment and use its common commands. diff --git a/en/device-dev/subsystems/oem_subsys_utils_faq.md b/en/device-dev/subsystems/oem_subsys_utils_faq.md index d7840aa6e4e6d6f42fdd5170dc86c85bca7a0039..0f1ed0e9f06e62e99e05c81ea78333f80bffd007 100644 --- a/en/device-dev/subsystems/oem_subsys_utils_faq.md +++ b/en/device-dev/subsystems/oem_subsys_utils_faq.md @@ -1,7 +1,5 @@ # Utils FAQ -- [1. Failure in running the KV store on the LiteOS Cortex-A kernel \(Hi3516 or Hi3518\) due to incorrect path setting for the KV store](#section2041345718513) - ## 1. Failure in running the KV store on the LiteOS Cortex-A kernel \(Hi3516 or Hi3518\) due to incorrect path setting for the KV store **Problem** diff --git a/en/device-dev/subsystems/oem_subsys_utils_guide.md b/en/device-dev/subsystems/oem_subsys_utils_guide.md index 53e3b6eaeddb1a0642ba51a250c6e3fe2bc0118d..1988c6b9c43fb96ab6cd04a24fb5148dc8a3648e 100644 --- a/en/device-dev/subsystems/oem_subsys_utils_guide.md +++ b/en/device-dev/subsystems/oem_subsys_utils_guide.md @@ -1,12 +1,5 @@ # Utils Development Guidelines -- [Available APIs](#section1633115419401) -- [How to Develop](#section17450172710292) - - [Developing a Native Application for the KV Store That Uses the LiteOS Cortex-A Kernel \(Hi3516 or Hi3518\)](#section258354119295) - - [Dumping System Attributes on the Platform That Uses the LiteOS Cortex-M Kernel](#section9179161863014) - - [Dumping System Attributes on the Platform That Uses the LiteOS Cortex-A Kernel](#section3179121853017) - - ## Available APIs **Table 1** APIs for file operations diff --git a/en/device-dev/subsystems/subsys-aiframework-tech-codemanage.md b/en/device-dev/subsystems/subsys-aiframework-tech-codemanage.md index 71784ff093472cfa6658ba319b3b6d701e955d68..16602e69ef26c7ddc5e383c8658cb4bce5938f90 100644 --- a/en/device-dev/subsystems/subsys-aiframework-tech-codemanage.md +++ b/en/device-dev/subsystems/subsys-aiframework-tech-codemanage.md @@ -1,9 +1,5 @@ # Code Management -- [Recommendation: Develop plug-ins and northbound SDKs in the directories specified by the AI engine.](#section17176374131) -- [Rule: Store all external APIs provided by plug-ins in the interfaces/kits directory of the AI subsystem.](#section2551029111312) -- [Rule: Make sure that plug-in compilation results are stored in the /usr/lib directory.](#section97021558121310) - Code of the AI engine framework consists of three parts: **client**, **server**, and **common**. The client module provides the server connection management function. The northbound SDK needs to encapsulate and call the public APIs provided by the client in the algorithm's external APIs. The server module provides functions such as plug-in loading and task management. Plug-ins are integrated using the plug-in APIs provided by the server. The common module provides platform-related operation methods, engine protocols, and tool classes for other modules. [Figure 1](#fig171811112818) shows the code dependency between modules of the AI engine framework. @@ -11,7 +7,7 @@ Code of the AI engine framework consists of three parts: **client**, **server* **Figure 1** Code dependency -![](figure/插件依赖-(2).jpg) +![](figure/code-dependency-(2).jpg) ## Recommendation: Develop plug-ins and northbound SDKs in the directories specified by the AI engine. diff --git a/en/device-dev/subsystems/subsys-aiframework-tech-interface.md b/en/device-dev/subsystems/subsys-aiframework-tech-interface.md index 0d7677ddd8099cb3f145dfa546e6df611a6017fd..8990dbccda18be268d2857a57151bca760fc58b0 100644 --- a/en/device-dev/subsystems/subsys-aiframework-tech-interface.md +++ b/en/device-dev/subsystems/subsys-aiframework-tech-interface.md @@ -1,13 +1,5 @@ # API Development -- [Rule: Encapsulate the external APIs provided by the client based on the algorithm call sequence. For the SDK of an asynchronous plug-in, implement the IClientCb callback API provided by the client.](#section15872017171616) -- [Rule: Save all common data related to client interaction in the SDK during API implementation.](#section011283741612) -- [Recommendation: Enable the SDK to implement the IServiceDeadCb API defined by the client.](#section1199125331613) -- [Rule: Convert dedicated algorithm data into common data of the AI engine if the SDK and plug-ins need to use the codec module.](#section93139389171) -- [Rule: Release the memory used by the encoded or decoded parameters in the SDK. Otherwise, a memory leakage occurs.](#section1698441814183) -- [Rule: Enable plug-ins to implement the IPlugin API defined by the server and use the PLUGIN\_INTERFACE\_IMPL statement to provide the function pointer for external systems.](#section20850717196) -- [Rule: Use the unified data channel provided by the AI engine for plug-ins.](#section1493821732019) - ## Rule: Encapsulate the external APIs provided by the client based on the algorithm call sequence. For the SDK of an asynchronous plug-in, implement the **IClientCb** callback API provided by the client. The external APIs provided by the client of the AI engine include **AieClientInit**, **AieClientPrepare**, **AieClientSyncProcess**, **AieClientAsyncProcess**, **AieClientRelease**, **AieClientDestroy**, **AieClientSetOption**, and **AieClientGetOption**. The SDK needs to encapsulate at least the following five APIs in sequence: **AieClientInit**, **AieClientPrepare**, **AieClientSyncProcess** \(or **AieClientAsyncProcess**\), **AieClientRelease**, and **AieClientDestroy**. Otherwise, a call failure or memory leakage may occur. For example, if the **AieClientprepare** API is omitted during encapsulation, the server cannot load the plug-in. As a result, APIs that follow it cannot be called. diff --git a/en/device-dev/subsystems/subsys-aiframework-tech-name.md b/en/device-dev/subsystems/subsys-aiframework-tech-name.md index 4203b41c84b6fccf9d2b85b3eea32c68793d2b76..3722cfb4fe782ffef7662589d6ed96fa9670a372 100644 --- a/en/device-dev/subsystems/subsys-aiframework-tech-name.md +++ b/en/device-dev/subsystems/subsys-aiframework-tech-name.md @@ -1,8 +1,5 @@ # Naming -- [Rule: Name an SDK in the format of domain\_keyword<\_other information 1\_other information 2\_...\>\_sdk.so.](#section62071110121516) -- [Rule: Name a plug-in in the format of domain\_keyword<\_other information 1\_other information 2\_...\>.so.](#section1665562841519) - ## Rule: Name an SDK in the format of **domain\_keyword<\_other information 1\_other information 2\_...\>\_sdk.so**. You are advised to use the commonly known abbreviations for domains. For example, use **cv** for image and video, **asr** for voice recognition, and **translation** for text translation. Add one if there is no available abbreviation for a domain. Use keywords that accurately describe the algorithm capability of the plug-in. For example, use **keyword\_spotting** for wakeup keyword spotting \(KWS\). Add other information, such as the supported chip type and applicable region, between **keyword** and **sdk**, with each of them separated by an underscore \(\_\). Note that the name of a northbound SDK must end with **sdk**. diff --git a/en/device-dev/subsystems/subsys-application-framework-guide.md b/en/device-dev/subsystems/subsys-application-framework-guide.md index e02c08a8b14a8c3549331ad5b947370c9df281cc..a3f521760240dbb2fec330557a38ec094c0e2614 100644 --- a/en/device-dev/subsystems/subsys-application-framework-guide.md +++ b/en/device-dev/subsystems/subsys-application-framework-guide.md @@ -1,13 +1,5 @@ # Development Guidelines -- [When to Use](#section93012287133) -- [Available APIs](#section11821047161319) -- [How to Develop](#section10514141679) - - [Creating a Service Ability](#section19921154214315) - - [Development Guidelines on Bundle Management](#section1724016743217) - - [Packing a HAP File](#section171771212328) - - ## When to Use - Develop Page abilities for applications that have a UI for human-machine interaction, such as news applications, video players, navigation applications, and payment applications. Most applications we use in our daily lives are such type of applications. diff --git a/en/device-dev/subsystems/subsys-application-framework-overview.md b/en/device-dev/subsystems/subsys-application-framework-overview.md index c7127eddc228435bfaa8921305f0e99e888b9c7a..d991947fc178f03804ef50f5427e5538eb8f6184 100644 --- a/en/device-dev/subsystems/subsys-application-framework-overview.md +++ b/en/device-dev/subsystems/subsys-application-framework-overview.md @@ -1,11 +1,5 @@ # Overview -- [Basic Concepts](#section72601941194812) -- [Ability Management Framework](#section14633111813374) -- [Bundle Management Framework](#section1341146154412) -- [Working Principles](#section94302021112717) -- [Limitations and Constraints](#section89534912527) - 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. ## Basic Concepts diff --git a/en/device-dev/subsystems/subsys-boot-bootstrap.md b/en/device-dev/subsystems/subsys-boot-bootstrap.md index 0be8c6643abc6256611547697a175bbb72a04a58..0cee7d74fb4ab0763a3b6e28ce99a472d5d5b454 100644 --- a/en/device-dev/subsystems/subsys-boot-bootstrap.md +++ b/en/device-dev/subsystems/subsys-boot-bootstrap.md @@ -1,8 +1,5 @@ # bootstrap Module -- [Available APIs](#section1633115419401) -- [How to Use](#section2055311316228) - This module implements automatic service initialization. That is, the initialization function does not need to be explicitly called. Instead, it is declared using the macro definition and is automatically executed when the system is started. Specifically, after the function for starting a service is declared using a macro, it is placed in the predefined **zInit** code segment. During system startup, the **OHOS\_SystemInit** API is called to traverse the code segment and call the functions in the code segment. Therefore, you need to include the **zInit** code segment in the linker script and call the **OHOS\_SystemInit** API in the **main** function. For details about how to include the **zInit** code segment, see the Hi3861 linker script in **vendor/hisi/hi3861/hi3861/build/link/link.ld.S**. diff --git a/en/device-dev/subsystems/subsys-boot-faqs.md b/en/device-dev/subsystems/subsys-boot-faqs.md index 883c42b66f5597bfe4b4c43d6ce4b31cd709916b..e0b72945a026eaf5dd487f76351cbcec85b38b5e 100644 --- a/en/device-dev/subsystems/subsys-boot-faqs.md +++ b/en/device-dev/subsystems/subsys-boot-faqs.md @@ -1,9 +1,5 @@ # FAQs -- [System startup interrupted due to "parse failed!" error](#section2041345718513) -- [System automatically restarted again and again](#section57381816168) -- [Failed to call the SetParameter or GetParameter API with correct parameter values](#section129991227141512) - ## System startup interrupted due to "parse failed!" error **Problem** diff --git a/en/device-dev/subsystems/subsys-boot-init.md b/en/device-dev/subsystems/subsys-boot-init.md index 455700485b9cf1c301fe628054e664d4d55d61b6..486534234a0ee565d510c42943cb8cfe9232b98b 100644 --- a/en/device-dev/subsystems/subsys-boot-init.md +++ b/en/device-dev/subsystems/subsys-boot-init.md @@ -1,9 +1,5 @@ # init Module -- [Configuration File](#section56901555917) -- [How to Develop](#section15371931131117) -- [How to Use](#section173413113565) - The init module starts key service processes during system startup. If you would like to add a system service that automatically starts upon system startup, you can add the service to the **init.cfg** file. ## Configuration File diff --git a/en/device-dev/subsystems/subsys-boot-overview.md b/en/device-dev/subsystems/subsys-boot-overview.md index 5fe25a4c8d8066041da0b2b5f48590de06bed9df..35ac22931c29e64bd85659655148b924c1cb09fe 100644 --- a/en/device-dev/subsystems/subsys-boot-overview.md +++ b/en/device-dev/subsystems/subsys-boot-overview.md @@ -1,8 +1,5 @@ # Startup -- [Context Structure](#section167378304212) -- [Limitations and Constraints](#section2029921310472) - ## Context Structure The following figure shows the context structure of the Startup subsystem. diff --git a/en/device-dev/subsystems/subsys-boot-ref.md b/en/device-dev/subsystems/subsys-boot-ref.md index 0bc698346128d37dd998afcbef22480798942bca..2641af80e5019e89d9cdf81587cc006b15b61fa2 100644 --- a/en/device-dev/subsystems/subsys-boot-ref.md +++ b/en/device-dev/subsystems/subsys-boot-ref.md @@ -1,7 +1,5 @@ # Reference -- [Directory Structure](#section3523121414020) - ## Directory Structure The following table describes the directory structure of the Startup subsystem. diff --git a/en/device-dev/subsystems/subsys-boot-syspara.md b/en/device-dev/subsystems/subsys-boot-syspara.md index 86019f7ae60ec42c9083de6f641d4e55f0e749db..b161d167f40b6a5210d10a69827c02aa6fb9a886 100644 --- a/en/device-dev/subsystems/subsys-boot-syspara.md +++ b/en/device-dev/subsystems/subsys-boot-syspara.md @@ -1,16 +1,5 @@ # syspara Module -- [Introduction](#section381564832813) -- [System Parameter Definition Rules](#section431671411293) - - [System Parameter Value Definition File](#section885018321291) - - [System Parameter DAC Definition File](#section1333155762915) - - [Installation of the System Parameter Definition File](#section43801513193014) - - [Loading Sequence of the System Parameter Value Definition File](#section89971332173017) - -- [Usage of Shell Commands](#section2039119283111) -- [Available APIs](#section0137175692616) -- [How to Use](#section118404913233) - ## Introduction This module provides an easy-to-use key-value pair access interface for system services to configure service functions based on their own system parameters. The following figure shows the basic primitives used to access and operate system parameters. diff --git a/en/device-dev/subsystems/subsys-build-mini-lite.md b/en/device-dev/subsystems/subsys-build-mini-lite.md index 49420b052f99566096f0b91c1d188f5eae2e936e..333c08354840b5687ff672968545fb11231af714 100644 --- a/en/device-dev/subsystems/subsys-build-mini-lite.md +++ b/en/device-dev/subsystems/subsys-build-mini-lite.md @@ -1,31 +1,5 @@ # Building Guidelines for Mini and Small Systems -- [Overview](#section10958256161119) - - [Basic Concepts](#section1732301411128) - - [Directory Structure](#section1588744014121) - - [Build Process](#section15761735134) - -- [Configuration Rules](#section2345183962710) - - [Module](#section142532518308) - - [Chipset](#section121501451143710) - - [Product](#section134549283435) - -- [Usage Guidelines](#section13754457192211) - - [Prerequisites](#section31651120233) - - [Using hb](#section1133304172313) - - [Adding a Module](#section167110415315) - - [Adding a Chipset Solution](#section1474718565412) - - [Adding a Product Solution](#section1097623294220) - -- [Troubleshooting](#section19909721104319) - - [Invalid -- w Option](#section138233464318) - - [Library ncurses Not Found](#section151033911442) - - [mcopy not Found](#section19811838104418) - - [No riscv File or Directory](#section03111118451) - - [No Crypto](#section69981127125013) - - [Unexpected Operator](#section967617530505) - - ## Overview The Compilation and Building subsystem is a build framework that supports module-based OpenHarmony development using Generate Ninja \(GN\) and Ninja. You can use this subsystem to: diff --git a/en/device-dev/subsystems/subsys-build-standard-large.md b/en/device-dev/subsystems/subsys-build-standard-large.md index 9abbb5345d13498d3f1f5b0fd4714a1287ceb091..0dfffb12b8c42485646329fbecd5f72a86b6a34e 100644 --- a/en/device-dev/subsystems/subsys-build-standard-large.md +++ b/en/device-dev/subsystems/subsys-build-standard-large.md @@ -1,16 +1,5 @@ # Building Guidelines for Standard Systems -- [Overview](#section17466112012244) - - [Basic Concepts](#section445513507246) - - [Working Principles](#section12541217142510) - - [Limitations and Constraints](#section886933762513) - -- [Compilation and Building Guidelines](#section16901215262) - - [Directory Structure](#section109065332264) - - [Build Command](#section123265539266) - - [How to Develop](#section591084422719) - - ## Overview The compilation and building subsystem provides a framework based on Generate Ninja \(GN\) and Ninja. This subsystem allows you to: diff --git a/en/device-dev/subsystems/subsys-dfx-hicollie-development.md b/en/device-dev/subsystems/subsys-dfx-hicollie-development.md index 8bfeecbdde0a26de7371ec864ff9794c4a55b10f..90bb652a9a0f678b8a413b187bfd3bbd41d13e26 100644 --- a/en/device-dev/subsystems/subsys-dfx-hicollie-development.md +++ b/en/device-dev/subsystems/subsys-dfx-hicollie-development.md @@ -1,14 +1,5 @@ # HiCollie Development -- [Overview](#section3432134085116) -- [Available APIs](#section139261151145116) -- [Example](#section1589120102458) -- [How to Develop](#section13905646534) - - [C++](#section9797199145316) - - [Thread Suspension Monitoring](#section1734221332) - - [Timeout Monitoring](#section2186947140) - - ## Overview HiCollie provides the software watchdog function. It provides a unified framework for fault detection and fault log generation to help you locate software timeout faults resulting from system service deadlock, application main thread blocking, and service process timeout. diff --git a/en/device-dev/subsystems/subsys-dfx-hilog-lite.md b/en/device-dev/subsystems/subsys-dfx-hilog-lite.md index 8581d4f00286bcf7d490e40ba3501974433c6eb7..432bb0d18f9e77e13fa7b448bda75c486b07d5a5 100644 --- a/en/device-dev/subsystems/subsys-dfx-hilog-lite.md +++ b/en/device-dev/subsystems/subsys-dfx-hilog-lite.md @@ -1,9 +1,5 @@ # Development Guidelines on HiLog\_Lite -- [Overview](#section775017517390) -- [Available APIs](#section114412157402) -- [How to Develop](#section1482812550419) - ## Overview HiLog\_Lite is the HiLog framework for Mini-System Devices \(reference memory ≥ 128 KiB\) and Small-System Devices \(reference memory ≥ 1 MiB\). It implements functions such as log printing, log output, and flow control. diff --git a/en/device-dev/subsystems/subsys-dfx-hilog-rich.md b/en/device-dev/subsystems/subsys-dfx-hilog-rich.md index 287e312ea2bfe4cafeac830969933f8d3a780f13..fa64d743199f86cbafc5f8fc03a531d52218369a 100644 --- a/en/device-dev/subsystems/subsys-dfx-hilog-rich.md +++ b/en/device-dev/subsystems/subsys-dfx-hilog-rich.md @@ -1,12 +1,5 @@ # HiLog Development -- [Overview](#section8154107175019) -- [Available APIs](#section6748124155012) -- [How to Develop](#section102728581536) - - [C](#section12916224185417) - - [C++](#section19399185610547) - - ## Overview HiLog is the log system of OpenHarmony that provides logging for the system framework, services, and applications to record information on user operations and system running status. diff --git a/en/device-dev/subsystems/subsys-dfx-hisysevent-listening.md b/en/device-dev/subsystems/subsys-dfx-hisysevent-listening.md index 3144455e1b1fadad7bca25448c421d666e6fc3ca..2d2157fbd5bf70104df7f443f3f2e68cde429be6 100644 --- a/en/device-dev/subsystems/subsys-dfx-hisysevent-listening.md +++ b/en/device-dev/subsystems/subsys-dfx-hisysevent-listening.md @@ -1,11 +1,5 @@ # HiSysEvent Listening -- [Overview](#section315316685112) -- [Available APIs](#section0342191810519) -- [How to Develop](#section123181432175110) - - [C++](#section2016116181902) - - ## Overview HiSysEvent supports listening for events across processes. You can register a listener to listen for concerned events on a real-time basis. For example, you can enable the battery module to listen for power consumption event for power usage analysis. diff --git a/en/device-dev/subsystems/subsys-dfx-hisysevent-logging.md b/en/device-dev/subsystems/subsys-dfx-hisysevent-logging.md index b0acfd53ca0f801bfc5ffcacfbfb5751e7666762..feadce49bca7de61ce03a2a922bf18785b71b0e0 100644 --- a/en/device-dev/subsystems/subsys-dfx-hisysevent-logging.md +++ b/en/device-dev/subsystems/subsys-dfx-hisysevent-logging.md @@ -1,9 +1,5 @@ # HiSysEvent Logging -- [Overview](#section77571101789) -- [Available APIs](#section13480315886) -- [How to Develop](#section112771171317) - ## Overview HiSysEvent provides event logging APIs for OpenHarmony to record important information of key processes during system running, helping you locate faults. In addition, you can upload the log data to the cloud for big data analytics. diff --git a/en/device-dev/subsystems/subsys-dfx-hisysevent-query.md b/en/device-dev/subsystems/subsys-dfx-hisysevent-query.md index 979e02f2662309c172f7e66db59d9030828d060f..cf233db0bfb41596b81a841c994d30037934a8e1 100644 --- a/en/device-dev/subsystems/subsys-dfx-hisysevent-query.md +++ b/en/device-dev/subsystems/subsys-dfx-hisysevent-query.md @@ -1,11 +1,5 @@ # HiSysEvent Query -- [Overview](#section279684125212) -- [Available APIs](#section03869128521) -- [How to Develop](#section14286111855212) - - [C++](#section162045551743) - - ## 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-usage.md b/en/device-dev/subsystems/subsys-dfx-hisysevent-tool-usage.md index 65e7def2d36eb85ea7b3c088936ef20898ef59ab..0d49c091c88a1d711bd34990a86ce15b3d9e0c2b 100644 --- a/en/device-dev/subsystems/subsys-dfx-hisysevent-tool-usage.md +++ b/en/device-dev/subsystems/subsys-dfx-hisysevent-tool-usage.md @@ -1,8 +1,5 @@ # HiSysEvent Tool Usage -- [Overview](#section1886702718521) -- [Usage](#section1210623418527) - ## Overview The HiSysEvent tool is a command line tool preconfigured in the system. You can specify search criteria to query system events that meet your requirement. Using this tool, you can debug event logging during development or query system events for fault locating. diff --git a/en/device-dev/subsystems/subsys-dfx-hitrace-development.md b/en/device-dev/subsystems/subsys-dfx-hitrace-development.md index 927a4921fd00a917f4b9803145b63b884f457600..4cc3bd9bb90269b74e103659360807d709cfb55b 100644 --- a/en/device-dev/subsystems/subsys-dfx-hitrace-development.md +++ b/en/device-dev/subsystems/subsys-dfx-hitrace-development.md @@ -1,19 +1,5 @@ # HiTrace Development -- [Overview](#section3986195420436) -- [Use Cases](#section134561822574) - - [Usage Example](#section63861653124417) - -- [Available APIs](#section1517945334617) - - [Java, C++, and C APIs](#section932504474) - - [Parameters of C++ APIs](#section2514638125) - -- [Call Chain Processing](#section11257133933) -- [How to Develop](#section14310412491) - - [C++](#section114916381509) - - [C](#section108292107514) - - ## Overview HiTrace tracks the call chain with the same **traceid** throughout the inter-device, inter-process, and inter-thread service processes. It associates and displays the call relationship and various output information during the entire process, helping you analyze and locate faults and optimize the system. diff --git a/en/device-dev/subsystems/subsys-dfx-overview.md b/en/device-dev/subsystems/subsys-dfx-overview.md index b5df47e9f36832c40f6857a81b6a4e609f9156d9..6f10a07749d9fea236f098555710eb29a857fbab 100644 --- a/en/device-dev/subsystems/subsys-dfx-overview.md +++ b/en/device-dev/subsystems/subsys-dfx-overview.md @@ -1,7 +1,5 @@ # DFX -- [Basic Concepts](#section5635178134811) - [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\). The DFX subsystem provides the following functions: diff --git a/en/device-dev/subsystems/subsys-graphics-animation-guide.md b/en/device-dev/subsystems/subsys-graphics-animation-guide.md index 4bb1a33190f3c76e78c9d4b4d83c25690b943937..e1e325583c1cbb89671e907b071fe1d776a40509 100644 --- a/en/device-dev/subsystems/subsys-graphics-animation-guide.md +++ b/en/device-dev/subsystems/subsys-graphics-animation-guide.md @@ -1,9 +1,5 @@ # Development Guidelines on Animators -- [When to Use](#section726685714018) -- [Available APIs](#section85794718418) -- [How to Develop](#section14101161317435) - ## When to Use A UI animator is implemented by calling the callback function you set for each tick using the task processing mechanism. The following classes are provided for you to implement an animator: diff --git a/en/device-dev/subsystems/subsys-graphics-common-guide.md b/en/device-dev/subsystems/subsys-graphics-common-guide.md index fc7c79ec29f35df2218ea4d5d74ef3da7c5a6783..b7c3caa23392bb87bc0c123b03a8c55c94669be9 100644 --- a/en/device-dev/subsystems/subsys-graphics-common-guide.md +++ b/en/device-dev/subsystems/subsys-graphics-common-guide.md @@ -1,24 +1,5 @@ # Development Guidelines on Common Components -- [UIButton](#section145353310214) -- [When to Use](#section1169616141577) -- [Available APIs](#section341211538315) -- [How to Develop](#section22501726193214) -- [UIImageView](#section19523161611259) -- [When to Use](#section1274484210400) -- [Available APIs](#section74981992411) -- [How to Develop \(Adaptive Mode\)](#section144341333134114) -- [How to Develop \(Tile Mode\)](#section97178160421) -- [UILabel](#section16588132012911) -- [When to Use](#section6870195634218) -- [Available APIs](#section2012714510433) -- [How to Develop \(Default Mode\)](#section83221538114410) -- [How to Develop \(Background Color and Opacity\)](#section933360204510) -- [How to Develop \(Letter Spacing\)](#section19447826124518) -- [How to Develop \(Size-Adaptive Mode\)](#section101711842154617) -- [How to Develop \(Ellipsis Mode\)](#section1249519410471) -- [How to Develop \(Scrolling Mode\)](#section15643122618478) - Common components inherit from the base class **UIView**. Child components cannot be added to common components, such as buttons, images, and labels. **Figure 1** Tree structure of common components diff --git a/en/device-dev/subsystems/subsys-graphics-container-guide.md b/en/device-dev/subsystems/subsys-graphics-container-guide.md index cc2f751868597158a0473bf52324e0ed708bef89..610b6fd166b60acd12b6465c97e10e1012b08f89 100644 --- a/en/device-dev/subsystems/subsys-graphics-container-guide.md +++ b/en/device-dev/subsystems/subsys-graphics-container-guide.md @@ -1,14 +1,5 @@ # Development Guidelines on Container Components -- [UIViewGroup](#section145471898812) -- [When to Use](#section0916112362216) -- [Available APIs](#section12641756192212) -- [How to Develop](#section5412161692311) -- [UIScrollView](#section174961523161315) -- [When to Use](#section8937101902413) -- [Available APIs](#section14789133142420) -- [How to Develop](#section1769754422417) - 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**. **Figure 1** Structure of common container components diff --git a/en/device-dev/subsystems/subsys-graphics-layout-guide.md b/en/device-dev/subsystems/subsys-graphics-layout-guide.md index 95e8e154a98157305fcded6bec0d44526399740d..232e02f89104abdfa8b1c946e98c95ccfe6d2c4e 100644 --- a/en/device-dev/subsystems/subsys-graphics-layout-guide.md +++ b/en/device-dev/subsystems/subsys-graphics-layout-guide.md @@ -1,15 +1,5 @@ # Development Guidelines on Layout Container Components -- [UISwipeView](#section13631719181717) -- [When to Use](#section11299120102617) -- [Available APIs](#section767434119261) -- [Development Procedure \(Non-Cyclic Horizontal Swiping\)](#section111911175287) -- [Development Procedure \(Cyclic Horizontal Swiping\)](#section1976914915282) -- [GridLayout](#section46819199173) -- [When to Use](#section831618247294) -- [Available APIs](#section597214622912) -- [How to Develop](#section1418253410306) - 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. ## UISwipeView diff --git a/en/device-dev/subsystems/subsys-graphics-overview.md b/en/device-dev/subsystems/subsys-graphics-overview.md index 14aa1dab9315e286319b6456f0fda3ed5b23375e..51c370066e3ef23276a977e6d365632a5b9ca8ce 100644 --- a/en/device-dev/subsystems/subsys-graphics-overview.md +++ b/en/device-dev/subsystems/subsys-graphics-overview.md @@ -1,11 +1,5 @@ # Graphics -- [UI Components](#section1987017145112) -- [Layouts](#section662016231612) -- [Animators](#section73736284117) -- [Input Events](#section672194012114) -- [Rendering](#section14338859916) - 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. ## UI Components diff --git a/en/device-dev/subsystems/subsys-multimedia-camera-overview.md b/en/device-dev/subsystems/subsys-multimedia-camera-overview.md index f09aab69ccc7177500a81ab64260af1d5ae614da..4096512ed30b2642165bb94ee012451db5dd97cc 100644 --- a/en/device-dev/subsystems/subsys-multimedia-camera-overview.md +++ b/en/device-dev/subsystems/subsys-multimedia-camera-overview.md @@ -1,8 +1,5 @@ # Overview -- [Basic Concepts](#section175012297491) -- [Working Principles](#section193961322175011) - ## Basic Concepts Camera is one of the services provided by the OpenHarmony multimedia subsystem. The camera module provides recording, preview, and photographing features and supports concurrent stream reading by multiple users. 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 d7b772d0cc9907e2c68637ae7e3cd906518470a8..c862dff967b54cac0087a5e324849fbcc3d61729 100644 --- a/en/device-dev/subsystems/subsys-multimedia-camera-photo-guide.md +++ b/en/device-dev/subsystems/subsys-multimedia-camera-photo-guide.md @@ -1,10 +1,5 @@ # Development Guidelines on Photographing -- [When to Use](#section1963312376119) -- [Available APIs](#section56549532016) -- [Limitations and Constraints](#section1165911177314) -- [How to Develop](#section138543918214) - ## When to Use Use the camera module APIs to capture frames \(photographing\). 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 9655f3377b33a9e94862d042b167d22462d2c852..381697174c2824f79d5216ac7017e7b1345eb385 100644 --- a/en/device-dev/subsystems/subsys-multimedia-camera-preview-guide.md +++ b/en/device-dev/subsystems/subsys-multimedia-camera-preview-guide.md @@ -1,10 +1,5 @@ # Development Guidelines on Previewing -- [When to Use](#section186634310418) -- [Available APIs](#section125479541744) -- [Limitations and Constraints](#section1165911177314) -- [How to Develop](#section34171333656) - ## When to Use Use the camera module APIs to generate and play video streams. 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 eaf3de1535ba32dd00a7ffca114c1749856d59a6..eb938a26e85fd2a57e5460c0998e0eb0762acff8 100644 --- a/en/device-dev/subsystems/subsys-multimedia-camera-record-guide.md +++ b/en/device-dev/subsystems/subsys-multimedia-camera-record-guide.md @@ -1,10 +1,5 @@ # Development Guidelines on Video Recording -- [When to Use](#section186634310418) -- [Available APIs](#section125479541744) -- [Limitations and Constraints](#section1165911177314) -- [How to Develop](#section1196016315516) - ## When to Use Use the camera module APIs to capture video streams. diff --git a/en/device-dev/subsystems/subsys-multimedia-video-overview.md b/en/device-dev/subsystems/subsys-multimedia-video-overview.md index 9f3b0433a261a99a1b0e1b54d3301af09adad541..ae286a6e51211a4824d9514f6dc60f3781fee9ee 100644 --- a/en/device-dev/subsystems/subsys-multimedia-video-overview.md +++ b/en/device-dev/subsystems/subsys-multimedia-video-overview.md @@ -1,8 +1,5 @@ # Overview -- [Basic Concepts](#section967213571204) -- [Encoding and Decoding](#section1582020483111) - OpenHarmony multimedia services help you to develop for audio and video playback and recording. - The media playback module facilitates the development of audio and video playback, including media file and stream playback, volume control, and playback progress control. 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 2c0af3ca94b80e7a6480818de7d1d5eb63e35b6a..1ec491d5d18d8b4415cb3c12874183a0ac1b210d 100644 --- a/en/device-dev/subsystems/subsys-multimedia-video-play-guide.md +++ b/en/device-dev/subsystems/subsys-multimedia-video-play-guide.md @@ -1,10 +1,5 @@ # Development Guidelines on Media Playback -- [When to Use](#section186634310418) -- [Available APIs](#section125479541744) -- [Limitations and Constraints](#section1165911177314) -- [How to Develop](#section34171333656) - ## When to Use Audio and video playback is a process to decode audio and video files or stream data and play them by an output device. During the process, playback tasks are managed. 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 e4258a87ca4b14f39f43046146ef066eab6c557b..b698f727273d853f10a936ad88921871f9928884 100644 --- a/en/device-dev/subsystems/subsys-multimedia-video-record-guide.md +++ b/en/device-dev/subsystems/subsys-multimedia-video-record-guide.md @@ -1,10 +1,5 @@ # Development Guidelines on Media Recording -- [When to Use](#section186634310418) -- [Available APIs](#section125479541744) -- [Limitations and Constraints](#section1165911177314) -- [How to Develop](#section34171333656) - ## When to Use To record audios and videos, use APIs described in this section to set the encoding format, sampling rate, and bit rate, and encapsulate output files based on the parameters. diff --git a/en/device-dev/subsystems/subsys-ota-guide.md b/en/device-dev/subsystems/subsys-ota-guide.md index dac093e437eede6b62f3dde0776fdab317072841..3a2434457bdde97f55e4e884938b2f0d58fc6383 100644 --- a/en/device-dev/subsystems/subsys-ota-guide.md +++ b/en/device-dev/subsystems/subsys-ota-guide.md @@ -1,25 +1,5 @@ # OTA Update -- [Introduction](#section753413913562) -- [Constraints](#section61232796162135) -- [Generating a Public/Private Key Pair](#section1392711588162135) -- [Generating an Update Package](#section704519924162135) - - [Mini and Small Systems](#section527064658162135) - - [Standard System](#section1291354584162135) - -- [Uploading the Update Package](#section1040019352162135) -- [Downloading the Update Package](#section1870792413162135) -- [Integrating OTA Update Capabilities](#section2107348555162135) -- [API Application Scenario \(Default\)](#section1308521557162135) - - [How to Develop](#section2103641927162135) - - [Sample Code](#section1918621904162135) - -- [API Application Scenario \(Custom\)](#section1332839930162135) - - [How to Develop](#section2120976727162135) - - [Sample Code](#section1743369672162135) - -- [Upgrading the System](#section1704276175162135) - ## Introduction Over the Air \(OTA\) is a technology that makes it easier for you to remotely update devices, such as IP cameras. Currently, the mini and small systems support update using a full package, but not a differential package. A full package contains all content of a new system, and a differential package contains the differences between the old and new systems. diff --git a/en/device-dev/subsystems/subsys-remote-start.md b/en/device-dev/subsystems/subsys-remote-start.md index be33f777cffe49af59a8b475bf7e45dacb08f93e..2c3b0e4d5866b238e62f7c488d1033d0f0565027 100644 --- a/en/device-dev/subsystems/subsys-remote-start.md +++ b/en/device-dev/subsystems/subsys-remote-start.md @@ -1,11 +1,5 @@ # Distributed Remote Startup -- [Overview](#section186634310418) -- [Basic Concepts](#section982651246) -- [Available APIs](#section125479541744) -- [Limitations and Constraints](#section1165911177314) -- [How to Develop](#section34171333656) - ## Overview The Distributed Manager Service sets up a distributed service platform in OpenHarmony by using a proxy between the primary and secondary devices. With the Distributed Manager Service, the primary device \(OpenHarmony-powered smart TV\) can start a Feature Ability \(FA\) deployed on the secondary device \(a memory-constrained OpenHarmony device such as an IP camera or a lite wearable\). diff --git a/en/device-dev/subsystems/subsys-security-communicationverify.md b/en/device-dev/subsystems/subsys-security-communicationverify.md index 5d98f1429cc85c245bfcd3827ba92e71443e0bd7..ae5dfa0636e5a995588143f97a2864e373aadb6b 100644 --- a/en/device-dev/subsystems/subsys-security-communicationverify.md +++ b/en/device-dev/subsystems/subsys-security-communicationverify.md @@ -1,10 +1,5 @@ # Development Guidelines on IPC Authentication -- [When to Use](#section18502174174019) -- [Available APIs](#section1633115419401) -- [How to Develop](#section022611498210) -- [FAQ](#section15729104510271) - ## When to Use System services registered with Samgr can be accessed by other processes through IPC APIs. When a process requests to access such an API, IPC authentication is triggered to check whether the process has the required permission. If the process does not have the required permission, the access request will be denied. diff --git a/en/device-dev/subsystems/subsys-security-overview.md b/en/device-dev/subsystems/subsys-security-overview.md index 11159d39de4e69aade5326c7ba4b31705d460934..9119937fb2e626fe4b2a178ca63879b06be1a10d 100644 --- a/en/device-dev/subsystems/subsys-security-overview.md +++ b/en/device-dev/subsystems/subsys-security-overview.md @@ -1,8 +1,5 @@ # Overview -- [Basic Concepts](#section175012297491) -- [Limitations and Constraints](#section2029921310472) - 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: - Application signature verification diff --git a/en/device-dev/subsystems/subsys-security-rightmanagement.md b/en/device-dev/subsystems/subsys-security-rightmanagement.md index 8b15372203c89016c5862f443303daa59cdefc67..4505ed49f0c1cb706d53a53c711820af4479a56b 100644 --- a/en/device-dev/subsystems/subsys-security-rightmanagement.md +++ b/en/device-dev/subsystems/subsys-security-rightmanagement.md @@ -1,10 +1,5 @@ # Development Guidelines on Application Permission Management -- [How Application Permission Management Works](#section193961322175011) -- [When to Use](#section18502174174019) -- [Available APIs](#section1633115419401) -- [How to Develop](#section022611498210) - ## How Application Permission Management Works OpenHarmony allows users to install third-party applications and controls calls made by third-party applications to sensitive permissions. When developing an application, you need to declare the sensitive permissions that the application may require in the **profile.json** file. The permissions can be static or dynamic. Static permissions need to be registered during application installation, and dynamic permissions can be obtained only upon user authorization. Authorization modes include system settings, manual authorization by applications, and others. In addition, application signature control is used to ensure that the application installation package has been confirmed by the device vendor. diff --git a/en/device-dev/subsystems/subsys-security-sigverify.md b/en/device-dev/subsystems/subsys-security-sigverify.md index dfc7051d811f6dfe7e7ad0926ae764eac76b5c17..482e70032b22dbe70ab90949c362e21b2434e9f4 100644 --- a/en/device-dev/subsystems/subsys-security-sigverify.md +++ b/en/device-dev/subsystems/subsys-security-sigverify.md @@ -1,12 +1,5 @@ # Development Guidelines on Application Signature Verification -- [When to Use](#section18502174174019) -- [Signature Verification Process](#section554632717226) -- [Available APIs](#section1633115419401) -- [How to Develop](#section4207112818418) - - [OpenHarmony Self-signed Application](#section167151429133312) - - ## When to Use To ensure the integrity and trustworthiness of the applications to be installed in OpenHarmony, the applications must be signed and their signatures must be verified. diff --git a/en/device-dev/subsystems/subsys-sensor-guide.md b/en/device-dev/subsystems/subsys-sensor-guide.md index 74a27dfd84c880908bb950bb9ddacef86230ddb2..dc4cfb878fd568a18507f6d2c5a6bdbb6a783867 100644 --- a/en/device-dev/subsystems/subsys-sensor-guide.md +++ b/en/device-dev/subsystems/subsys-sensor-guide.md @@ -1,7 +1,5 @@ # Sensors Usage Guidelines -- [How to Use](#section18816105182315) - The following steps use the sensor whose **sensorTypeId** is **0** as an example. The guidelines for other sensor types are similar. ## How to Use diff --git a/en/device-dev/subsystems/subsys-sensor-overview.md b/en/device-dev/subsystems/subsys-sensor-overview.md index 89b943330352cb8c3e65927a25fb847f5a69e2fd..ffd7478fe93bbbe3aad455652c810cbf5a1cfaf7 100644 --- a/en/device-dev/subsystems/subsys-sensor-overview.md +++ b/en/device-dev/subsystems/subsys-sensor-overview.md @@ -1,8 +1,5 @@ # Sensors Overview -- [Introduction](#section667413271505) -- [Available APIs](#section7255104114110) - ## Introduction The pan-sensor service subsystem provides a lightweight sensor service framework. You can call APIs offered by this framework to query the sensor list, enable or disable a sensor, and subscribe to or unsubscribe from sensor data. The following figure shows the architecture of the lightweight sensor framework. diff --git a/en/device-dev/subsystems/subsys-testguide-envbuild.md b/en/device-dev/subsystems/subsys-testguide-envbuild.md index 54a14fe5a0842e00c119a6ca38813724c4dc66a6..d5726df3c80071f142faebdca10d1558b90aba44 100644 --- a/en/device-dev/subsystems/subsys-testguide-envbuild.md +++ b/en/device-dev/subsystems/subsys-testguide-envbuild.md @@ -1,6 +1,5 @@ - +# Setting Up the Environment -# Setting Up the Environment ## Basic Test Framework Environment |Environment|Operating System|Linux Extended Component|Python|Python Plug-ins|NFS Server|HDC| diff --git a/en/device-dev/subsystems/subsys-toolchain-bytrace-guide.md b/en/device-dev/subsystems/subsys-toolchain-bytrace-guide.md index e6ddd00929d2f6b6bd378701f31ea1b756de3a9e..e3b542ac9197dbf8c93ccee723232403aff3bed5 100644 --- a/en/device-dev/subsystems/subsys-toolchain-bytrace-guide.md +++ b/en/device-dev/subsystems/subsys-toolchain-bytrace-guide.md @@ -1,9 +1,5 @@ # bytrace Usage Guidelines -- [Overview](#section11388623181619) -- [How to Develop](#section1595564317164) -- [Usage Example](#section667273201818) - ## Overview bytrace is a tool for you to trace processes and analyze performance. It encapsulates and extends the kernel ftrace and supports event tracking in the user space. With bytrace, you can open a user-space or kernel-space label you want to view \(run the **bytrace -l** command to query all the supported labels\) and run the **--trace\_begin** and **-o filename** \(or **--output filename**\) commands to capture traces and dump them to a specified file. diff --git a/en/device-dev/subsystems/subsys-usbservice-guide.md b/en/device-dev/subsystems/subsys-usbservice-guide.md index 2b4a392ee833b648cf50ec5262ed62c6f9d2f796..aef72208f914db636a4827ea0ff0a06c164c242c 100644 --- a/en/device-dev/subsystems/subsys-usbservice-guide.md +++ b/en/device-dev/subsystems/subsys-usbservice-guide.md @@ -1,7 +1,5 @@ # USB Usage Guidelines -- [How to Use](#section18816105182315) - The following procedure uses bulk transfer as an example. ## Procedure diff --git a/en/device-dev/subsystems/subsys-usbservice-overview.md b/en/device-dev/subsystems/subsys-usbservice-overview.md index fcf2ecee0f233029c038647cf2cacba73762b01d..33898e8b699076eca0391365b594dff300eb75e9 100644 --- a/en/device-dev/subsystems/subsys-usbservice-overview.md +++ b/en/device-dev/subsystems/subsys-usbservice-overview.md @@ -1,11 +1,5 @@ # USB Overview -- [Introduction](#section175431838101617) -- [Available APIs](#section83365421647) - - [Host](#section83365421658) - - [Device](#section83365421669) - - [Port](#section83365421670) - ## Introduction USB devices are classified into two types: USB host and USB device. On OpenHarmony, you can use the port service to switch between the host mode and device mode. In host mode, you can obtain the list of connected USB devices, manage device access permissions, and perform bulk transfer or control transfer between the host and connected devices. In device mode, you can switch between functions including HDC (debugging), ACM (serial port), and ECM (Ethernet port). diff --git a/en/device-dev/subsystems/subsys-xts-guide.md b/en/device-dev/subsystems/subsys-xts-guide.md index 994ff8b60961d5c44e33c6e3a3c27f62606f1d8f..70951c0d1e3ef8da140f58bdb67831901ce48793 100644 --- a/en/device-dev/subsystems/subsys-xts-guide.md +++ b/en/device-dev/subsystems/subsys-xts-guide.md @@ -1,22 +1,5 @@ # XTS -- [Introduction](#section465982318513) -- [System Types](#section125090457443) -- [Directory Structure](#section161941989596) -- [Constraints](#section119744591305) -- [Usage Guidelines](#section137768191623) -- [Test Case Development Guidelines](#section3695134065513) - - [C-based Test Case Development and Compilation \(for the Mini System\)](#section198193336544) - - [C-based Test Case Execution \(for the Mini System\)](#section13820233175418) - - [C++-based Test Case Development and Compilation \(for Standard and Small Systems\)](#section3822123311540) - - [C++-based Test Case Execution \(for Standard and Small Systems\)](#section128222336544) - - [JavaScript-based Test Case Development \(for the Standard System\)](#section159801435165220) - - [JavaScript-based Test Case Packaging \(for the Standard System\)](#section445519106559) - - [\#EN-US\_TOPIC\_0000001126156429/section191521423950](#section191521423950) - -- [Full Compilation Guide \(for the Standard System\)](#section1519992743415) -- [Full Test Case Execution Guide \(for Small and Standard Systems\)](#section118149111426) - ## Introduction The X test suite \(XTS\) subsystem contains a set of OpenHarmony certification test suites, including the currently supported application compatibility test suite \(ACTS\) and the device compatibility test suite \(DCTS\) that will be supported in the future. diff --git a/en/device-dev/subsystems/telephony-service.md b/en/device-dev/subsystems/telephony-service.md index f91b93bd849e1074b608d7161196d693d23e88aa..8ea0cfbad4b42ca98c019c95a2b552028b3f4fca 100644 --- a/en/device-dev/subsystems/telephony-service.md +++ b/en/device-dev/subsystems/telephony-service.md @@ -1,10 +1,5 @@ # Telephony Service -- [Introduction](#section184mcpsimp) -- [Basic Concepts](#section187mcpsimp) -- [Working Principles](#section194mcpsimp) -- [Constraints](#section205mcpsimp) - ## Introduction This document provides development guidelines related to the telephony subsystem, including modem vendor library integration, initialization, service request responding, and modem event reporting. It is intended as a reference for developers of different modem chips, helping them efficiently develop telephony service-related functions. diff --git a/en/readme/ARK-Runtime-Subsystem.md b/en/readme/ARK-Runtime-Subsystem.md index 6bd113f443f433f63889445a0afcbc9b3b6e0b0e..702e3e169a519b33bd1bfce55bef68d77b5829a9 100644 --- a/en/readme/ARK-Runtime-Subsystem.md +++ b/en/readme/ARK-Runtime-Subsystem.md @@ -1,11 +1,5 @@ # ARK Runtime Subsystem -- [ARK Runtime Subsystem](#ark-runtime-subsystem) - - [Introduction](#introduction) - - [Directory Structure](#directory-structure) - - [Usage Guide](#usage-guide) - - [Repositories Involved](#repositories-involved) - ## Introduction ARK is a unified programming platform developed by Huawei. Its key components include a compiler, toolchain, and runtime. ARK supports compilation and execution of high-level programming languages on the multiple hardware platform and accelerates the execution of the OpenHarmony operating system and its applications and services on mobile phones, PCs, tablets, TVs, automobiles, and smart wearables. The ARK-JS open sourced this time provides the capability of compiling and running the JavaScript \(JS\) language on the standard system of OpenHarmony. diff --git a/en/readme/account.md b/en/readme/account.md index b1c90f7b2b5d8742af9f0b089db37d7a4adc5f28..86d9de8a9d2d26fad3ff38f49318e2a41e337e8a 100755 --- a/en/readme/account.md +++ b/en/readme/account.md @@ -1,11 +1,5 @@ # Account -- [Introduction](#section11660541593) -- [Architecture](#section1412183212132) -- [Directory Structure](#section161941989596) -- [Usage Guidelines](#section1312121216216) -- [Repositories Involved](#section1371113476307) - ## Introduction In a standard system, the Account subsystem supports login status management of distributed cloud accounts, interconnection with vendors' cloud account apps on the device side, and query and update of the cloud account login status. diff --git a/en/readme/ai.md b/en/readme/ai.md index 29def5742a7b9b16f2e3ccb3a3932b6279f114d4..0294ad8c5aca3d8cc8911f9f644a35cf4f99dc23 100644 --- a/en/readme/ai.md +++ b/en/readme/ai.md @@ -1,12 +1,5 @@ # AI -- [Introduction](#section187321516154516) -- [Directory Structure](#section571610913453) -- [Constraints](#section5748426453) -- [Usage](#section6370123616447) -- [Repositories Involved](#section10492183517430) -- [Reference](#section6808423133718) - ## Introduction The AI subsystem is the part of OpenHarmony that provides native distributed AI capabilities. At the heart of the subsystem is a unified AI engine framework, which implements quick integration of AI algorithm plug-ins. The framework consists of the plug-in management, module management, and communication management modules, fulfilling lifecycle management and on-demand deployment of AI algorithms. Under this framework, AI algorithm APIs will be standardized to facilitate distributed calling of AI capabilities. In addition, unified inference APIs will be provided to adapt to different inference framework hierarchies. diff --git a/en/readme/dfx.md b/en/readme/dfx.md index f048c86051d851de245485d4a9b014b987961da6..ec20f1db53a71baf8db0c4fb01e05b0222766b9c 100644 --- a/en/readme/dfx.md +++ b/en/readme/dfx.md @@ -1,10 +1,5 @@ # DFX -- [Introduction](#section1347419114210) -- [Architecture](#section342962219551) -- [Directory Structure](#section62815498425) -- [Repositories Involved](#section767551120815) - ## Introduction [Design for X](https://en.wikipedia.org/wiki/Design_for_X) \(DFX\) refers to the software design that aims to improve the quality attribute in OpenHarmony. It mainly consists of two parts: design for reliability \(DFR\) and design for testability \(DFT\). diff --git a/en/readme/distributed-data-management.md b/en/readme/distributed-data-management.md index afb78c1c4f5eb354f7c568d22e0c116c542ef495..2a37c422be2c46b0471ddbbc56ea1d7f0f0203ba 100644 --- a/en/readme/distributed-data-management.md +++ b/en/readme/distributed-data-management.md @@ -1,13 +1,5 @@ # Distributed Data Management -- [Introduction](#section11660541593) -- [Directory Structure](#section161941989596) -- [Usage](#section1312121216216) - - [Local Data Management](#section129654513264) - - [Distributed Data Service](#section1961602912224) - -- [Repositories Involved](#section1371113476307) - ## Introduction **About the Subsystem** diff --git a/en/readme/distributed-file.md b/en/readme/distributed-file.md index 55e6ee10c334df771a9acec62c42f9e386b3b3db..8c480dd5662f80effeb33e783596b8685afd3a13 100644 --- a/en/readme/distributed-file.md +++ b/en/readme/distributed-file.md @@ -1,16 +1,5 @@ # Distributed File -- [Introduction](#section104mcpsimp) - - [Architecture](#section110mcpsimp) - -- [Directory Structure](#section113mcpsimp) -- [Constraints](#section117mcpsimp) -- [Usage](#section125mcpsimp) - - [Available APIs](#section127mcpsimp) - - [Usage Guidelines](#section149mcpsimp) - -- [Repositories Involved](#section178mcpsimp) - ## Introduction Currently, the Distributed File subsystem provides apps with JavaScript APIs for I/O capabilities, including APIs for managing files and directories, obtaining file information, reading and writing data streams of files, and receiving URIs rather than absolute paths. diff --git a/en/readme/distributed-scheduler.md b/en/readme/distributed-scheduler.md index ec46001bd381e1734384e13e8b2f7eb0d7536271..b5e8c0326f78a0c679751d64c67755036af40ae0 100755 --- a/en/readme/distributed-scheduler.md +++ b/en/readme/distributed-scheduler.md @@ -1,10 +1,5 @@ # Distributed Scheduler -- [Introduction](#section11660541593) -- [System Architecture](#section13587185873516) -- [Directory Structure](#section161941989596) -- [Repositories Involved](#section1371113476307) - ## Introduction Distributed Scheduler is used for cross-device component management. It allows the local device to access or control remote components, and enables app collaboration in distributed scenarios. Its main functions are as follows: diff --git a/en/readme/driver-subsystem.md b/en/readme/driver-subsystem.md index f504748bc6444236de815c64118043bb8147cb36..27f908a20f8cd114f7043946855762e4c52e9e29 100644 --- a/en/readme/driver-subsystem.md +++ b/en/readme/driver-subsystem.md @@ -1,12 +1,5 @@ # Driver Subsystem -- [Overview](#section11660541593) -- [Architecture](#section101721227145613) -- [Directory Structure](#section1464106163817) -- [Use](#section8496817141616) -- [Installation](#section14778154275818) -- [Repositories Involved](#section134812226297) - ## Overview The OpenHarmony driver subsystem is constructed using the C object-oriented programming \(OOP\). It provides a unified driver platform through platform decoupling, kernel decoupling, and compatible kernels. This unified driver architecture platform is designed to provide a more precise and efficient development environment, where you develop a driver that can be deployed on different systems supporting HDF. diff --git a/en/readme/dsoftbus.md b/en/readme/dsoftbus.md index 48c60a4f3dfe8bc4faf48151a3c2b9e9118d3d9c..c98481d5d41f4a41bd4ee1e5f98701c895ba2512 100755 --- a/en/readme/dsoftbus.md +++ b/en/readme/dsoftbus.md @@ -1,15 +1,5 @@ # DSoftBus -- [Introduction](#section11660541593) -- [Architecture](#section342962219551) -- [Directory Structure](#section161941989596) -- [Constraints](#section119744591305) -- [Usage Guidelines](#section1312121216216) - - [RPC](#section129654513264) - - [DSoftBus](#section36252592710) - -- [Repositories Involved](#section1371113476307) - ## Introduction The DSoftBus subsystem provides communication capabilities for OpenHarmony, including WLAN, Bluetooth, DSoftBus, and remote procedure call \(RPC\). diff --git a/en/readme/globalization.md b/en/readme/globalization.md index c4ffbdaa5fbf3638d998f289d6b657331ee51fbe..8879c928bbf1fe37d567799e8d6b5ed50ea15af1 100755 --- a/en/readme/globalization.md +++ b/en/readme/globalization.md @@ -1,10 +1,5 @@ # Globalization -- [Introduction](#section11660541593) -- [Architecture](#section1558604311012) -- [Directory Structure](#section161941989596) -- [Repositories Involved](#section1371113476307) - ## Introduction If OpenHarmony devices and applications need to be used globally, they must meet the requirements of users in different regions on languages and cultures. The Globalization subsystem provides the multi-language and multi-cultural capabilities for global use, including: diff --git a/en/readme/graphics.md b/en/readme/graphics.md index 2b0456e85cdb978c0677f084489749b8fadb3f0c..2b659df208b122472b0eb36cd8b87056478f5002 100644 --- a/en/readme/graphics.md +++ b/en/readme/graphics.md @@ -1,21 +1,5 @@ # Graphics -- [1.1 Mini System](#section1346303311377) - - [Introduction](#section1165992615384) - - [Directory Structure](#section141331948134020) - - [Constraints](#section15729113104112) - - [Usage](#section812962919413) - - [Repositories Involved](#section12651205434115) - -- [1.2 Standard System](#section1249610812538) - - [Introduction](#section1374615251510) - - [Directory Structure](#section16751364713) - - [Constraints](#section126494189715) - - [Compilation and Building](#section883114292070) - - [Usage](#section1351214227564) - - [Repositories Involved](#section11578621131119) - - The Graphics subsystem mainly consists of user interface \(UI\) components, layout, animator, font, input event, window management, and rendering and drawing modules. It is an application framework that can be built on the LiteOS to develop OpenHarmony applications for Internet of Things \(IoT\) devices with limited hardware resources or on the standard OS to develop OpenHarmony applications for standard- and large-system devices \(for example, tablet and lite smart devices\). ## 1.1 Mini System diff --git a/en/readme/js-ui-framework.md b/en/readme/js-ui-framework.md index a693195aa9c442d122a82ee38b744be11e262d2e..11fe6b53a7c9082c4dda29961d5af746845bdfe4 100644 --- a/en/readme/js-ui-framework.md +++ b/en/readme/js-ui-framework.md @@ -1,10 +1,5 @@ # JS UI Framework -- [Introduction](#section11660541593) -- [Directory Structure](#section179173014915) -- [Usage](#section1711605017917) -- [Repositories Involved](#section1599816111011) - ## Introduction The OpenHarmony JS UI framework provides basic, container, and canvas UI components and standard CSS animation capabilities. It supports the web-development-like programming paradigm. diff --git a/en/readme/kernel-subsystem.md b/en/readme/kernel-subsystem.md index 65ef7049361d4b9ac331347d313acb05703b47fb..31e52226a8d7675452ef126d667b39222f01f45a 100644 --- a/en/readme/kernel-subsystem.md +++ b/en/readme/kernel-subsystem.md @@ -1,17 +1,5 @@ # Kernel -- [Introduction](#section11660541593) -- [LiteOS](#section6253122153515) -- [Linux](#section143373618411) -- [Directory Structure](#section21571344112) -- [Constraints](#section19647171710417) -- [Usage](#section1393789267) - - [LiteOS](#section118811457303) - - [Linux](#section1352114469620) - -- [Build](#section19369206113115) -- [Repositories Involved](#section27639463106) - ## Introduction OpenHarmony provides LiteOS and Linux for different levels of systems. LiteOS applies to mini and small systems. Linux applies to small and standard systems. diff --git a/en/readme/misc-services.md b/en/readme/misc-services.md index 3d256aa7e0efba67d9abace3bb6e5deb8a329fbd..937e6cb511f72dfe0ba1e413e6151153c754aeb8 100755 --- a/en/readme/misc-services.md +++ b/en/readme/misc-services.md @@ -1,9 +1,5 @@ # Misc Services -- [Introduction](#section11660541593) -- [Directory Structure](#section161941989596) -- [Repositories Involved](#section1371113476307) - ## Introduction The Misc services subsystem provides APIs for setting the system time. diff --git a/en/readme/multimedia.md b/en/readme/multimedia.md index dd0490a9ad0d8c0cd82bef22c1c5fd66cdcef1e7..c26c892898ccec4d4f1a442dc2a9e5abd623f27c 100755 --- a/en/readme/multimedia.md +++ b/en/readme/multimedia.md @@ -1,12 +1,5 @@ # Multimedia -- [Introduction](#section11660541593) -- [Directory Structure](#section161941989596) -- [Constraints](#section119744591305) -- [Usage Guidelines](#section1312121216216) -- [Installation](#section11914418405) -- [Repositories Involved](#section1371113476307) - ## Introduction The multimedia subsystem provides a set of simple and easy-to-use APIs for you to access the system and media resources. diff --git a/en/readme/multimodal-input.md b/en/readme/multimodal-input.md index 562dc9f32069338f655d5097034d8de1e8088c8b..135d35901d157fd3ea6535aa0ff688e491496ae6 100644 --- a/en/readme/multimodal-input.md +++ b/en/readme/multimodal-input.md @@ -1,10 +1,5 @@ # Multimodal Input -- [Overview](#section11660541593) -- [Directory Structure](#section14408467105) -- [Usage](#section18111235161011) -- [Repositories Involved](#section135327891219) - ## Overview OpenHarmony provides a Natural User Interface \(NUI\) for you to interact with your users. Unlike conventional categorization of input methods, OpenHarmony combines input methods of different dimensions into multimodal inputs, so you can easily arm your application with multi-dimensional, natural interaction features by using the application framework and system built-in UI components or APIs. diff --git a/en/readme/pan-sensor.md b/en/readme/pan-sensor.md index f6aef6645ee1dc02b86998af3c8d4dc6f42b6b32..916fa4a61f68ae65263ab5b982c393c860dcdaf5 100755 --- a/en/readme/pan-sensor.md +++ b/en/readme/pan-sensor.md @@ -1,10 +1,5 @@ # Pan-Sensor -- [Introduction](#section11660541593) -- [Directory Structure](#section161941989596) -- [Usage](#section1312121216216) -- [Repositories Involved](#section1371113476307) - ## Introduction The pan-sensor service subsystem provides a lightweight sensor service framework, through which you can perform the following operations: diff --git a/en/readme/power-management.md b/en/readme/power-management.md index c1d2f1cca2584954102db32652c9116c9bf410d5..d7a02c880cc1507a295cb0514d23f7b28a921b75 100644 --- a/en/readme/power-management.md +++ b/en/readme/power-management.md @@ -1,10 +1,5 @@ # Power Management -- [Introduction](#section11660541593) -- [Directory Structure](#section19472752217) -- [Usage](#section19959125052315) -- [Repositories Involved](#section63151229062) - ## Introduction The power management subsystem provides the following functions: diff --git a/en/readme/programming-language-runtime.md b/en/readme/programming-language-runtime.md index 81fa85fb1ff5e5f8e34de6c9c7d74bddb2a377cb..66dc684a9d3d136f42597256619f6e6d980c1f75 100644 --- a/en/readme/programming-language-runtime.md +++ b/en/readme/programming-language-runtime.md @@ -1,11 +1,5 @@ # Programming Language Runtime -- [Introduction](#section15963162310012) -- [Directory Structure](#section971210485617) -- [Constraints](#section119744591305) -- [Usage](#section1312121216216) -- [Repositories Involved](#section1371113476307) - ## Introduction This subsystem provides the compilation and execution environment for programs developed with JavaScript, and C/C++, basic libraries that support the runtime, and the runtime-associated APIs, compilers, and auxiliary tools. Modules in this subsystem are classified based on the currently supported programming languages: JavaScript, and C/C++. Each module can be compiled independently and can be combined and separated based on development scenarios. diff --git a/en/readme/startup.md b/en/readme/startup.md index a00656ba5ce7ec19d4d92b0595b3e6e4eeb21dbb..f7f088d2b534e423e0b2a7c66c55e88c6804ca7b 100644 --- a/en/readme/startup.md +++ b/en/readme/startup.md @@ -1,11 +1,5 @@ # Startup -- [Introduction](#section11660541593) -- [Directory Structure](#section161941989596) -- [Constraints](#section1718733212019) -- [Usage Guidelines](#section8533192617117) -- [Repositories Involved](#section1371113476307) - ## Introduction The Startup subsystem provides the functions of starting key system processes and services after the kernel is started and before applications are started, and restoring the system to factory settings. The subsystem consists of the following modules: diff --git a/en/readme/subsys-user-iam.md b/en/readme/subsys-user-iam.md index 82b044425f267ae3db616e688495c7215d16605e..60150d52f090ecdc8f27cc8da47b5a6972de9aea 100644 --- a/en/readme/subsys-user-iam.md +++ b/en/readme/subsys-user-iam.md @@ -1,13 +1,5 @@ # User IAM Subsystem -- [Introduction](#Introduction) -- [Directory Structure](#Directory-Structure) -- [Constraints](#Constraints) -- [Usage](#Usage) - - [How to Use](#How-to-Use) -- [Repositories Involved](#Repositories-Involved) - - ## Introduction The user identity and access management (IAM) subsystem provides a unified framework for user credential management and user identity authentication in OpenHarmony. It allows multiple users to set their own authentication credential information and authenticates their identities based on the information set. This subsystem is widely used in security-sensitive scenarios such as screen lock. The subsystem also provides APIs for third-party developers to call the identity authentication capabilities to control user access. diff --git a/en/readme/system-apps.md b/en/readme/system-apps.md index 8eb4b367960abdaca548e11e7897e9ac760c3c1e..2056f765c26ad1af3e80170aa8f3c237c2ad3919 100644 --- a/en/readme/system-apps.md +++ b/en/readme/system-apps.md @@ -1,9 +1,5 @@ # System Apps -- [Introduction](#section663544819225) -- [Directory Structure](#section161941989596) -- [Repositories Involved](#section1371113476307) - ## Introduction This module provides some system apps that are applicable to the OpenHarmony standard system, such as Launcher, SystemUI, and Settings. It also provides specific examples for you to build standard-system apps, which can be installed on all devices running the standard system. diff --git a/en/readme/telephony.md b/en/readme/telephony.md index aadba8cbd1a8dab036321be62a6daa6e2a768cb9..fc9c61caf189ba04613d9658ae1050b7b69f043a 100755 --- a/en/readme/telephony.md +++ b/en/readme/telephony.md @@ -1,14 +1,5 @@ # Telephony -- [Introduction](#section104mcpsimp) -- [Directory Structure](#section119mcpsimp) -- [Constraints](#section123mcpsimp) -- [Usage Guidelines](#section128mcpsimp) - - [Obtaining Current Cellular Network Signal Information](#section1458213210369) - - [Observing Cellular Network Status Changes](#section750135512369) - -- [Repositories Involved](#section152mcpsimp) - ## Introduction The Telephony subsystem provides APIs for obtaining information about the wireless cellular network and SIM card. Applications can call these APIs to obtain information such as the name of the currently registered network, network service status, signal strength, and SIM card information. diff --git a/en/readme/testing.md b/en/readme/testing.md index 33ccb2affe80c0f7088c3a080d06baa9e7fc9e46..e4f0f517b816bb896436a300a0a7bb50172493da 100755 --- a/en/readme/testing.md +++ b/en/readme/testing.md @@ -1,14 +1,5 @@ # Testing -- [Overview](#section7375710115617) -- [Directory Structure](#section102031353175317) -- [Constraints](#section87444710110) -- [Installation](#section1347156474) -- [Test Cases](#section125411936102918) -- [Test Framework Usage](#section75882026185016) -- [Test Result and Logs](#section414715805819) -- [Repositories Involved](#section6299103515474) - ## Overview The test-driven development mode is used during the development process. You can develop new cases or modify existing cases to test new or enhanced system features. The test helps you develop high-quality code in the development phase. diff --git a/en/readme/update.md b/en/readme/update.md index 06631d0ef049dfafd364eedafb4a9ea05197687c..062f0dbbd9de6ad5cb7c2836c524f71c52fd297b 100755 --- a/en/readme/update.md +++ b/en/readme/update.md @@ -1,9 +1,5 @@ # Update -- [Introduction](#section184mcpsimp) -- [Directory Structure](#section212mcpsimp) -- [Repositories Involved](#section251mcpsimp) - ## Introduction The Update subsystem helps you implement over the air \(OTA\) update of OpenHarmony devices. The update subsystem consists of the following: diff --git a/en/readme/utils.md b/en/readme/utils.md index 81b7ad9fa1879e97917f4a9b6274a89fcf072860..2bee01c92d43f43545434f63a47118fef40475b9 100644 --- a/en/readme/utils.md +++ b/en/readme/utils.md @@ -1,10 +1,5 @@ # utils -- [Introduction](#section11660541593) -- [Directory Structure](#section17271017133915) -- [Usage](#section137421544135015) -- [Repositories Involved](#section1249817110914) - ## Introduction The **utils** repository provides ndk_libraries_config and system functions. diff --git a/en/readme/x-test-suite.md b/en/readme/x-test-suite.md index 24396f880e05a6ed78dfcb41c8a78660ad469317..2713e49709d2fb66e3f5379a14455985199d587c 100755 --- a/en/readme/x-test-suite.md +++ b/en/readme/x-test-suite.md @@ -1,19 +1,5 @@ # XTS -- [Introduction](#section465982318513) -- [System Types](#section125090457443) -- [Directory Structure](#section161941989596) -- [Constraints](#section119744591305) -- [Usage Guidelines](#section137768191623) -- [Test Case Development Guidelines](#section3695134065513) - - [C-based Test Case Development and Compilation \(for the Mini System\)](#section198193336544) - - [C-based Test Case Execution \(for the Mini System\)](#section13820233175418) - - [C++-based Test Case Development and Compilation \(for Standard and Small Systems\)](#section3822123311540) - - [C++-based Test Case Execution \(for Standard and Small Systems\)](#section128222336544) - - [JavaScript-based Test Case Development \(for the Standard System\)](#section159801435165220) - - [JavaScript-based Test Case Packaging \(for the Standard System\)](#section445519106559) - - ## Introduction The X test suite \(XTS\) subsystem contains a set of OpenHarmony certification test suites, including the currently supported application compatibility test suite \(ACTS\) and the device compatibility test suite \(DCTS\) that will be supported in the future. diff --git a/en/release-notes/OpenHarmony-1-0.md b/en/release-notes/OpenHarmony-1-0.md index 70e62de62c8e88b1e139c3d26eb4d40bb2180c41..158ce20ed259cc583f16567db144b48d432d0a6f 100644 --- a/en/release-notes/OpenHarmony-1-0.md +++ b/en/release-notes/OpenHarmony-1-0.md @@ -1,11 +1,5 @@ # OpenHarmony 1.0 \(2020-09-10\) -- [Overview](#section249611124916) -- [Source Code Acquisition](#section127301717165113) - - [Acquiring Source Code from Mirrors](#section157648475298) - - [Acquiring Source Code Using the repo Tool](#section49746186307) - - ## Overview This is the initial release for this product. diff --git a/en/release-notes/OpenHarmony-1-1-0-LTS.md b/en/release-notes/OpenHarmony-1-1-0-LTS.md index 0facab54b49175990e76de35fddb6a0d392b2984..24d9a1854a0450a00249afe6e4ab35f3da42b758 100644 --- a/en/release-notes/OpenHarmony-1-1-0-LTS.md +++ b/en/release-notes/OpenHarmony-1-1-0-LTS.md @@ -1,12 +1,5 @@ # OpenHarmony 1.1.0 LTS \(2021-04-01\) -- [Overview](#section1846294912228) -- [Source Code Acquisition](#section84808293211) - - [Acquiring Source Code from Mirrors](#section8394142222113) - - [Acquiring Source Code Using the repo Tool](#section7180193542317) -- [What's New](#section175225345334) -- [Resolved Issues](#section11935243172612) - ## Overview This is the first long-term support \(LTS\) version of OpenHarmony. It supports more functions and fixes some bugs in OpenHarmony 1.0. diff --git a/en/release-notes/OpenHarmony-1-1-1-LTS.md b/en/release-notes/OpenHarmony-1-1-1-LTS.md index 6df8da4b7c62d506bd96805d0628db727fe4f04b..aac5017f810e6bed67a94079b98863e26be4b7bf 100644 --- a/en/release-notes/OpenHarmony-1-1-1-LTS.md +++ b/en/release-notes/OpenHarmony-1-1-1-LTS.md @@ -1,12 +1,5 @@ # OpenHarmony 1.1.1 LTS \(2021-06-22\) -- [Version Description](#section1846294912228) -- [Source Code Acquisition](#section84808293211) - - [Acquiring Source Code from Mirrors](#section8394142222113) - - [Acquiring Source Code Using the repo Tool](#section7180193542317) - -- [What's New](#section175225345334) - ## Version Description This is an updated long-term support \(LTS\) version of OpenHarmony. It supports more functions and fixes some bugs in OpenHarmony 1.1.0. diff --git a/en/release-notes/OpenHarmony-2-0-canary.md b/en/release-notes/OpenHarmony-2-0-canary.md index 3b4051aa5c23de22fcc6456b0ecb2747709a444f..4b366d447874c9623d2a9c9251df4ea5fdc2070d 100644 --- a/en/release-notes/OpenHarmony-2-0-canary.md +++ b/en/release-notes/OpenHarmony-2-0-canary.md @@ -1,9 +1,5 @@ # OpenHarmony 2.0 Canary \(2021-06-02\) -- [Version Description](#section1677664815431) -- [Version Mapping](#section13201781528) -- [What's New](#section11256141314463) - ## Version Description On the basis of OpenHarmony 1.1.0, OpenHarmony 2.0 adds the version for the standard system, which delivers the following functions: diff --git a/en/release-notes/OpenHarmony-v1-1-3-LTS.md b/en/release-notes/OpenHarmony-v1-1-3-LTS.md index 902bcdc756864f9fee893f44f18a53dc39bfd675..a30cdb207b0749bc0e1ed53b210383672e281f1b 100644 --- a/en/release-notes/OpenHarmony-v1-1-3-LTS.md +++ b/en/release-notes/OpenHarmony-v1-1-3-LTS.md @@ -1,13 +1,5 @@ # OpenHarmony v1.1.3 LTS -- [Overview](#section1846294912228) -- [Version Mapping](#section395983762117) -- [Source Code Acquisition](#section84808293211) - - [Acquiring Source Code Using the repo Tool](#section8394142222114) - - [Acquiring Source Code from Mirrors](#section8394142222113) -- [What's New](#section175225345334) -- [Resolved Issues](#section11935243172612) - ## Overview This is an updated long-term support \(LTS\) version of OpenHarmony. It supports more functions than and fixes some bugs in OpenHarmony 1.1.2. diff --git a/en/release-notes/OpenHarmony-v1.1.2-LTS.md b/en/release-notes/OpenHarmony-v1.1.2-LTS.md index d5c5fb1b51bc56836e21f51337cf7c85e67386ca..a0ab3c229fd859cc89c4e47d1b7d4e171b5e28eb 100644 --- a/en/release-notes/OpenHarmony-v1.1.2-LTS.md +++ b/en/release-notes/OpenHarmony-v1.1.2-LTS.md @@ -1,14 +1,5 @@ # OpenHarmony v1.1.2 LTS -- [Overview](#section1846294912228) -- [Version Mapping](#section395983762117) -- [Source Code Acquisition](#section84808293211) - - [Acquiring Source Code from Mirrors](#section8394142222113) - - [Acquiring Source Code Using the repo Tool](#section7180193542317) - -- [What's New](#section175225345334) -- [Resolved Issues](#section11935243172612) - ## Overview This is an updated long-term support \(LTS\) version of OpenHarmony. It supports more functions and fixes some bugs in OpenHarmony 1.1.1. diff --git a/en/release-notes/OpenHarmony-v2.2-beta2.md b/en/release-notes/OpenHarmony-v2.2-beta2.md index 17ee81a9b0952b721119c7958f640ee83c891aab..466a8ed52cd670d69c64f00928295fd74fc58a47 100644 --- a/en/release-notes/OpenHarmony-v2.2-beta2.md +++ b/en/release-notes/OpenHarmony-v2.2-beta2.md @@ -1,11 +1,5 @@ # OpenHarmony v2.2 Beta2 -- [Version Description](#section1677664815431) -- [Version Mapping](#section13201781528) -- [Source Code Acquisition](#section1350215462116) -- [What's New](#section11256141314463) -- [Resolved Issues](#section3442123281619) - ## Version Description This release provides new and enhanced features for the mini system, small system, and standard system based on OpenHarmony 2.0 Canary. diff --git a/en/release-notes/OpenHarmony-v3.0-LTS.md b/en/release-notes/OpenHarmony-v3.0-LTS.md index 882a9f7f84c4d4abba3019c264ab44c1072fb945..7db0fb909f89c9268f59694a2cb64958e7493390 100644 --- a/en/release-notes/OpenHarmony-v3.0-LTS.md +++ b/en/release-notes/OpenHarmony-v3.0-LTS.md @@ -1,15 +1,5 @@ # OpenHarmony 3.0 LTS -- [Version Description](#Version-Description) -- [Version Mapping](#Version-Mapping) -- [Source Code Acquisition](#Source-Code-Acquisition) -- [What's New](#What-Is-New) - - [Feature Updates](#Feature-Updates) - - [API Updates](#API-Updates) - - [Chip and Development Board Adaptation](#Chip-and-Development-Board-Adaptation) -- [Resolved Issues](#Resolved-Issues) -- [Known Issues](#Known-Issues) - ## Version Description This version has updates for the standard system, mini system, and small system on the basis of OpenHarmony 2.2 Beta2. diff --git a/en/release-notes/OpenHarmony-v3.1-beta.md b/en/release-notes/OpenHarmony-v3.1-beta.md index 377dc81bd922359672c9b5b73ad7168d80ea5eeb..1d120d7ce6282bcbddeb90f3a6f05d21afbc3a18 100644 --- a/en/release-notes/OpenHarmony-v3.1-beta.md +++ b/en/release-notes/OpenHarmony-v3.1-beta.md @@ -1,21 +1,5 @@ # OpenHarmony 3.1 Beta -- [Version Description](#Version-Description) -- [Version Mapping](#Version-Mapping) -- [Source Code Acquisition](#Source-Code-Acquisition) - - [Acquiring Source Code Using the repo Tool](#Acquiring-Source-Code-Using-the-repo-Tool) - - [Acquiring Source Code from Mirrors](#Acquiring-Source-Code-from-Mirrors) -- [What's New](#What-Is-New) - - [Feature Updates](#Feature-Updates) - - [API Updates](#API-Updates) - - [Chip and Development Board Adaptation](#Chip-and-Development-Board-Adaptation) - - [Samples & Codelabs](#samples-amp-codelabs) - - [New Samples](#New-Samples) - - [New Codelabs](#New-Codelabs) -- [Resolved Issues](#Resolved-Issues) -- [Known Issues](#Known-Issues) - - ## Version Description OpenHarmony 3.1 Beta provides the following enhancements over OpenHarmony 3.0 LTS: diff --git a/zh-cn/contribute/FAQ.md b/zh-cn/contribute/FAQ.md index fa3b741bae636fe4eddca28f59a533112c425533..4c75f95e3a738c36a6287dc5faa7c3c649d65646 100755 --- a/zh-cn/contribute/FAQ.md +++ b/zh-cn/contribute/FAQ.md @@ -1,15 +1,5 @@ # FAQ -[多个代码仓存在编译依赖时如何同时发起构建](#section169732563435) - -[ `Signed-off-by`相关操作](#section-signed-off) - -[DCO校验异常处理](#section-dco) - -[回退提交](#section479422315253) - -[处理冲突](#section94417232274) - ## 多个代码仓存在编译依赖时如何同时发起构建 diff --git a/zh-cn/contribute/template/README-template.md b/zh-cn/contribute/template/README-template.md index 1b019fd044e2fe54da26ffefe4fa365759dda8ff..0d87ac700824089f89cc7ad300011fcf202c0318 100644 --- a/zh-cn/contribute/template/README-template.md +++ b/zh-cn/contribute/template/README-template.md @@ -1,14 +1,5 @@ # xxx子系统/部件 -- [简介](#简介) -- [目录](#目录) -- [约束](#约束) -- [编译构建](#编译构建) -- [说明](#说明) - - [接口说明](#接口说明) - - [使用说明](#使用说明) -- [Changelog](#changelog) -- [相关仓](#相关仓) 【标题说明】根据当前Readme的类型，使用 **子系统**或者 **部件**。 diff --git "a/zh-cn/contribute/\350\264\241\347\214\256\346\265\201\347\250\213.md" "b/zh-cn/contribute/\350\264\241\347\214\256\346\265\201\347\250\213.md" index 85079be0a6f29ca380aa4998617fede308a30ff4..c874beef6347925bcbf81456add00264b4cb8c4f 100755 --- "a/zh-cn/contribute/\350\264\241\347\214\256\346\265\201\347\250\213.md" +++ "b/zh-cn/contribute/\350\264\241\347\214\256\346\265\201\347\250\213.md" @@ -1,13 +1,5 @@ # 贡献流程 -- [环境准备](#section124971410183614) -- [代码下载](#section6125202333611) -- [代码提交](#section338918220422) -- [创建Pull Request（如已通过repo工具自动创建PR，则此步忽略）](#section28261522124316) -- [门禁构建](#section981124754415) -- [CI门户](#section8563257123985) -- [代码审查](#section17823849145014) - ## 环境准备 - 针对Git的安装、环境配置及使用方法，请参考码云帮助中心的Git知识大全：[https://gitee.com/help/categories/43](https://gitee.com/help/categories/43)