From 77a839aac64811ed7e4857cc50999e14dc98de2e Mon Sep 17 00:00:00 2001
From: gongyuhang <gongyuhang7@huawei.com>
Date: Wed, 19 Apr 2023 18:00:47 +0800
Subject: [PATCH] Supplyment for ark_py_helper.md

Issue: https://gitee.com/ark_standalone_build/docs/issues/I6X764
Test: N/A
Signed-off-by: gongyuhang <gongyuhang7@huawei.com>
---
 ark_py_helper.md | 84 +++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 80 insertions(+), 4 deletions(-)

diff --git a/ark_py_helper.md b/ark_py_helper.md
index c18706e..3ac2d98 100644
--- a/ark_py_helper.md
+++ b/ark_py_helper.md
@@ -1,4 +1,80 @@
-编译脚本说明
-```
-python ark.py --help
-```
\ No newline at end of file
+# 编译脚本说明
+
+## 当宿主机器的操作系统为linux，宿主机器的架构为x64时
+1. 获取帮助
+    ```shell
+    python ark.py --help
+    ```
+
+2. 编译 运行于特定平台(os_cpu)的 特定模式(mode)的 【默认指定的】 目标产物。
+    - os_cpu:
+        - x64(linux_x64)
+        - arm(ohos_arm)
+        - arm64(ohos_arm64)
+        - mingw_x86_64
+        - android_arm64
+    - mode:
+        - release
+        - debug
+    ```shell
+    python ark.py ${os_cpu}.${mode}
+    python ark.py x64.release
+    python ark.py x64.debug
+    python ark.py arm64.release
+    python ark.py arm64.debug
+    ```
+    - 所生成目标产物位于：
+    ```
+    ./out/${os_cpu}.${mode}/${gn文件中目标产物相对路径}
+    ./out/${os_cpu}.${mode}/exe.unstripped/${gn文件中目标产物相对路径}
+    ./out/${os_cpu}.${mode}/lib.unstripped/${gn文件中目标产物相对路径}
+    ./out/${os_cpu}.${mode}/obj/${gn文件中目标产物相对路径}
+    ```
+
+3. 编译 运行于特定平台(os_cpu)的 特定模式(mode)的 【用户指定(target_name)的】 目标产物。
+    - target_name:
+        - ark_js_vm（gn文件中定义的ohos_executable）
+        - libark_jsruntime（gn文件中定义的ohos_shared_library）
+        - static_icuuc（gn文件中定义的ohos_static_library）
+        - libark_jsruntime_set（gn文件中定义的ohos_source_set）
+        - EcmaVm_001_Test（gn文件中定义的ohos_unittest）
+        - EcmaVm_001_TestAction（gn文件中定义的action，限host平台）
+        - ...
+    ```shell
+    python ark.py ${os_cpu}.${mode} ${target_name}
+    python ark.py x64.release ark_js_vm
+    python ark.py x64.release libark_jsruntime
+    python ark.py x64.release static_icuuc
+    python ark.py x64.release libark_jsruntime_set
+    python ark.py x64.release EcmaVm_001_Test
+    python ark.py x64.release EcmaVm_001_TestAction
+    python ark.py x64.debug ark_js_vm
+    python ark.py arm64.release ark_js_vm
+    python ark.py arm64.debug ark_js_vm
+    ```
+
+4. 编译并运行 测试相关的 目标产物（暂限host平台）。
+    - 编译 运行于x64（linux_x64）平台的 release模式的 【默认单元测试所依赖的】 目标产物，同时运行 目标产物中的可执行文件（暂限host平台）。
+    ```shell
+    python ark.py x64.release unittest
+    ```
+
+    - 编译 运行于x64（linux_x64）平台的 release模式的 【指定单元测试所依赖的】 目标产物，同时运行 目标产物中的可执行文件（暂限host平台）。
+    ```shell
+    python ark.py x64.release EcmaVm_001_TestAction
+    ```
+
+    - 编译 运行于x64（linux_x64）平台的 release模式的 默认指定的 目标产物，同时运行 目标产物中的可执行文件，进行 【默认（全部）的】 262测试（暂限host平台）。
+    ```shell
+    python ark.py x64.release test262
+    ```
+
+    - 编译 运行于x64（linux_x64）平台的 release模式的 默认指定的 目标产物，同时运行 目标产物中的可执行文件，进行 【指定目录的】 262测试（暂限host平台）。
+    ```shell
+    python ark.py x64.release test262 built-ins/Array
+    ```
+
+    - 编译 运行于x64（linux_x64）平台的 release模式的 默认指定的 目标产物，同时运行 目标产物中的可执行文件，进行 【指定文件的】 262测试（暂限host平台）。
+    ```shell
+    python ark.py x64.release test262 built-ins/Array/name.js
+    ```
-- 
Gitee