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

!3787 更正文档中的错误链接

Merge pull request !3787 from wusongqing/E0509
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
> >
> The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version. > The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.
> >
> The APIs of API version 9 is of the Canary version and are for trial use only. The API call may be unstable. > The APIs of API version 9 are of the canary version and are for trial use only. The API call may be unstable.
## Modules to Import ## Modules to Import
......
...@@ -127,9 +127,9 @@ zlib.unzipFile(inFile, outFile, options).then((data) => { ...@@ -127,9 +127,9 @@ zlib.unzipFile(inFile, outFile, options).then((data) => {
| Name | Description | | Name | Description |
| --------------------------- | ------------------------------------------------------------ | | --------------------------- | ------------------------------------------------------------ |
| level?: CompressLeve | See [zip.CompressLevel](#zip.CompressLevel).| | level?: CompressLeve | See [zip.CompressLevel](#zipcompresslevel). |
| memLevel?: MemLevel | See [zip.MemLevel](#zip.MemLevel) | | memLevel?: MemLevel | See [zip.MemLevel](#zipmemlevel) |
| strategy?: CompressStrategy | See [zip.CompressStrategy](#zip.CompressStrategy)| | strategy?: CompressStrategy | See [zip.CompressStrategy](#zipcompressstrategy) |
## zip.MemLevel ## zip.MemLevel
......
...@@ -6,6 +6,7 @@ ...@@ -6,6 +6,7 @@
You can search for common development resources on [DevEco Marketplace](https://repo.harmonyos.com) and import required resources to your projects through dependencies. If you cannot find the desired resources there, develop the resources on your own and publish them in the form of an HPM Part. To develop HPM Parts, install the hpm-cli tool first. You can search for common development resources on [DevEco Marketplace](https://repo.harmonyos.com) and import required resources to your projects through dependencies. If you cannot find the desired resources there, develop the resources on your own and publish them in the form of an HPM Part. To develop HPM Parts, install the hpm-cli tool first.
> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** > ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
>
> You are advised to perform the following operations on Ubuntu 18.04 or later. > You are advised to perform the following operations on Ubuntu 18.04 or later.
...@@ -17,24 +18,25 @@ The hpm-cli tool is developed based on Node.js. Therefore, you must install Node ...@@ -17,24 +18,25 @@ The hpm-cli tool is developed based on Node.js. Therefore, you must install Node
### Installing Node.js and hpm-cli ### Installing Node.js and hpm-cli
1. Install Node.js. 1. Install Node.js.
Download Node.js from its official website and install it on your local PC.
Download Node.js from its official website and install it on your local PC.
You are advised to install the latest LTS version (not earlier than 12.x) of [Node.js](https://nodejs.org/).
You are advised to install the latest LTS version (not earlier than 12.x) of [Node.js](https://nodejs.org/).
2. Install the hpm-cli tool using **npm** delivered with **Node.js**. Run the following command: 2. Install the hpm-cli tool using **npm** delivered with **Node.js**. Run the following command:
``` ```
npm install -g @ohos/hpm-cli npm install -g @ohos/hpm-cli
``` ```
3. Run the following command to check whether the installation is successful. If a hpm version is displayed, the installation is successful. 3. Run the following command to check whether the installation is successful. If a hpm version is displayed, the installation is successful.
``` ```
hpm -V or hpm --version hpm -V or hpm --version
``` ```
4. (Optional) Run the following command to update the hpm version if needed: 4. (Optional) Run the following command to update the hpm version if needed:
``` ```
npm update -g @ohos/hpm-cli npm update -g @ohos/hpm-cli
``` ```
...@@ -44,13 +46,13 @@ The hpm-cli tool is developed based on Node.js. Therefore, you must install Node ...@@ -44,13 +46,13 @@ The hpm-cli tool is developed based on Node.js. Therefore, you must install Node
After hpm-cli is installed, run the following command to view the hpm configuration: After hpm-cli is installed, run the following command to view the hpm configuration:
``` ```
hpm config hpm config
``` ```
The default hpm configuration is displayed upon successful command execution. You can modify the default configuration as required. The following lists the common hpm configuration: The default hpm configuration is displayed upon successful command execution. You can modify the default configuration as required. The following lists the common hpm configuration:
``` ```
registry = https://hpm.harmonyos.com registry = https://hpm.harmonyos.com
### login Settings ### login Settings
...@@ -82,16 +84,17 @@ You can create an HPM Part by using a template or define an existing project as ...@@ -82,16 +84,17 @@ You can create an HPM Part by using a template or define an existing project as
### Creating an HPM Part Using a Template ### Creating an HPM Part Using a Template
1. Run the following command to create a directory: 1. Run the following command to create a directory:
``` ```
hpm init -t default mybundle hpm init -t default mybundle
``` ```
> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** > ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
> -In the preceding command, **default** indicates that the **default** template is used. You can use another template such as **simple** or **dist**. >
> In the preceding command, **default** indicates that the **default** template is used. You can use another template such as **simple** or **dist**.
The generated directory structure is as follows: The generated directory structure is as follows:
``` ```
/ /
├── headers # Header file (example) ├── headers # Header file (example)
...@@ -103,10 +106,10 @@ You can create an HPM Part by using a template or define an existing project as ...@@ -103,10 +106,10 @@ You can create an HPM Part by using a template or define an existing project as
└── Makefile # Build description file (example) └── Makefile # Build description file (example)
└── README.md # Readme file └── README.md # Readme file
``` ```
2. Write the code and build script of the HPM Part. 2. Write the code and build script of the HPM Part.
``` ```
hpm init -t {templatename} -d {dir} {name} hpm init -t {templatename} -d {dir} {name}
``` ```
...@@ -120,14 +123,14 @@ You can create an HPM Part by using a template or define an existing project as ...@@ -120,14 +123,14 @@ You can create an HPM Part by using a template or define an existing project as
The hpm-cli tool provides a few default templates. More templates are available on [DevEco Marketplace](https://repo.harmonyos.com). You can run the **hpm search -t template** command to search for a template stored on [DevEco Marketplace](https://repo.harmonyos.com). The hpm-cli tool provides a few default templates. More templates are available on [DevEco Marketplace](https://repo.harmonyos.com). You can run the **hpm search -t template** command to search for a template stored on [DevEco Marketplace](https://repo.harmonyos.com).
![zh-cn_image_0000001217486680](figures/zh-cn_image_0000001217486680.png) ![en-us_image_0000001217486680](figures/en-us_image_0000001217486680.png)
### Defining an Existing Project as an HPM Part ### Defining an Existing Project as an HPM Part
If you have a code project and need to distribute it on the HPM platform, run the following command in the project directory, for example, **mybundle2**: If you have a code project and need to distribute it on the HPM platform, run the following command in the project directory, for example, **mybundle2**:
``` ```
hpm init hpm init
``` ```
...@@ -137,7 +140,7 @@ hpm init ...@@ -137,7 +140,7 @@ hpm init
2. Enter the version and description. A **bundle.json** file will be generated in the current directory. 2. Enter the version and description. A **bundle.json** file will be generated in the current directory.
3. Open the **bundle.json** file. 3. Open the **bundle.json** file.
``` ```
$ hpm init $ hpm init
Your bundle will be created in directory ~\demo\mybundle2 Your bundle will be created in directory ~\demo\mybundle2
...@@ -148,7 +151,7 @@ hpm init ...@@ -148,7 +151,7 @@ hpm init
``` ```
4. Modify other information (such as the author, code repository, code directories, scripts, and dependencies) in **bundle.json**. An example is shown below: 4. Modify other information (such as the author, code repository, code directories, scripts, and dependencies) in **bundle.json**. An example is shown below:
``` ```
{ {
"name": "mybundle2", "name": "mybundle2",
...@@ -177,7 +180,7 @@ In the distribution metadata file, define the dependent HPM Parts and how to bui ...@@ -177,7 +180,7 @@ In the distribution metadata file, define the dependent HPM Parts and how to bui
The following uses the **bundle.json** file as an example. In this example, the **dist** command uses the **hb** framework. The following uses the **bundle.json** file as an example. In this example, the **dist** command uses the **hb** framework.
``` ```
{ {
"name": "@your/dist_name", "name": "@your/dist_name",
...@@ -225,7 +228,7 @@ The hpm-cli tool supports command integration so that you can select any build t ...@@ -225,7 +228,7 @@ The hpm-cli tool supports command integration so that you can select any build t
This section describes how to build an executable file named **helloworld** in the **app** directory. This section describes how to build an executable file named **helloworld** in the **app** directory.
``` ```
app app
├── BUILD.gn ├── BUILD.gn
...@@ -237,7 +240,7 @@ app ...@@ -237,7 +240,7 @@ app
Create a **BUILD.gn** file in the same directory as **helloworld.c**. Create a **BUILD.gn** file in the same directory as **helloworld.c**.
``` ```
touch BUILD.gn touch BUILD.gn
vim BUILD.gn vim BUILD.gn
...@@ -245,7 +248,7 @@ vim BUILD.gn ...@@ -245,7 +248,7 @@ vim BUILD.gn
The following is an example of **BUILD.gn**: The following is an example of **BUILD.gn**:
``` ```
executable("hello_world") { executable("hello_world") {
sources = [ sources = [
...@@ -268,28 +271,28 @@ executable("hello_world") { ...@@ -268,28 +271,28 @@ executable("hello_world") {
Run the following command to start the build: Run the following command to start the build:
``` ```
hpm build hpm build
``` ```
After all build operations are complete, the message "build succeed" is displayed. You need to check the build result. After all build operations are complete, the message "build succeed" is displayed. You need to check the build result.
![zh-cn_image_0000001262166533](figures/zh-cn_image_0000001262166533.png) ![en-us_image_0000001262166533](figures/en-us_image_0000001262166533.png)
### Building an Image ### Building an Image
Run the following command in the root directory of the current distribution: Run the following command in the root directory of the current distribution:
``` ```
hpm dist hpm dist
``` ```
The hpm-cli tool automatically starts the build. After the build is complete, an image file will be generated, as shown below: The hpm-cli tool automatically starts the build. After the build is complete, an image file will be generated, as shown below:
``` ```
out out
|-xxdist.img |-xxdist.img
...@@ -303,7 +306,7 @@ To publish an HPM Part, you must obtain an account and create an organization (o ...@@ -303,7 +306,7 @@ To publish an HPM Part, you must obtain an account and create an organization (o
After that, generate a public key on the local PC based on your invitation code (which can be obtained on the **My profile** page on [DevEco Marketplace](https://repo.harmonyos.com)), and configure the public key on the **My profile** page. After that, generate a public key on the local PC based on your invitation code (which can be obtained on the **My profile** page on [DevEco Marketplace](https://repo.harmonyos.com)), and configure the public key on the **My profile** page.
``` ```
hpm config set loginUser {your-invitation-code} hpm config set loginUser {your-invitation-code}
hpm gen-keys hpm gen-keys
...@@ -315,7 +318,7 @@ Now you have the permission to publish HPM Parts in your organization. ...@@ -315,7 +318,7 @@ Now you have the permission to publish HPM Parts in your organization.
In the directory where the HPM Part is located, run the following command to pack and publish the HPM Part: In the directory where the HPM Part is located, run the following command to pack and publish the HPM Part:
``` ```
hpm publish hpm publish
``` ```
...@@ -346,13 +349,13 @@ Visit [DevEco Marketplace](https://repo.harmonyos.com), search for HPM Parts tha ...@@ -346,13 +349,13 @@ Visit [DevEco Marketplace](https://repo.harmonyos.com), search for HPM Parts tha
4. Run the **hpm build** command to perform build and output the build result. 4. Run the **hpm build** command to perform build and output the build result.
Run the following command in your project. Make sure that the project directory contains the **bundle.json** file. Run the following command in your project. Make sure that the project directory contains the **bundle.json** file.
``` ```
$ hpm install @scope/the_bundle $ hpm install @scope/the_bundle
``` ```
The referenced HPM Part will be installed under **ohos_bundle** in the directory where your project is located. The directory structure is as follows: The referenced HPM Part will be installed under **ohos_bundle** in the directory where your project is located. The directory structure is as follows:
``` ```
project project
├── ohos_bundle ├── ohos_bundle
...@@ -368,7 +371,7 @@ project ...@@ -368,7 +371,7 @@ project
Open the **bundle.json** file. You will see that the HPM Part has been introduced to the dependencies of your project. Open the **bundle.json** file. You will see that the HPM Part has been introduced to the dependencies of your project.
``` ```
{ {
"dependencies": { "dependencies": {
...@@ -379,7 +382,7 @@ Open the **bundle.json** file. You will see that the HPM Part has been introduce ...@@ -379,7 +382,7 @@ Open the **bundle.json** file. You will see that the HPM Part has been introduce
You can edit the dependencies of multiple HPM Parts in this file. You can edit the dependencies of multiple HPM Parts in this file.
``` ```
{ {
"dependencies": { "dependencies": {
...@@ -399,13 +402,13 @@ Run the **hpm install** command again to download and install all HPM Parts that ...@@ -399,13 +402,13 @@ Run the **hpm install** command again to download and install all HPM Parts that
If the referenced HPM Part is shared by multiple projects, for example, the compiler toolchain, you can install it globally. If the referenced HPM Part is shared by multiple projects, for example, the compiler toolchain, you can install it globally.
Run the following command in your project. Make sure that the project directory contains the **bundle.json** file. Run the following command in your project. Make sure that the project directory contains the **bundle.json** file.
``` ```
$ hpm install -g @scope/the_tool $ hpm install -g @scope/the_tool
``` ```
The referenced HPM Part will be installed in the directory specified by the **globalRepo** parameter of the **hpm config** command. The referenced HPM Part will be installed in the directory specified by the **globalRepo** parameter of the **hpm config** command.
``` ```
~\.hpm\global\ohos_bundles ~\.hpm\global\ohos_bundles
│ └── scope │ └── scope
...@@ -415,7 +418,7 @@ $ hpm install -g @scope/the_tool ...@@ -415,7 +418,7 @@ $ hpm install -g @scope/the_tool
> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** > ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
> - For an HPM Part installed in a project, you can reference it using the environment variable **DEP_SCOPE_bundle_name** when running the hpm build command. > - For an HPM Part installed in a project, you can reference it using the environment variable **DEP_SCOPE_bundle_name** when running the hpm build command.
> For example, after you run **hpm i \@opensource/gn** to install an HPM Part, edit the build script in the **bundle.json** file as follows: > For example, after you run **hpm i \@opensource/gn** to install an HPM Part, edit the build script in the **bundle.json** file as follows:
> >
> ``` > ```
> "scripts": { > "scripts": {
> "build": "${DEP_OPENSOURCE_gn}/gn --version" > "build": "${DEP_OPENSOURCE_gn}/gn --version"
...@@ -425,14 +428,14 @@ $ hpm install -g @scope/the_tool ...@@ -425,14 +428,14 @@ $ hpm install -g @scope/the_tool
> Then, you can run the **hpm build** command to call gn functions. > Then, you can run the **hpm build** command to call gn functions.
> >
> - For a globally installed HPM Part, you can directly call the HPM Part using an environment variable or reference the HPM Part using the **${key}/tool_name** parameter in the **hpm config set key value** command. Example: > - For a globally installed HPM Part, you can directly call the HPM Part using an environment variable or reference the HPM Part using the **${key}/tool_name** parameter in the **hpm config set key value** command. Example:
> >
> ``` > ```
> hpm i -g @ohos/opensource/gn > hpm i -g @ohos/opensource/gn
> hpm config BUILD_SYS_GN ~/.hpm/global/ohos_bundles/opensource/gn > hpm config BUILD_SYS_GN ~/.hpm/global/ohos_bundles/opensource/gn
> ``` > ```
> >
> You can edit the build script in the **bundle.json** file as follows: > You can edit the build script in the **bundle.json** file as follows:
> >
> ``` > ```
> "scripts": { > "scripts": {
> "build": "${BUILD_SYS_GN}/gn --version" > "build": "${BUILD_SYS_GN}/gn --version"
......
...@@ -53,7 +53,7 @@ ...@@ -53,7 +53,7 @@
- [Sensor Usage Guidelines](subsys-sensor-guide.md) - [Sensor Usage Guidelines](subsys-sensor-guide.md)
- [Sensor Usage Example](subsys-sensor-demo.md) - [Sensor Usage Example](subsys-sensor-demo.md)
- [USB](subsys-usbservice.md) - [USB](subsys-usbservice.md)
- [[USB Overview](subsys-usbservice-overview.md) - [USB Overview](subsys-usbservice-overview.md)
- [USB Usage Guidelines](subsys-usbservice-guide.md) - [USB Usage Guidelines](subsys-usbservice-guide.md)
- [USB Usage Example](subsys-usbservice-demo.md) - [USB Usage Example](subsys-usbservice-demo.md)
- [Application Framework](subsys-application-framework.md) - [Application Framework](subsys-application-framework.md)
...@@ -61,10 +61,10 @@ ...@@ -61,10 +61,10 @@
- [Setting Up a Development Environment](subsys-application-framework-envbuild.md) - [Setting Up a Development Environment](subsys-application-framework-envbuild.md)
- [Development Guidelines](subsys-application-framework-guide.md) - [Development Guidelines](subsys-application-framework-guide.md)
- [Development Example](subsys-application-framework-demo.md) - [Development Example](subsys-application-framework-demo.md)
- [OTA Upgrade](subsys-ota-guide.md) - [OTA Update](subsys-ota-guide.md)
- [Telephony Service ](subsys-tel.md) - [Telephony ](subsys-tel.md)
- [Telephony Service](telephony-service.md) - [Telephony Overview](subsys-tel-overview.md)
- [Development Guidelines](development-guidelines.md) - [Telephony Development](subsys-tel-guide.md)
- [Security](subsys-security.md) - [Security](subsys-security.md)
- [Overview](subsys-security-overview.md) - [Overview](subsys-security-overview.md)
- [Development on Application Signature Verification](subsys-security-sigverify.md) - [Development on Application Signature Verification](subsys-security-sigverify.md)
...@@ -80,7 +80,7 @@ ...@@ -80,7 +80,7 @@
- [syspara Module](subsys-boot-syspara.md) - [syspara Module](subsys-boot-syspara.md)
- [FAQs](subsys-boot-faqs.md) - [FAQs](subsys-boot-faqs.md)
- [Reference](subsys-boot-ref.md) - [Reference](subsys-boot-ref.md)
- [Testing](subsys-testguide-test.md) - [Test](subsys-testguide-test.md)
- [DFX](subsys-dfx.md) - [DFX](subsys-dfx.md)
- [DFX](subsys-dfx-overview.md) - [DFX](subsys-dfx-overview.md)
- [HiLog Development](subsys-dfx-hilog-rich.md) - [HiLog Development](subsys-dfx-hilog-rich.md)
......
# Subsystems # Telephony
- [Telephony Service](telephony-service.md) - [Telephony Overview](subsys-tel-overview.md)
- [Telephony Service](telephony-service.md) - [Telephony Development](subsys-tel-guide.md)
- [Development Guidelines](development-guidelines.md)
# Subsystem Development Guidelines<a name="EN-US_TOPIC_0000001111199452"></a> # Subsystem Development Guidelines<a name="EN-US_TOPIC_0000001111199452"></a>
- **[Compilation and Building](subsys-build.md)** - **[Compilation and Building](subsys-build.md)**
- **[Distributed Remote Startup](subsys-remote-start.md)** - **[Distributed Remote Startup](subsys-remote-start.md)**
- **[Graphics](subsys-graphics.md)** - **[Graphics](subsys-graphics.md)**
- **[Multimedia](subsys-multimedia.md)** - **[Multimedia](subsys-multimedia.md)**
- **[Data Management](subsys-data.md)** - **[Data Management](subsys-data.md)**
- **[Utils](subsys-utils.md)** - **[Utils](subsys-utils.md)**
- **[AI Framework](subsys-aiframework.md)** - **[AI Framework](subsys-aiframework.md)**
- **[Sensors](subsys-sensor.md)** - **[Sensors](subsys-sensor.md)**
- **[Application Framework](subsys-application-framework.md)** - **[Application Framework](subsys-application-framework.md)**
- **[OTA Update](subsys-ota-guide.md)**
- **[OTA Upgrade](subsys-ota-guide.md)** - **[Telephony](subsys-tel.md)**
- **[Security](subsys-security.md)** - **[Security](subsys-security.md)**
- **[Startup](subsys-boot.md)** - **[Startup](subsys-boot.md)**
- **[Test](subsys-testguide-test.md)**
- **[Testing](subsys-testguide-test.md)**
- **[DFX](subsys-dfx.md)** - **[DFX](subsys-dfx.md)**
- **[R&D Tools](subsys-toolchain.md)** - **[R&D Tools](subsys-toolchain.md)**
- **[XTS](subsys-xts-guide.md)** - **[XTS](subsys-xts-guide.md)**
...@@ -12,4 +12,5 @@ ...@@ -12,4 +12,5 @@
- **[调试验证](quickstart-ide-lite-steps-hi3861-debug.md)** - **[调试验证](quickstart-ide-lite-steps-hi3861-debug.md)**
- **[运行](quickstart-ide-lite-steps-hi3816-running.md)** - **[运行](quickstart-ide-lite-steps-hi3861-running.md)**
\ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册