# 脚本使用指南

## build.sh

ACLSHMEM自动编译脚本，会自动完成依赖库的下载、工程编译&打包、UT用例编译。

* **使用方式：**

```bash
bash build.sh --args
```

* **参数：**

  * --package
    * 生成run包ACLSHMEM\_{version}\_linux-{arch}.run，生成路径为{project_root}/package/{arch}/
  * --python_extension
    * 生成python whl包aclshmem-xxx.whl，生成路径为{project_root}/src/python/dist/
  * --uttests
    * UT用例编译&执行

  * --gen_doc
    * 在{project_root}/docs路径下生成markdown接口文档
  * --onlygendoc
    * 自动下载文档生成依赖的库

  * --gtest_path
    * 指定google test路径
  * --examples
    * 编译选项启用示例代码的构建
  * --enable_ascendc_dump
    * 编译选项启用AscendC调试信息输出的功能

* **使用示例：**

  生成run包和whl包：

  ```bash
  bash build.sh --package --python_extension
  ```

  执行UT用例：

  ```bash
  bash build.sh --uttests
  ```

## set_env.sh

环境变量设置脚本。

* **使用方式：**

  ```bash
  bash set_env.sh
  ```

## install.sh

打包生成的run包安装卸载依赖的脚本，提供安装卸载功能（供run包调用，无需单独使用）。

## uninstall.sh

卸载脚本，可以卸载对应路径安装的aclshmem库（供run包调用，无需单独使用）。