From 3b79b1c745b0c57357efd7626085deae84993b17 Mon Sep 17 00:00:00 2001 From: shawn_he Date: Fri, 5 Aug 2022 15:35:05 +0800 Subject: [PATCH] update doc Signed-off-by: shawn_he --- .../subsystems/subsys-boot-init-jobs.md | 6 +++--- .../subsystems/subsys-boot-init-sandbox.md | 5 +++-- .../subsystems/subsys-boot-init-service.md | 20 +++++++++---------- .../subsystems/subsys-boot-init-sysparam.md | 10 +++++----- 4 files changed, 21 insertions(+), 20 deletions(-) diff --git a/en/device-dev/subsystems/subsys-boot-init-jobs.md b/en/device-dev/subsystems/subsys-boot-init-jobs.md index aec295f723..8bbbc1a8c0 100644 --- a/en/device-dev/subsystems/subsys-boot-init-jobs.md +++ b/en/device-dev/subsystems/subsys-boot-init-jobs.md @@ -126,7 +126,7 @@ A job is a command set, where you can manage the commands to be executed. A maxi export key value
Example:
export TEST /data/test - Sets environment variables. key and value respectively indicate the environment variable and its value. + Sets environment variables. key and value respectively indicate the environment variable and its value. Small and standard systems @@ -210,7 +210,7 @@ A job is a command set, where you can manage the commands to be executed. A maxi reboot subsystem
Example:
reboot updater - Restarts the system. subsystem is optional. If it is not specified, the device enters the current system upon restarting. If it is specified, the device enters the corresponding subsystem upon restarting. For example, if you run reboot updater, the device enters the updater subsystem upon restarting. + Restarts the system. subsystem is optional. If it is not specified, the device enters the current system upon restarting. If it is specified, the device enters the corresponding subsystem upon restarting. For example, if you run reboot updater, the device enters the updater subsystem upon restarting. Small and standard systems @@ -224,7 +224,7 @@ A job is a command set, where you can manage the commands to be executed. A maxi sleep time
Example:
sleep 5 - Enters the sleep mode. time indicates the sleep time.
To avoid impact on services, exercise caution when running this command. + Enters the sleep mode. time indicates the sleep time.
To avoid impact on services, exercise caution when running this command. Small and standard systems diff --git a/en/device-dev/subsystems/subsys-boot-init-sandbox.md b/en/device-dev/subsystems/subsys-boot-init-sandbox.md index 9be5ba7d3b..dc195b4926 100644 --- a/en/device-dev/subsystems/subsys-boot-init-sandbox.md +++ b/en/device-dev/subsystems/subsys-boot-init-sandbox.md @@ -4,8 +4,9 @@ ### Function OpenHarmony supports two types of sandbox, namely, system sandbox and chipset sandbox. -### Basic Concepts -The system sandbox and chipset sandbox are created in the init module. Native services choose to enter the system sandbox or chipset sandbox based on their functions. Sandbox components can be isolated through the **mount** attribute if **mount-bind-paths** or **mount-bind-files** is set for them in configuration files such as **system-sandbox.json** and **chipset-sandbox.json**. In addition, a sandbox debugging tool is provided to facilitate sandbox debugging, verification, and optimization. For details about commands, see [Description of begetctl Commands](subsys-boot-init-plugin.md#parameters). +The system sandbox and chipset sandbox are created in the init module. Native services choose to enter the system sandbox or chipset sandbox based on their functions. + +Sandbox components can be isolated through the **mount** attribute if **mount-bind-paths** or **mount-bind-files** is set for them in configuration files such as **system-sandbox.json** and **chipset-sandbox.json**. In addition, a sandbox debugging tool is provided to facilitate sandbox debugging, verification, and optimization. For details about commands, see [Description of begetctl Commands](subsys-boot-init-plugin.md#parameters). ### Constraints diff --git a/en/device-dev/subsystems/subsys-boot-init-service.md b/en/device-dev/subsystems/subsys-boot-init-service.md index c527a18303..44a3927654 100644 --- a/en/device-dev/subsystems/subsys-boot-init-service.md +++ b/en/device-dev/subsystems/subsys-boot-init-service.md @@ -196,8 +196,8 @@ By parsing the *.cfg file, you can obtain **service** fields, a Whether the current service process is a one-off process. - **1**: The current service process is a one-off process. If the process exits, the init process does not restart it.
- **0**: The current service process is not a one-off process. If the process exits, the init process restarts it upon receiving the SIGCHLD signal. + 1: The current service process is a one-off process. If the process exits, the init process does not restart it.
+ 0: The current service process is not a one-off process. If the process exits, the init process restarts it upon receiving the SIGCHLD signal. Small and standard systems @@ -212,7 +212,7 @@ By parsing the *.cfg file, you can obtain **service** fields, a Standard system: The service priority ranges from -20 to 19. A value beyond the range is invalid.
- Small system: The value **0** indicates an unimportant process and a value greater than **0** indicates an important process. + Small system: The value 0 indicates an unimportant process and a value greater than 0 indicates an important process. Small and standard systems @@ -240,8 +240,8 @@ By parsing the *.cfg file, you can obtain **service** fields, a Suppression mechanism for services. If the number of times a service is restarted exceeds the value N within the specified period T, the system will be restarted. - Standard system:
Type: int array, for example, "critical": [M, N, T].
- **M**: enable flag (**0**: disable; **1**: enable).
- **N**: number of times the service is started.
- **T**: period of time, in seconds.
Both **M** and **N** are greater than **0**.
- Small and standard systems:
Type: int, for example, "critical": M.
**M**: enable flag (**0**: disable; **1**: enable).
By default, **N** is **4** and **T** is **20**. + Standard system:
Type: int array, for example, "critical": [M, N, T].
- M: enable flag (0: disable; 1: enable).
- N: number of times the service is started.
- T: period of time, in seconds.
Both M and N are greater than 0.
+ Small and standard systems:
Type: int, for example, "critical": M.
M: enable flag (0: disable; 1: enable).
By default, N is 4 and T is 20. Standard system @@ -255,7 +255,7 @@ By parsing the *.cfg file, you can obtain **service** fields, a Number of CPU cores bound to the service. - Type: int array, for example, "cpucore": [N1, N2, ...]. **N1** and **N2** indicate the indices of the CPU cores to be bound. For a single-core device, **cpucore** is **0**. + Type: int array, for example, "cpucore": [N1, N2, ...]. N1 and N2 indicate the indices of the CPU cores to be bound. For a single-core device, cpucore is 0. Standard system @@ -283,7 +283,7 @@ By parsing the *.cfg file, you can obtain **service** fields, a Ability privilege level (for standard system or higher). - Type: string, for example, "apl": "system_core". The value can be **system_core** (default), **normal**, or **system_basic**. + Type: string, for example, "apl": "system_core". The value can be system_core (default), normal, or system_basic. Standard system @@ -297,7 +297,7 @@ By parsing the *.cfg file, you can obtain **service** fields, a Service startup mode (for standard system or higher). - Type: string, for example, "start-mode": "condition". The value can be **boot**, **normal**, or **condition**. For details, see init Service Startup Control. + Type: string, for example, "start-mode": "condition". The value can be boot, normal, or condition. For details, see init Service Startup Control. Standard system @@ -339,8 +339,8 @@ By parsing the *.cfg file, you can obtain **service** fields, a Whether the sandbox function is enabled. - **1** (default): Enable the sandbox function. - **0**: Disable the sandbox function. + 1 (default): Enable the sandbox function.
+ 0: Disable the sandbox function. Standard system diff --git a/en/device-dev/subsystems/subsys-boot-init-sysparam.md b/en/device-dev/subsystems/subsys-boot-init-sysparam.md index 501563aac3..ef97570ec6 100644 --- a/en/device-dev/subsystems/subsys-boot-init-sysparam.md +++ b/en/device-dev/subsystems/subsys-boot-init-sysparam.md @@ -26,10 +26,10 @@ Figure 1 System parameter operation primitives **Table 2** System parameter names - | Type| Name| Example| Description| - | -------- | -------- | -------- | -------- | - | Name| Parameter Name | const.product.**name** | Complete system parameter name. It does not end with a period (.). | - | Directory| Parameter Directory | const.product **.** | Name of the directory storing system parameters with the same prefix. It ends with a period (.).| + | Type | Example | Description | + | -------- | -------- | -------- | + | Parameter name | const.product.**name** | Complete system parameter name. It does not end with a period (.). | + | Parameter directory | const.product **.** | Name of the directory storing system parameters with the same prefix. It ends with a period (.).| - Type @@ -132,7 +132,7 @@ You can set specific system parameters as needed to meet your service demand. | -------- | -------- | | param get [**key**] | Obtains the system parameter value of the specified key. If no key name is specified, all system parameter values will be returned.| | param set **key value** | Sets the specified value for the specified key.| - | param wait **key** **value** | Waits for the system parameter value of the specified key to match the specified value. Fuzzy match is supported. For example, * indicates any value, and val* indicates matching of only the first three val characters.| + | param wait **key** **value** | Waits for the system parameter value of the specified key to match the specified value. Fuzzy match is supported. For example, * indicates any value, and val* indicates matching of only the first three val characters.| | param watch | Observes value change of a system parameter asynchronously.| - syspara APIs -- GitLab